Interface SheetUpdateRequestResources

Namespace: Smartsheet.Api

Assembly: smartsheet-csharp-sdk.dll

Interface used to encapsulate sheet update request resources.

public interface SheetUpdateRequestResources

Methods

CreateUpdateRequest(long, UpdateRequest)

Creates an Update Request for the specified Row(s) within the Sheet. An email notification (containing a link to the update request) will be asynchronously sent to the specified recipient(s).

It mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/updaterequests

UpdateRequest CreateUpdateRequest(long sheetId, UpdateRequest updateRequest)

Parameters

sheetId long: the sheetId
updateRequest UpdateRequest: the UpdateRequest object

Returns

UpdateRequest

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

DeleteSentUpdateRequest(long, long)

Deletes the specified sent update request.

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

void DeleteSentUpdateRequest(long sheetId, long sentUpdateRequestId)

Parameters

sheetId long: the Id of the sheet
sentUpdateRequestId long: the sent update request Id

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

DeleteUpdateRequest(long, long)

Terminates the future scheduled delivery of the Update Request specified in the URL.

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

void DeleteUpdateRequest(long sheetId, long updateRequestId)

Parameters

sheetId long: the sheetId
updateRequestId long: the updateRequestId

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

GetSentUpdateRequest(long, long)

Gets the specified sent update request on the Sheet.

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

SentUpdateRequest GetSentUpdateRequest(long sheetId, long sentUpdateRequestId)

Parameters

sheetId long: the Id of the sheet
sentUpdateRequestId long: the sent update request Id

Returns

SentUpdateRequest: the sent update request resource (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 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

GetUpdateRequest(long, long)

Gets the specified Update Request for the Sheet that has a future schedule.

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

UpdateRequest GetUpdateRequest(long sheetId, long updateRequestId)

Parameters

sheetId long: the Id of the sheet
updateRequestId long: the update request Id

Returns

UpdateRequest: the update request resource (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 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

ListSentUpdateRequests(long, PaginationParameters?)

Gets a list of all Sent Update Requests that have future schedules associated with the specified Sheet.

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

PaginatedResult<SentUpdateRequest> ListSentUpdateRequests(long sheetId, PaginationParameters? paging = null)

Parameters

sheetId long: the Id of the sheet
paging PaginationParameters: paging parameters for the list

Returns

PaginatedResult<SentUpdateRequest>: A list of all SentUpdateRequests (note that an empty list will be returned if there are none).

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

ListUpdateRequests(long, PaginationParameters?)

Gets a list of all Update Requests that have future schedules associated with the specified Sheet.

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

PaginatedResult<UpdateRequest> ListUpdateRequests(long sheetId, PaginationParameters? paging = null)

Parameters

sheetId long
paging PaginationParameters

Returns

PaginatedResult<UpdateRequest>: A list of all UpdateRequests (note that an empty list will be returned if there are none).

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

UpdateUpdateRequest(long, UpdateRequest)

Changes the specified Update Request for the Sheet.

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

UpdateRequest UpdateUpdateRequest(long sheetId, UpdateRequest updateRequest)

Parameters

sheetId long: the sheet Id
updateRequest UpdateRequest: the UpdateRequest to update

Returns

UpdateRequest: the updated updateRequest

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

Table of Contents

Interface SheetUpdateRequestResources

Methods

CreateUpdateRequest(long, UpdateRequest)

Parameters

Returns

Exceptions

DeleteSentUpdateRequest(long, long)

Parameters

Exceptions

DeleteUpdateRequest(long, long)

Parameters

Exceptions

GetSentUpdateRequest(long, long)

Parameters

Returns

Exceptions

GetUpdateRequest(long, long)

Parameters

Returns

Exceptions

ListSentUpdateRequests(long, PaginationParameters?)

Parameters

Returns

Exceptions

ListUpdateRequests(long, PaginationParameters?)

Parameters

Returns

Exceptions

UpdateUpdateRequest(long, UpdateRequest)

Parameters

Returns

Exceptions