Interface SheetAutomationRuleResources
- Namespace
- Smartsheet.Api
- Assembly
- smartsheet-csharp-sdk.dll
This interface provides methods to access AutomationRule resources that are associated to a sheet object.
Thread Safety: Implementation of this interface must be thread safe.
public interface SheetAutomationRuleResourcesMethods
DeleteAutomationRule(long, long)
Deletes an automation rule for this sheet.
Mirrors to the following Smartsheet REST API method: DELETE /sheets/{sheetId}/automationrules/{automationRuleId}
void DeleteAutomationRule(long sheetId, long automationRuleId)Parameters
Exceptions
- InvalidOperationException
if any argument is null or an 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
GetAutomationRule(long, long)
Gets an automation rule for this sheet.
Mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/automationrules/{automationRuleId}
AutomationRule GetAutomationRule(long sheetId, long automationRuleId)Parameters
Returns
- AutomationRule
the automation rule
Exceptions
- InvalidOperationException
if any argument is null or an 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
ListAutomationRules(long, PaginationParameters?)
Gets all automation rules for this sheet.
Mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/automationrules
PaginatedResult<AutomationRule> ListAutomationRules(long sheetId, PaginationParameters? paging = null)Parameters
sheetIdlongthe Id of the sheet
pagingPaginationParametersthe pagination parameters
Returns
- PaginatedResult<AutomationRule>
a list of automation rules
Exceptions
- InvalidOperationException
if any argument is null or an 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(long, AutomationRule)
Updates an automation rule for this sheet.
Mirrors to the following Smartsheet REST API method: PUT /sheets/{sheetId}/automationrules/{automationRuleId}
AutomationRule UpdateAutomationRule(long sheetId, AutomationRule automationRule)Parameters
sheetIdlongthe Id of the sheet
automationRuleAutomationRulethe automation rule
Returns
- AutomationRule
the automation rule
Exceptions
- InvalidOperationException
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