Package com.smartsheet.api

Interface SheetSummaryResources

public interface SheetSummaryResources

Method Summary

Modifier and Type	Method	Description
Result<SummaryField>	addSheetSummaryFieldImage(long sheetId, long fieldId, java.io.File file, java.lang.String contentType, java.lang.String altText)	Adds an image to the sheet summary field.
Result<SummaryField>	addSheetSummaryFieldImage(long sheetId, long fieldId, java.io.InputStream inputStream, java.lang.String contentType, long contentLength, java.lang.String altText)	Adds an image to the sheet summary field.
Result<SummaryField>	addSheetSummaryFieldImage(long sheetId, long fieldId, java.lang.String file, java.lang.String contentType, java.lang.String altText)	Adds an image to the sheet summary field.
java.util.List<SummaryField>	addSheetSummaryFields(long sheetId, java.util.List<SummaryField> fields, java.lang.Boolean renameIfConflict)	Insert fields into a sheet summary.
BulkItemResult<SummaryField>	addSheetSummaryFieldsWithPartialSuccess(long sheetId, java.util.List<SummaryField> fields, java.lang.Boolean renameIfConflict)	Insert fields into a sheet summary.
java.util.List<java.lang.Long>	deleteSheetSummaryFields(long sheetId, java.util.Set<java.lang.Long> fieldIds, java.lang.Boolean ignoreSummaryFieldsNotFound)	Delete fields in a sheet summary.
SheetSummary	getSheetSummary(long sheetId, java.util.EnumSet<SummaryFieldInclusion> includes, java.util.EnumSet<SummaryFieldExclusion> excludes)	Gets the sheet summary
PagedResult<SummaryField>	getSheetSummaryFields(long sheetId, java.util.EnumSet<SummaryFieldInclusion> includes, java.util.EnumSet<SummaryFieldExclusion> excludes, PaginationParameters pagination)	Gets the sheet summary fields
java.util.List<SummaryField>	updateSheetSummaryFields(long sheetId, java.util.List<SummaryField> fields, java.lang.Boolean renameIfConflict)	Update fields in a sheet summary.
BulkItemResult<SummaryField>	updateSheetSummaryFieldsWithPartialSuccess(long sheetId, java.util.List<SummaryField> fields, java.lang.Boolean renameIfConflict)	Update fields in a sheet summary.

Method Detail

getSheetSummary

SheetSummary getSheetSummary(long sheetId,
                             java.util.EnumSet<SummaryFieldInclusion> includes,
                             java.util.EnumSet<SummaryFieldExclusion> excludes)
                      throws SmartsheetException

Gets the sheet summary

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

Parameters:

sheetId - the sheet id

includes - optional objects to include

excludes - optional objects to exclude

Returns:

the sheet summary

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

getSheetSummaryFields

PagedResult<SummaryField> getSheetSummaryFields(long sheetId,
                                                java.util.EnumSet<SummaryFieldInclusion> includes,
                                                java.util.EnumSet<SummaryFieldExclusion> excludes,
                                                PaginationParameters pagination)
                                         throws SmartsheetException

Gets the sheet summary fields

It mirrors to the following Smartsheet REST API method: GET /sheets/{id}/summary/fields

Parameters:

sheetId - the sheet id

includes - optional objects to include

excludes - optional objects to exclude

pagination - pagination parameters for the response

Returns:

the list of sheet summary fields

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

addSheetSummaryFields

java.util.List<SummaryField> addSheetSummaryFields(long sheetId,
                                                   java.util.List<SummaryField> fields,
                                                   java.lang.Boolean renameIfConflict)
                                            throws SmartsheetException

Insert fields into a sheet summary.

It mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/summary/fields

Parameters:

sheetId - the sheet id

fields - list of fields to be added

renameIfConflict - true if the call should rename conflicting field titles

Returns:

the created fields

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

addSheetSummaryFieldsWithPartialSuccess

