com.smartsheet.api

Interface SheetAutomationRuleResources

public interface SheetAutomationRuleResources

Method Summary

Modifier and Type	Method and Description
void	deleteAutomationRule(long sheetId, long automationRuleId) Delete an automation rule.
AutomationRule	getAutomationRule(long sheetId, long automationRuleId) Get a automation rule.
PagedResult<AutomationRule>	listAutomationRules(long sheetId, PaginationParameters pagination) Get all automation rules for this sheet
AutomationRule	updateAutomationRule(long sheetId, AutomationRule automationRule) Updates an automation rule.

Method Detail

listAutomationRules

PagedResult<AutomationRule> listAutomationRules(long sheetId,
                                                PaginationParameters pagination)
                                         throws SmartsheetException

Get all automation rules for this sheet

It mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/automationrules

Exceptions: IllegalArgumentException : if any argument is null InvalidRequestException : if there is any problem with the REST API request AuthorizationException : if there is any problem with the REST API authorization(access token) ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation

Parameters:

sheetId - the sheet ID

pagination - the pagination parameters

Returns:

a list of automation rules

Throws:

SmartsheetException - the smartsheet exception

getAutomationRule

AutomationRule getAutomationRule(long sheetId,
                                 long automationRuleId)
                          throws SmartsheetException

Get a automation rule.

It mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/automationrules/{automationRuleId}

Parameters:

sheetId - the sheet id

automationRuleId - the automation rule id

Returns:

the automation rule (note that if there is no such resource, this method will throw ResourceNotFoundException rather than returning null).

Throws:

IllegalArgumentException - if any argument is null or empty string

InvalidRequestException - if there is any problem with the REST API request

AuthorizationException - if there is any problem with the REST API authorization (access token)

ResourceNotFoundException - if the resource cannot be found

ServiceUnavailableException - if the REST API service is not available (possibly due to rate limiting)

SmartsheetException - if there is any other error during the operation

updateAutomationRule

AutomationRule updateAutomationRule(long sheetId,
                                    AutomationRule automationRule)
                             throws SmartsheetException

Updates an automation rule.

It mirrors to the following Smartsheet REST API method: PUT /sheets/{sheetId}/automationrules/{automationRuleId}

Parameters:

sheetId - the sheet id

automationRule - the updated automation rule

Returns:

the automation rule (note that if there is no such resource, this method will throw ResourceNotFoundException rather than returning null).

Throws:

IllegalArgumentException - if any argument is null or empty string

InvalidRequestException - if there is any problem with the REST API request

AuthorizationException - if there is any problem with the REST API authorization (access token)

ResourceNotFoundException - if the resource cannot be found

ServiceUnavailableException - if the REST API service is not available (possibly due to rate limiting)

SmartsheetException - if there is any other error during the operation

deleteAutomationRule

void deleteAutomationRule(long sheetId,
                          long automationRuleId)
                   throws SmartsheetException

Delete an automation rule.

It mirrors to the following Smartsheet REST API method: DELETE /sheets/{sheetId}/automationrules/{automationRuleId}

Exceptions: IllegalArgumentException : if any argument is null InvalidRequestException : if there is any problem with the REST API request AuthorizationException : if there is any problem with the REST API authorization(access token) ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation

Parameters:

sheetId - the sheet ID

automationRuleId - the automation rule ID

Throws:

SmartsheetException - the smartsheet exception