com.smartsheet.api

Interface SheetResources

public interface SheetResources

This interface provides methods to access Sheet resources.

Thread Safety: Implementation of this interface must be thread safe.

Method Summary

Modifier and Type	Method and Description
SheetAttachmentResources	attachmentResources() Return the AttachmentResources object that provides access to attachment resources associated with Sheet resources.
SheetColumnResources	columnResources() Return the SheetColumnResources object that provides access to Column resources associated with Sheet resources.
SheetCommentResources	commentResources() Return the SheetCommentResources object that provides access to discussion resources associated with Sheet resources.
Sheet	copySheet(long sheetId, ContainerDestination containerDestination, EnumSet<SheetCopyInclusion> includes) Creates a copy of the specified sheet.
Sheet	createSheet(Sheet sheet) Create a sheet in default "Sheets" collection.
Sheet	createSheetFromTemplate(Sheet sheet, EnumSet<SheetTemplateInclusion> includes) Create a sheet (from existing sheet or template) in default "Sheets" collection.
Sheet	createSheetInFolder(long folderId, Sheet sheet) Create a sheet in given folder.
Sheet	createSheetInFolderFromTemplate(long folderID, Sheet sheet, EnumSet<SheetTemplateInclusion> includes) Create a sheet (from existing sheet or template) in given folder.
Sheet	createSheetInWorkspace(long workspaceId, Sheet sheet) Create a sheet in given workspace.
Sheet	createSheetInWorkspaceFromTemplate(long workspaceId, Sheet sheet, EnumSet<SheetTemplateInclusion> includes) Create a sheet (from existing sheet or template) in given workspace.
UpdateRequest	createUpdateRequest(long sheetId, MultiRowEmail email) Deprecated.
void	deleteSheet(long id) Delete a sheet.
SheetDiscussionResources	discussionResources() Return the SheetDiscussionResources object that provides access to discussion resources associated with Sheet resources.
SheetPublish	getPublishStatus(long id) Get the status of the Publish settings of the sheet, including the URLs of any enabled publishings.
Sheet	getSheet(long id, EnumSet<SheetInclusion> includes, EnumSet<ObjectExclusion> excludes, Set<Long> rowIds, Set<Integer> rowNumbers, Set<Long> columnIds, Integer pageSize, Integer page) Get a sheet.
void	getSheetAsCSV(long id, OutputStream outputStream) Get a sheet as an Excel file.
void	getSheetAsExcel(long id, OutputStream outputStream) Get a sheet as an Excel file.
void	getSheetAsPDF(long id, OutputStream outputStream, PaperSize paperSize) Get a sheet as a PDF file.
int	getSheetVersion(long id) Get a sheet version.
PagedResult<Sheet>	listOrganizationSheets(PaginationParameters parameters) Deprecated.
PagedResult<Sheet>	listSheets(EnumSet<SourceInclusion> includes, PaginationParameters pagination) Deprecated.
PagedResult<Sheet>	listSheets(EnumSet<SourceInclusion> includes, PaginationParameters pagination, Date modifiedSince) List all sheets.
Sheet	moveSheet(long sheetId, ContainerDestination containerDestination) Moves the specified Sheet to another location.
SheetRowResources	rowResources() Return the SheetRowResources object that provides access to Row resources associated with Sheet resources.
void	sendSheet(long id, SheetEmail email) Send a sheet as a PDF attachment via email to the designated recipients.
ShareResources	shareResources() Return the ShareResources object that provides access to Share resources associated with Sheet resources.
SheetPublish	updatePublishStatus(long id, SheetPublish publish) Sets the publish status of a sheet and returns the new status, including the URLs of any enabled publishings.
SheetUpdateRequestResources	updateRequestResources() Return the SheetUpdateRequestResources object that provides access to update request resources associated with Sheet resources.
Sheet	updateSheet(Sheet sheet) Update a sheet.

Method Detail

listSheets

PagedResult<Sheet> listSheets(EnumSet<SourceInclusion> includes,
                              PaginationParameters pagination,
                              Date modifiedSince)
                       throws SmartsheetException

List all sheets.

It mirrors to the following Smartsheet REST API method: GET /sheets

Parameters:

includes - the source inclusion

pagination - the object containing the pagination parameters

modifiedSince - restrict results to sheets modified on or after this date

Returns:

A list of all sheets (note that an empty list will be returned if there are none).

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

listSheets

@Deprecated
PagedResult<Sheet> listSheets(EnumSet<SourceInclusion> includes,
                                          PaginationParameters pagination)
                                   throws SmartsheetException

Deprecated.

List all sheets.

It mirrors to the following Smartsheet REST API method: GET /sheets

Parameters:

