Click or drag to resize

SheetResourcesGetSheet Method (Int64, IEnumerableSheetLevelInclusion, IEnumerableSheetLevelExclusion, IEnumerableInt64, IEnumerableInt32, IEnumerableInt64, NullableInt64, NullableInt64, NullableInt64)

Gets a sheet.

Mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}

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
Sheet GetSheet(
	long sheetId,
	IEnumerable<SheetLevelInclusion> includes,
	IEnumerable<SheetLevelExclusion> excludes,
	IEnumerable<long> rowIds,
	IEnumerable<int> rowNumbers,
	IEnumerable<long> columnIds,
	Nullable<long> pageSize,
	Nullable<long> page,
	Nullable<long> ifVersionAfter
)

Parameters

sheetId
Type: SystemInt64
the Id of the sheet
includes
Type: System.Collections.GenericIEnumerableSheetLevelInclusion
used to specify the optional objects to include.
excludes
Type: System.Collections.GenericIEnumerableSheetLevelExclusion
used to specify the optional objects to include.
rowIds
Type: System.Collections.GenericIEnumerableInt64
used to specify the optional objects to include.
rowNumbers
Type: System.Collections.GenericIEnumerableInt32
used to specify the optional objects to include.
columnIds
Type: System.Collections.GenericIEnumerableInt64
used to specify the optional objects to include.
pageSize
Type: SystemNullableInt64
used to specify the optional objects to include.
page
Type: SystemNullableInt64
used to specify the optional objects to include.
ifVersionAfter
Type: SystemNullableInt64
only fetch sheet if more recent version available

Return Value

Type: Sheet
the sheet resource (note that if there is no such resource, this method will throw ResourceNotFoundException rather than returning null).
Exceptions
ExceptionCondition
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
See Also