Interface SheetFilterResources
- Namespace
- Smartsheet.Api
- Assembly
- smartsheet-csharp-sdk.dll
This interface provides methods to access sheet filter resources.
Thread Safety: Implementation of this interface must be thread safe.
public interface SheetFilterResourcesMethods
DeleteFilter(long, long)
Deletes a filter.
Mirrors to the following Smartsheet REST API method: DELETE /sheets/{sheetId}/filters/{filterId}
void DeleteFilter(long sheetId, long filterId)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
GetFilter(long, long)
Gets a filter.
Mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/filters/{filterId}
SheetFilter GetFilter(long sheetId, long filterId)Parameters
Returns
- SheetFilter
the sheet filter (note that if there is no such resource, this method will throw ResourceNotFoundException rather than returning null).
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
ListFilters(long, PaginationParameters?)
Gets the list of all sheet filters.
Mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/filters
PaginatedResult<SheetFilter> ListFilters(long sheetId, PaginationParameters? paging = null)Parameters
sheetIdlongthe sheet Id
pagingPaginationParametersthe pagination
Returns
- PaginatedResult<SheetFilter>
A list of all sheet filters (note that an empty list will be returned if there are none)
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