includes - the source inclusion

pagination - the object containing the pagination parameters

Returns:

A list of all sheets (note that an empty list will be returned if there are none).

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

listOrganizationSheets

@Deprecated
PagedResult<Sheet> listOrganizationSheets(PaginationParameters parameters)
                                               throws SmartsheetException

Deprecated.

List all sheets in the organization.

It mirrors to the following Smartsheet REST API method: GET /users/sheets

Parameters:

parameters - the object containing the pagination parameters

Returns:

the list of all sheets (note that an empty list will be returned if there are none)

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

getSheet

Sheet getSheet(long id,
               EnumSet<SheetInclusion> includes,
               EnumSet<ObjectExclusion> excludes,
               Set<Long> rowIds,
               Set<Integer> rowNumbers,
               Set<Long> columnIds,
               Integer pageSize,
               Integer page)
        throws SmartsheetException

Get a sheet.

It mirrors to the following Smartsheet REST API method: GET /sheet/{id}

Parameters:

id - the id of the sheet

includes - used to specify the optional objects to include.

columnIds - the column ids

excludes - the exclude parameters

page - the page number

pageSize - the page size

rowIds - the row ids

rowNumbers - the row numbers

Returns:

the sheet resource (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

getSheetAsExcel

void getSheetAsExcel(long id,
                     OutputStream outputStream)
              throws SmartsheetException

Get a sheet as an Excel file.

It mirrors to the following Smartsheet REST API method:

GET /sheet/{id} with "application/vnd.ms-excel" Accept HTTP header

Parameters:

id - the id of the sheet

outputStream - the output stream to which the Excel file will be written.

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

getSheetAsCSV

void getSheetAsCSV(long id,
                   OutputStream outputStream)
            throws SmartsheetException

Get a sheet as an Excel file.

It mirrors to the following Smartsheet REST API method:

GET /sheet/{id} with "application/vnd.ms-excel" Accept HTTP header

Parameters:

id - the id of the sheet

outputStream - the output stream to which the Excel file will be written.

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

getSheetAsPDF

void getSheetAsPDF(long id,
                   OutputStream outputStream,
                   PaperSize paperSize)
            throws SmartsheetException

Get a sheet as a PDF file.

It mirrors to the following Smartsheet REST API method:

GET /sheet/{id} with "application/pdf" Accept HTTP header

Parameters:

id - the id of the sheet

outputStream - the output stream to which the PDF file will be written.

paperSize - the paper size

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

createSheet

Sheet createSheet(Sheet sheet)
           throws SmartsheetException

Create a sheet in default "Sheets" collection.

It mirrors to the following Smartsheet REST API method:

POST /sheets

Parameters:

sheet - the sheet to created

Returns:

the created sheet

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

createSheetFromTemplate

Sheet createSheetFromTemplate(Sheet sheet,
                              EnumSet<SheetTemplateInclusion> includes)
                       throws SmartsheetException

Create a sheet (from existing sheet or template) in default "Sheets" collection.

It mirrors to the following Smartsheet REST API method: POST /sheets

Parameters:

sheet - the sheet to create

includes - used to specify the optional objects to include.

Returns:

the created sheet

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

createSheetInFolder

Sheet createSheetInFolder(long folderId,
                          Sheet sheet)
                   throws SmartsheetException

Create a sheet in given folder.

It mirrors to the following Smartsheet REST API method: POST /folders/{folderId}/sheets

Parameters:

folderId - the folder id

sheet - the sheet to create

Returns:

the created sheet

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

createSheetInFolderFromTemplate

Sheet createSheetInFolderFromTemplate(long folderID,
                                      Sheet sheet,
                                      EnumSet<SheetTemplateInclusion> includes)
                               throws SmartsheetException

Create a sheet (from existing sheet or template) in given folder.

It mirrors to the following Smartsheet REST API method: POST /folders/{folderId}/sheets

Parameters:

folderID - the folder id

sheet - the sheet to create

includes - used to specify the optional objects to include.

Returns:

the created sheet

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

createSheetInWorkspace

Sheet createSheetInWorkspace(long workspaceId,
                             Sheet sheet)
                      throws SmartsheetException

Create a sheet in given workspace.

It mirrors to the following Smartsheet REST API method: POST /workspace/{workspaceId}/sheets

Parameters:

workspaceId - the workspace id

sheet - the sheet to create

Returns:

the created sheet

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

createSheetInWorkspaceFromTemplate

Sheet createSheetInWorkspaceFromTemplate(long workspaceId,
                                         Sheet sheet,
                                         EnumSet<SheetTemplateInclusion> includes)
                                  throws SmartsheetException

Create a sheet (from existing sheet or template) in given workspace.

It mirrors to the following Smartsheet REST API method: POST /workspaces/{workspaceId}/sheets

Parameters:

workspaceId - the workspace id

sheet - the sheet to create

includes - used to specify the optional objects to include

Returns:

the created sheet

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

deleteSheet

void deleteSheet(long id)
          throws SmartsheetException

Delete a sheet.

It mirrors to the following Smartsheet REST API method: DELETE /sheet{id}

Parameters: - id : the ID of the sheet Returns: None

Parameters:

id - the id

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

updateSheet

Sheet updateSheet(Sheet sheet)
           throws SmartsheetException

Update a sheet.

It mirrors to the following Smartsheet REST API method: PUT /sheet/{id}

Parameters:

sheet - the sheet to update

Returns:

the updated sheet

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

getSheetVersion

int getSheetVersion(long id)
             throws SmartsheetException

Get a sheet version.

It mirrors to the following Smartsheet REST API method: GET /sheet/{id}/version

Parameters:

id - the id

Returns:

the sheet version (note that if there is no such resource, this method will throw ResourceNotFoundException)

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

sendSheet

void sendSheet(long id,
               SheetEmail email)
        throws SmartsheetException

Send a sheet as a PDF attachment via email to the designated recipients.

It mirrors to the following Smartsheet REST API method: POST /sheet/{sheetId}/emails

Parameters:

id - the id

email - the email

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

shareResources

ShareResources shareResources()

Return the ShareResources object that provides access to Share resources associated with Sheet resources.

Returns:

the share resources object

rowResources

SheetRowResources rowResources()

Return the SheetRowResources object that provides access to Row resources associated with Sheet resources.

Returns:

the sheet row resources

columnResources

SheetColumnResources columnResources()

Return the SheetColumnResources object that provides access to Column resources associated with Sheet resources.

Returns:

the sheet column resources

attachmentResources

SheetAttachmentResources attachmentResources()

Return the AttachmentResources object that provides access to attachment resources associated with Sheet resources.

Returns:

the associated attachment resources

discussionResources

SheetDiscussionResources discussionResources()

Return the SheetDiscussionResources object that provides access to discussion resources associated with Sheet resources.

Returns:

the associated discussion resources

commentResources

SheetCommentResources commentResources()

Return the SheetCommentResources object that provides access to discussion resources associated with Sheet resources.

Returns:

the associated comment resources

updateRequestResources

SheetUpdateRequestResources updateRequestResources()

Return the SheetUpdateRequestResources object that provides access to update request resources associated with Sheet resources.

Returns:

the associated update request resources

getPublishStatus

SheetPublish getPublishStatus(long id)
                       throws SmartsheetException

Get the status of the Publish settings of the sheet, including the URLs of any enabled publishings.

It mirrors to the following Smartsheet REST API method: GET /sheet/{sheetId}/publish

Parameters:

id - the id

Returns:

the publish status (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

updatePublishStatus

SheetPublish updatePublishStatus(long id,
                                 SheetPublish publish)
                          throws SmartsheetException

Sets the publish status of a sheet and returns the new status, including the URLs of any enabled publishings.

It mirrors to the following Smartsheet REST API method: PUT /sheet/{sheetId}/publish

Parameters:

id - the id

publish - the SheetPublish object limited.

Returns:

the update SheetPublish object (note that if there is no such resource, this method will throw a 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

copySheet

Sheet copySheet(long sheetId,
                ContainerDestination containerDestination,
                EnumSet<SheetCopyInclusion> includes)
         throws SmartsheetException

Creates a copy of the specified sheet. It mirrors to the following Smartsheet REST API method: POST /folders/{folderId}/copy Exceptions: IllegalArgumentException : if folder 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 sheet id

containerDestination - describes the destination container

includes - optional parameters to include

Returns:

the sheet

Throws:

SmartsheetException - the smartsheet exception

moveSheet

Sheet moveSheet(long sheetId,
                ContainerDestination containerDestination)
         throws SmartsheetException

Moves the specified Sheet to another location. It mirrors to the following Smartsheet REST API method: POST /folders/{folderId}/move Exceptions: IllegalArgumentException : if folder 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 folder id

containerDestination - describes the destination container

Returns:

the sheet

Throws:

SmartsheetException - the smartsheet exception

createUpdateRequest

@Deprecated
UpdateRequest createUpdateRequest(long sheetId,
                                              MultiRowEmail email)
                                       throws SmartsheetException

Deprecated.

Creates an Update Request for the specified Row(s) within the Sheet. It mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/updaterequests 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 sheet id

email - the email

Returns:

the update request object

Throws:

SmartsheetException - the smartsheet exception