BulkItemResult<SummaryField> addSheetSummaryFieldsWithPartialSuccess(long sheetId,
                                                                     java.util.List<SummaryField> fields,
                                                                     java.lang.Boolean renameIfConflict)
                                                              throws SmartsheetException

Insert fields into a sheet summary.

It mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/summary/fields

Parameters:

sheetId - the sheet id

fields - list of fields to be added

renameIfConflict - true if the call should rename conflicting field titles

Returns:

a bulk item result containing the created fields

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

updateSheetSummaryFields

java.util.List<SummaryField> updateSheetSummaryFields(long sheetId,
                                                      java.util.List<SummaryField> fields,
                                                      java.lang.Boolean renameIfConflict)
                                               throws SmartsheetException

Update fields in a sheet summary.

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

Parameters:

sheetId - the sheet id

fields - list of summary fields to be updated

renameIfConflict - true if the call should rename conflicting field titles

Returns:

the updated fields

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

updateSheetSummaryFieldsWithPartialSuccess

BulkItemResult<SummaryField> updateSheetSummaryFieldsWithPartialSuccess(long sheetId,
                                                                        java.util.List<SummaryField> fields,
                                                                        java.lang.Boolean renameIfConflict)
                                                                 throws SmartsheetException

Update fields in a sheet summary.

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

Parameters:

sheetId - the sheet id

fields - list of summary fields to be updated

renameIfConflict - true if the call should rename conflicting field titles

Returns:

a bulk item result containing the updated fields

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

deleteSheetSummaryFields

java.util.List<java.lang.Long> deleteSheetSummaryFields(long sheetId,
                                                        java.util.Set<java.lang.Long> fieldIds,
                                                        java.lang.Boolean ignoreSummaryFieldsNotFound)
                                                 throws SmartsheetException

Delete fields in a sheet summary.

It mirrors to the following Smartsheet REST API method: DELETE /sheets/{sheetId}/summary/fields

Parameters:

sheetId - the sheet id

fieldIds - List of field Ids

ignoreSummaryFieldsNotFound - true if the call should ignore fields not found

Returns:

List of field Ids deleted

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

addSheetSummaryFieldImage

Result<SummaryField> addSheetSummaryFieldImage(long sheetId,
                                               long fieldId,
                                               java.lang.String file,
                                               java.lang.String contentType,
                                               java.lang.String altText)
                                        throws SmartsheetException,
                                               java.io.FileNotFoundException

Adds an image to the sheet summary field.

It mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/summary/fields/{fieldId}/images

Parameters:

sheetId - the sheet id

fieldId - the summary field id

file - path to image file to upload

contentType - content-type of the file being uploaded

altText - alternate text for the image

Returns:

Result

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

java.io.FileNotFoundException

addSheetSummaryFieldImage

Result<SummaryField> addSheetSummaryFieldImage(long sheetId,
                                               long fieldId,
                                               java.io.File file,
                                               java.lang.String contentType,
                                               java.lang.String altText)
                                        throws SmartsheetException,
                                               java.io.FileNotFoundException

Adds an image to the sheet summary field.

It mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/summary/fields/{fieldId}/images

Parameters:

sheetId - the sheet id

fieldId - the summary field id

file - File to upload

contentType - content-type of the file being uploaded

altText - alternate text for the image

Returns:

Result

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

java.io.FileNotFoundException

addSheetSummaryFieldImage

Result<SummaryField> addSheetSummaryFieldImage(long sheetId,
                                               long fieldId,
                                               java.io.InputStream inputStream,
                                               java.lang.String contentType,
                                               long contentLength,
                                               java.lang.String altText)
                                        throws SmartsheetException,
                                               java.io.FileNotFoundException

Adds an image to the sheet summary field.

It mirrors to the following Smartsheet REST API method: POST /sheets/{sheetId}/summary/fields/{fieldId}/images

Parameters:

sheetId - the sheet id

fieldId - the summary field id

inputStream - File to upload

contentType - content-type of the file being uploaded

contentLength - content length

altText - alternate text for the image

Returns:

Result

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

java.io.FileNotFoundException