com.smartsheet.api

Interface RowColumnResources

public interface RowColumnResources

This interface provides methods to access row column 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
void	addImageToCell(long sheetId, long rowId, long columnId, String file, String fileType) Uploads an image to the specified cell within a sheet.
void	addImageToCell(long sheetId, long rowId, long columnId, String file, String fileType, boolean overrideValidation, String altText) Uploads an image to the specified cell within a sheet.
PagedResult<CellHistory>	getCellHistory(long sheetId, long rowId, long columnId, PaginationParameters pagination) Get the cell modification history.
PagedResult<CellHistory>	getCellHistory(long sheetId, long rowId, long columnId, PaginationParameters pagination, EnumSet<CellHistoryInclusion> includes, Integer level) Get the cell modification history.

Method Detail

getCellHistory

PagedResult<CellHistory> getCellHistory(long sheetId,
                                        long rowId,
                                        long columnId,
                                        PaginationParameters pagination)
                                 throws SmartsheetException

Get the cell modification history.

It mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/rows/{rowId}/columns/{columnId}/history

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:

rowId - the row id

sheetId - the sheet Id

columnId - the column id

pagination - the pagination parameters

Returns:

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

Throws:

SmartsheetException - the smartsheet exception

getCellHistory

PagedResult<CellHistory> getCellHistory(long sheetId,
                                        long rowId,
                                        long columnId,
                                        PaginationParameters pagination,
                                        EnumSet<CellHistoryInclusion> includes,
                                        Integer level)
                                 throws SmartsheetException

Get the cell modification history.

It mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/rows/{rowId}/columns/{columnId}/history

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:

rowId - the row id

sheetId - the sheet Id

columnId - the column id

pagination - the pagination parameters

includes - cell history inclusion

level - compatbility level

Returns:

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

Throws:

SmartsheetException - the smartsheet exception

addImageToCell

void addImageToCell(long sheetId,
                    long rowId,
                    long columnId,
                    String file,
                    String fileType)
             throws FileNotFoundException,
                    SmartsheetException

Uploads an image to the specified cell within a sheet.

It mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/rows/{rowId}/columns/{columnId}/cellimages

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

columnId - the column id

file - the file path

fileType - ResourceNotFoundException rather than returning null).

Throws:

SmartsheetException - the smartsheet exception

FileNotFoundException - image file not found

addImageToCell

void addImageToCell(long sheetId,
                    long rowId,
                    long columnId,
                    String file,
                    String fileType,
                    boolean overrideValidation,
                    String altText)
             throws FileNotFoundException,
                    SmartsheetException

Uploads an image to the specified cell within a sheet.

It mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/rows/{rowId}/columns/{columnId}/cellimages

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

columnId - the column id

file - the file path

fileType -

overrideValidation - override column type validation ResourceNotFoundException rather than returning null).

Throws:

SmartsheetException - the smartsheet exception

FileNotFoundException - image file not found