Click or drag to resize

ReportResourcesGetReport Method (Int64, IEnumerableReportInclusion, NullableInt32, NullableInt32, NullableInt32)

Gets the Report, including one page of Rows, and optionally populated with Discussions, Attachments, and source Sheets.

It mirrors to the following Smartsheet REST API method: GET /reports/{reportId}

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
Report GetReport(
	long reportId,
	IEnumerable<ReportInclusion> include,
	Nullable<int> pageSize,
	Nullable<int> page,
	Nullable<int> level
)

Parameters

reportId
Type: SystemInt64
the Id of the report
include
Type: System.Collections.GenericIEnumerableReportInclusion
used to specify the optional objects to include.
pageSize
Type: SystemNullableInt32
(optional): Number of rows per page. If not specified, the default value is 100. This operation can return a maximum of 500 rows per page.
page
Type: SystemNullableInt32
(optional): Which page number (1-based) to return. If not specified, the default value is 1. If a page number is specified that is greater than the number of total pages, the last page will be returned.
level
Type: SystemNullableInt32
(optional): compatiblity level

Return Value

Type: Report
the report 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 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
Remarks
This method returns the top 100 rows. To get more or less rows please use the other overloaded versions of this method
See Also