com.smartsheet.api

Interface SheetRowResources

public interface SheetRowResources

This interface provides methods to access row resources that are associated to a sheet object. Thread Safety: Implementation of this interface must be thread safe.

Method Summary

Modifier and Type	Method and Description
List<Row>	addRows(long sheetId, List<Row> rows) Insert rows to a sheet.
PartialRowUpdateResult	addRowsAllowPartialSuccess(long sheetId, List<Row> rows) Insert rows to a sheet, allowing partial success.
RowAttachmentResources	attachmentResources() Creates an object of RowAttachmentResources.
RowColumnResources	cellResources() Creates an object of RowColumnResources.
CopyOrMoveRowResult	copyRows(Long sheetId, EnumSet<RowCopyInclusion> includes, Boolean ignoreRowsNotFound, CopyOrMoveRowDirective copyParameters) Copies Row(s) from the Sheet specified in the URL to (the bottom of) another sheet.
void	deleteRow(long sheetId, long rowId) Deprecated. as of API 2.0.2 release, replaced by deleteRows(long, Set, boolean) Delete a row. It mirrors to the following Smartsheet REST API method: DELETE /sheets/{sheetId}/rows/{rowId} Parameters: - id : the ID of the row Returns: None Exceptions: 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 can not be found ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation
List<Long>	deleteRows(long sheetId, Set<Long> rowIds, boolean ignoreRowsNotFound) Deletes one or more row(s) from the Sheet specified in the URL.
RowDiscussionResources	discussionResources() Creates an object of RowDiscussionResources.
Row	getRow(long sheetId, long rowId, EnumSet<RowInclusion> includes, EnumSet<ObjectExclusion> excludes) Get a row.
CopyOrMoveRowResult	moveRows(Long sheetId, EnumSet<RowMoveInclusion> includes, Boolean ignoreRowsNotFound, CopyOrMoveRowDirective moveParameters) Moves Row(s) from the Sheet specified in the URL to (the bottom of) another sheet.
void	sendRow(long sheetId, long rowId, RowEmail email) Deprecated. as of API V2.0.2, replaced by sendRows(long, MultiRowEmail) Send a row via email to the designated recipients. It mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/rows/{rowId}/emails Exceptions: IllegalArgumentException : if any argument is null InvalidRequestException : if there is any problem with the REST API request AuthorizationException : if there is any problem with the REST API authorization(access token) ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation
void	sendRows(long sheetId, MultiRowEmail email) Send a row via email to the designated recipients.
List<Row>	updateRows(long sheetId, List<Row> rows) Update rows.
PartialRowUpdateResult	updateRowsAllowPartialSuccess(long sheetId, List<Row> rows) Update rows, but allow partial success.

Method Detail

addRows

List<Row> addRows(long sheetId,
                  List<Row> rows)
           throws SmartsheetException

Insert rows to a sheet.

It mirrors to the following Smartsheet REST API method: POST /sheets/{id}/rows

Parameters:

sheetId - the sheet id

rows - the list of rows to create

Returns:

the list of created rows

Throws:

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

addRowsAllowPartialSuccess

PartialRowUpdateResult addRowsAllowPartialSuccess(long sheetId,
                                                  List<Row> rows)
                                           throws SmartsheetException

Insert rows to a sheet, allowing partial success. If a row cannot be inserted, it will fail, while the others may succeed..

It mirrors to the following Smartsheet REST API method: POST /sheets/{id}/rows

Parameters:

sheetId - the sheet id

rows - the list of rows to create

Returns:

the list of created rows

Throws:

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

getRow

Row getRow(long sheetId,
           long rowId,
           EnumSet<RowInclusion> includes,
           EnumSet<ObjectExclusion> excludes)
    throws SmartsheetException

Get a row. It mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/rows/{rowId}

Parameters:

sheetId - the id of the sheet

rowId - the id of the row

includes - optional objects to include

excludes - optional objects to exclude

Returns:

the created row (note that if there is no such resource, this method will throw ResourceNotFoundException rather than returning null).

Throws:

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

deleteRow

@Deprecated
void deleteRow(long sheetId,
                           long rowId)
                    throws SmartsheetException

Deprecated. as of API 2.0.2 release, replaced by deleteRows(long, Set, boolean) Delete a row. It mirrors to the following Smartsheet REST API method: DELETE /sheets/{sheetId}/rows/{rowId} Parameters: - id : the ID of the row Returns: None Exceptions: 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 can not be found ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation

Parameters:

sheetId - the sheet id

rowId - the row id

Throws:

SmartsheetException - the smartsheet exception

sendRow

@Deprecated
void sendRow(long sheetId,
                         long rowId,
                         RowEmail email)
                  throws SmartsheetException

