Package com.smartsheet.api

Interface SheetUpdateRequestResources

  • public interface SheetUpdateRequestResources

    • Method Detail

      • listUpdateRequests

        PagedResult<UpdateRequest> listUpdateRequests​(long sheetId,
                                              PaginationParameters paging)
                                       throws SmartsheetException

        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

        Parameters:
        sheetId - the Id of the sheet
        paging - the object containing the pagination parameters
        Returns:
        A list of all UpdateRequests (note that an empty list will be returned if there are none).
        Throws:
        java.lang.IllegalArgumentException - 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

        UpdateRequest getUpdateRequest​(long sheetId,
                               long updateRequestId)
                        throws SmartsheetException

        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}

        Parameters:
        sheetId - the Id of the sheet
        updateRequestId - the update request Id
        Returns:
        the update request resource (note that if there is no such resource, this method will throw ResourceNotFoundException rather than returning null).
        Throws:
        java.lang.IllegalArgumentException - 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

      • createUpdateRequest

        UpdateRequest createUpdateRequest​(long sheetId,
                                  UpdateRequest updateRequest)
                           throws SmartsheetException

        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

        Parameters:
        sheetId - the Id of the sheet
        updateRequest - the update request object
        Returns:
        the update request resource.
        Throws:
        java.lang.IllegalArgumentException - 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

        void deleteUpdateRequest​(long sheetId,
                         long updateRequestId)
                  throws SmartsheetException

        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}

        Parameters:
        sheetId - the Id of the sheet
        updateRequestId - the update request Id
        Throws:
        java.lang.IllegalArgumentException - 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

        UpdateRequest updateUpdateRequest​(long sheetId,
                                  UpdateRequest updateRequest)
                           throws SmartsheetException

        Changes the specified Update Request for the Sheet.

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

        Parameters:
        sheetId - the Id of the sheet
        updateRequest - the update request object
        Returns:
        the update request resource.
        Throws:
        java.lang.IllegalArgumentException - 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

        PagedResult<SentUpdateRequest> listSentUpdateRequests​(long sheetId,
                                                      PaginationParameters paging)
                                               throws SmartsheetException

        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

        Parameters:
        sheetId - the Id of the sheet
        paging - the object containing the pagination parameters
        Returns:
        A list of all UpdateRequests (note that an empty list will be returned if there are none).
        Throws:
        java.lang.IllegalArgumentException - 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

        SentUpdateRequest getSentUpdateRequest​(long sheetId,
                                       long sentUpdateRequestId)
                                throws SmartsheetException

        Gets the specified sent update request on the Sheet.

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

        Parameters:
        sheetId - the Id of the sheet
        sentUpdateRequestId - the sent update request Id
        Returns:
        the sent update request resource (note that if there is no such resource, this method will throw ResourceNotFoundException rather than returning null).
        Throws:
        java.lang.IllegalArgumentException - 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

        void deleteSentUpdateRequest​(long sheetId,
                             long sentUpdateRequestId)
                      throws SmartsheetException

        Deletes the specified sent update request.

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

        Parameters:
        sheetId - the Id of the sheet
        sentUpdateRequestId - the sent update request Id
        Throws:
        java.lang.IllegalArgumentException - 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