Interface SheetCrossSheetReferenceResources
- Namespace
- Smartsheet.Api
- Assembly
- smartsheet-csharp-sdk.dll
Interface used to encapsulate sheet cross sheet reference resources.
public interface SheetCrossSheetReferenceResources
Methods
CreateCrossSheetReference(long, CrossSheetReference)
Creates a cross-sheet reference in the given sheet.
Mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/crosssheetreferences
CrossSheetReference CreateCrossSheetReference(long sheetId, CrossSheetReference crossSheetReference)
Parameters
sheetId
longthe Id of the sheet
crossSheetReference
CrossSheetReferencethe cross-sheet reference
Returns
- CrossSheetReference
the cross-sheet reference
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
GetCrossSheetReference(long, long)
Gets a cross-sheet reference for this sheet.
Mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/crosssheetreferences/{crosssheetreferenceId}
CrossSheetReference GetCrossSheetReference(long sheetId, long crossSheetReferenceId)
Parameters
Returns
- CrossSheetReference
the cross-sheet reference
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
ListCrossSheetReferences(long, PaginationParameters?)
Gets all cross-sheet references for this sheet.
Mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/crosssheetreferences
PaginatedResult<CrossSheetReference> ListCrossSheetReferences(long sheetId, PaginationParameters? paging = null)
Parameters
sheetId
longthe Id of the sheet
paging
PaginationParametersthe pagination parameters
Returns
- PaginatedResult<CrossSheetReference>
a list of cross-sheet references
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