Deprecated. as of API V2.0.2, replaced by sendRows(long, MultiRowEmail) Send a row via email to the designated recipients. It mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/rows/{rowId}/emails Exceptions: IllegalArgumentException : if any argument is null InvalidRequestException : if there is any problem with the REST API request AuthorizationException : if there is any problem with the REST API authorization(access token) ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation

Parameters:

sheetId - the id of the sheet

rowId - the id of the row

email - the row email

Throws:

SmartsheetException - the smartsheet exception

sendRows

void sendRows(long sheetId,
              MultiRowEmail email)
       throws SmartsheetException

Send a row via email to the designated recipients. It mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/rows/emails Exceptions: IllegalArgumentException : if any argument is null InvalidRequestException : if there is any problem with the REST API request AuthorizationException : if there is any problem with the REST API authorization(access token) ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation

Parameters:

sheetId - the id of the sheet

email - the multi row email

Throws:

SmartsheetException - the smartsheet exception

deleteRows

List<Long> deleteRows(long sheetId,
                      Set<Long> rowIds,
                      boolean ignoreRowsNotFound)
               throws SmartsheetException

Deletes one or more row(s) from the Sheet specified in the URL. It mirrors to the following Smartsheet REST API method: DELETE /sheets/{sheetId}/rows/{rowId} Parameters: - id : the ID of the row Returns: None Exceptions: 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 can not be found ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation

Parameters:

sheetId - the sheet id

rowIds - the row ids

ignoreRowsNotFound - boolean for ignoring row ids not found

Returns:

a list of deleted rows

Throws:

SmartsheetException - the smartsheet exception

updateRows

List<Row> updateRows(long sheetId,
                     List<Row> rows)
              throws SmartsheetException

Update rows. It mirrors to the following Smartsheet REST API method: PUT /sheets/{sheetId}/rows Exceptions: IllegalArgumentException : if any argument is null InvalidRequestException : if there is any problem with the REST API request AuthorizationException : if there is any problem with the REST API authorization(access token) ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation

Parameters:

sheetId - the id of the sheet

rows - the list of rows

Returns:

a list of rows

Throws:

SmartsheetException - the smartsheet exception

updateRowsAllowPartialSuccess

PartialRowUpdateResult updateRowsAllowPartialSuccess(long sheetId,
                                                     List<Row> rows)
                                              throws SmartsheetException

Update rows, but allow partial success. The PartialRowUpdateResult will contain the successful rows and those that failed, with specific messages for each. It mirrors to the following Smartsheet REST API method: PUT /sheets/{sheetId}/rows Exceptions: IllegalArgumentException : if any argument is null InvalidRequestException : if there is any problem with the REST API request AuthorizationException : if there is any problem with the REST API authorization(access token) ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation

Parameters:

sheetId - the id of the sheet

rows - the list of rows

Returns:

a list of rows

Throws:

SmartsheetException - the smartsheet exception

moveRows

CopyOrMoveRowResult moveRows(Long sheetId,
                             EnumSet<RowMoveInclusion> includes,
                             Boolean ignoreRowsNotFound,
                             CopyOrMoveRowDirective moveParameters)
                      throws SmartsheetException

Moves Row(s) from the Sheet specified in the URL to (the bottom of) another sheet. It mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/rows/move Exceptions: IllegalArgumentException : if any argument is null, or path is 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) ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation

Parameters:

sheetId - the sheet ID to move

includes - the parameters to include

ignoreRowsNotFound - optional,specifying row Ids that do not exist within the source sheet

moveParameters - CopyOrMoveRowDirective object

Returns:

the result object

Throws:

SmartsheetException - the smartsheet exception

copyRows

CopyOrMoveRowResult copyRows(Long sheetId,
                             EnumSet<RowCopyInclusion> includes,
                             Boolean ignoreRowsNotFound,
                             CopyOrMoveRowDirective copyParameters)
                      throws SmartsheetException

Copies Row(s) from the Sheet specified in the URL to (the bottom of) another sheet. It mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/rows/move Exceptions: IllegalArgumentException : if any argument is null, or path is 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) ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation

Parameters:

sheetId - the sheet ID to move

includes - the parameters to include

ignoreRowsNotFound - optional,specifying row Ids that do not exist within the source sheet

copyParameters - CopyOrMoveRowDirective object

Returns:

the result object

Throws:

SmartsheetException - the smartsheet exception

attachmentResources

RowAttachmentResources attachmentResources()

Creates an object of RowAttachmentResources.

Returns:

the created RowAttachmentResources object

discussionResources

RowDiscussionResources discussionResources()

Creates an object of RowDiscussionResources.

Returns:

the created RowDiscussionResources object

cellResources

RowColumnResources cellResources()

Creates an object of RowColumnResources.

Returns:

the created RowColumnResources object