Interface SheetSummaryResources

Namespace

Smartsheet.Api

Assembly

smartsheet-csharp-sdk.dll

This interface provides methods to access sheet summary resources that are associated to a sheet object.

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

public interface SheetSummaryResources

Methods

AddSheetSummaryFieldImage(long, long, string, string?, string?)

Adds an image to the sheet summary field.

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

SummaryField AddSheetSummaryFieldImage(long sheetId, long fieldId, string file, string? fileType = null, string? altText = null)

Parameters

sheetId long

the sheet id

fieldId long

the summary field id

file string

the file path

fileType string

the file type

altText string

image alternate text

Returns

SummaryField

Result

Exceptions

InvalidOperationException

if any argument is null or an 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(long, IEnumerable<SummaryField>, bool?)

Insert fields into a sheet summary

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

IList<SummaryField> AddSheetSummaryFields(long sheetId, IEnumerable<SummaryField> fields, bool? renameIfConflict = null)

Parameters

sheetId long

the sheet Id

fields IEnumerable<SummaryField>

list of fields to be added

renameIfConflict bool?

true if the call should rename conflicting field titles

Returns

IList<SummaryField>

a list of created fields

Exceptions

InvalidOperationException

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

AddSheetSummaryFieldsAllowPartialSuccess(long, IEnumerable<SummaryField>, bool?)

Insert fields into a sheet summary

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

BulkItemResult<SummaryField> AddSheetSummaryFieldsAllowPartialSuccess(long sheetId, IEnumerable<SummaryField> fields, bool? renameIfConflict = null)

Parameters

sheetId long

the sheet Id

fields IEnumerable<SummaryField>

list of fields to be added

renameIfConflict bool?

true if the call should rename conflicting field titles

Returns

BulkItemResult<SummaryField>

a list of created fields

Exceptions

InvalidOperationException

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(long, IEnumerable<long>, bool?)

Delete fields in a sheet summary.

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

IList<long> DeleteSheetSummaryFields(long sheetId, IEnumerable<long> fieldIds, bool? ignoreSummaryFieldsNotFound = null)

Parameters

sheetId long

the sheetId

fieldIds IEnumerable<long>

the field IDs

ignoreSummaryFieldsNotFound bool?

true if the call should ignore fields not found

Returns

IList<long>

List of field Ids deleted.

Exceptions

InvalidOperationException

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

GetSheetSummary(long, IEnumerable<SummaryFieldInclusion>?, IEnumerable<SummaryFieldExclusion>?)

Gets the sheet summary

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

SheetSummary GetSheetSummary(long sheetId, IEnumerable<SummaryFieldInclusion>? include = null, IEnumerable<SummaryFieldExclusion>? exclude = null)

Parameters

sheetId long

the sheet Id

include IEnumerable<SummaryFieldInclusion>

optional objects to include

exclude IEnumerable<SummaryFieldExclusion>

optional object to exclude

Returns

SheetSummary

the sheet summary

Exceptions

InvalidOperationException

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(long, IEnumerable<SummaryFieldInclusion>?, IEnumerable<SummaryFieldExclusion>?, PaginationParameters?)

Gets the sheet summary fields

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

PaginatedResult<SummaryField> GetSheetSummaryFields(long sheetId, IEnumerable<SummaryFieldInclusion>? include = null, IEnumerable<SummaryFieldExclusion>? exclude = null, PaginationParameters? paging = null)

Parameters

sheetId long

the sheet Id

include IEnumerable<SummaryFieldInclusion>

optional objects to include

exclude IEnumerable<SummaryFieldExclusion>

optional object to exclude

paging PaginationParameters

pagination parameters for the response

Returns

PaginatedResult<SummaryField>

the paged list of sheet summary fields

Exceptions

InvalidOperationException

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(long, IEnumerable<SummaryField>, bool?)

Update fields in the sheet summary

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

IList<SummaryField> UpdateSheetSummaryFields(long sheetId, IEnumerable<SummaryField> fields, bool? renameIfConflict = null)

Parameters

sheetId long

the sheet Id

fields IEnumerable<SummaryField>

list of fields to be updated

renameIfConflict bool?

true if the call should rename conflicting field titles

Returns

IList<SummaryField>

a list of updated fields

Exceptions

InvalidOperationException

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

UpdateSheetSummaryFieldsAllowPartialSuccess(long, IEnumerable<SummaryField>, bool?)

Update fields in the sheet summary

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

BulkItemResult<SummaryField> UpdateSheetSummaryFieldsAllowPartialSuccess(long sheetId, IEnumerable<SummaryField> fields, bool? renameIfConflict = null)

Parameters

sheetId long

the sheet Id

fields IEnumerable<SummaryField>

list of fields to be updated

renameIfConflict bool?

true if the call should rename conflicting field titles

Returns

BulkItemResult<SummaryField>

a list of updated fields

Exceptions

InvalidOperationException

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