SheetSummaryResourcesGetSheetSummary Method

Gets the sheet summary

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

Namespace: Smartsheet.Api
Assemblies: smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0

Syntax

C++

Copy

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

Function GetSheetSummary ( 
	sheetId As Long,
	include As IEnumerable(Of SummaryFieldInclusion),
	exclude As IEnumerable(Of SummaryFieldExclusion)
) As SheetSummary

SheetSummary^ GetSheetSummary(
	long long sheetId, 
	IEnumerable<SummaryFieldInclusion>^ include, 
	IEnumerable<SummaryFieldExclusion>^ exclude
)

abstract GetSheetSummary : 
        sheetId : int64 * 
        include : IEnumerable<SummaryFieldInclusion> * 
        exclude : IEnumerable<SummaryFieldExclusion> -> SheetSummary

Parameters

sheetId: Type: SystemInt64
the sheet Id
include: Type: System.Collections.GenericIEnumerableSummaryFieldInclusion
optional objects to include
exclude: Type: System.Collections.GenericIEnumerableSummaryFieldExclusion
optional object to exclude

Return Value

Type: SheetSummary
the sheet summary

Exceptions

Exception	Condition
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

Reference

SheetSummaryResources Interface

Smartsheet.Api Namespace

SheetSummaryResourcesAddLanguageSpecificTextSet("LST2B01B528_0?cpp=::|nu=.");GetSheetSummary Method

Parameters

Return Value

Reference

SheetSummaryResourcesGetSheetSummary Method