com.smartsheet.api

Interface RowAttachmentResources

public interface RowAttachmentResources

This interface provides methods to access RowAttachment resources.

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

Method Summary

Modifier and Type	Method and Description
Attachment	attachFile(long sheetId, long rowId, File file, String contentType) Attach a file to a row with simple upload.
Attachment	attachUrl(long sheetId, long rowId, Attachment attachment) Attach a URL to a comment.
PagedResult<Attachment>	getAttachments(long sheetId, long rowId, PaginationParameters parameters) Get row attachment.

Method Detail

attachUrl

Attachment attachUrl(long sheetId,
                     long rowId,
                     Attachment attachment)
              throws SmartsheetException

Attach a URL to a comment.

The URL can be a normal URL (attachmentType "URL"), a Google Drive URL (attachmentType "GOOGLE_DRIVE") or a Box.com URL (attachmentType "BOX_COM").

It mirrors to the following Smartsheet REST API method:

POST /sheets/{sheetId}/rows/{rowId}/attachments

Parameters:

sheetId - the sheet id

rowId - the row id

attachment - the attachment object

Returns:

the created attachment

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

getAttachments

PagedResult<Attachment> getAttachments(long sheetId,
                                       long rowId,
                                       PaginationParameters parameters)
                                throws SmartsheetException

Get row attachment. It mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/rows/{rowId}/attachments Returns: the resource (note that if there is no such resource, this method will throw ResourceNotFoundException rather than returning null). 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

parameters - the pagination parameters

Returns:

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

Throws:

SmartsheetException - the smartsheet exception

attachFile

Attachment attachFile(long sheetId,
                      long rowId,
                      File file,
                      String contentType)
               throws FileNotFoundException,
                      SmartsheetException

Attach a file to a row with simple upload.

It mirrors to the following Smartsheet REST API method:

POST /sheets/{sheetId}/rows/{rowId}/attachments

Parameters:

sheetId - the id of the sheet

rowId - the id of the comment

file - the file to attach

contentType - the content type of the file

Returns:

the created attachment

Throws:

FileNotFoundException - the file not found exception

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