Interface RowColumnResources
- Namespace
- Smartsheet.Api
- Assembly
- smartsheet-csharp-sdk.dll
This interface provides methods to access cell resources that are associated to a row and column.
Thread Safety: Implementation of this interface must be thread safe.
public interface RowColumnResources
Methods
AddImageToCell(long, long, long, string, string?)
Uploads an image to the specified cell within a sheet.
Mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/rows/{rowId}/columns/{columnId}/cellimages
void AddImageToCell(long sheetId, long rowId, long columnId, string file, string? fileType = null)
Parameters
sheetId
longthe sheet Id
rowId
longthe row Id
columnId
longthe column Id
file
stringthe file path
fileType
stringthe file type
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
AddImageToCell(long, long, long, string, string?, bool?, string?)
Uploads an image to the specified cell within a sheet.
Mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/rows/{rowId}/columns/{columnId}/cellimages
void AddImageToCell(long sheetId, long rowId, long columnId, string file, string? fileType = null, bool? overrideValidation = false, string? altText = null)
Parameters
sheetId
longthe sheet Id
rowId
longthe row Id
columnId
longthe column Id
file
stringthe file path
fileType
stringthe file type
overrideValidation
bool?override column type validation
altText
stringimage alternate text
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
GetCellHistory(long, long, long, IEnumerable<CellInclusion>?, PaginationParameters?)
Gets the cell modification history.
Mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/rows/{rowId}/columns/{columnId}/history
This operation supports pagination of results. For more information, see Paging.
This is a resource-intensive operation and incurs 10 additional requests against the rate limit.
PaginatedResult<CellHistory> GetCellHistory(long sheetId, long rowId, long columnId, IEnumerable<CellInclusion>? include = null, PaginationParameters? paging = null)
Parameters
sheetId
longthe sheet Id
rowId
longthe row Id
columnId
longthe column Id
include
IEnumerable<CellInclusion>the elements to include in the response
paging
PaginationParametersthe pagination
Returns
- PaginatedResult<CellHistory>
the row object
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
GetCellHistory(long, long, long, IEnumerable<CellInclusion>?, PaginationParameters?, int?)
Gets the cell modification history.
Mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/rows/{rowId}/columns/{columnId}/history
This operation supports pagination of results. For more information, see Paging.
This is a resource-intensive operation and incurs 10 additional requests against the rate limit.
PaginatedResult<CellHistory> GetCellHistory(long sheetId, long rowId, long columnId, IEnumerable<CellInclusion>? include = null, PaginationParameters? paging = null, int? level = null)
Parameters
sheetId
longthe sheet Id
rowId
longthe row Id
columnId
longthe column Id
include
IEnumerable<CellInclusion>the elements to include in the response
paging
PaginationParametersthe pagination
level
int?compatibility level
Returns
- PaginatedResult<CellHistory>
the row object
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