SMsmartsheet
reports

Add report scope

Adds source sheets for inclusion in the specified report by specifying individual sheets or their parent workspaces.

Specifying a workspace creates a dynamic scope—-the report automatically includes all sheets in that workspace and updates whenever sheets are added or removed from it.

Note: You can have up to 30,000 source sheets per report.

post/reports/{reportId}/scope

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: READ_SHEETS

Request body

assetType'sheet' | 'workspace' required

The asset's type.

assetIdinteger required

The ID of the asset according to its assetType.

Response

The operation's success level.

message'PARTIAL_SUCCESS' | 'SUCCESS'

Message that indicates the outcome of the request. (One of SUCCESS or PARTIAL_SUCCESS.)

resultCode0 | 3
  • '0' Success
  • '3' Partial Success of Bulk Operation

Example response

{
  "message": "SUCCESS"
}

Changes

No recorded changes to this operation across all 16 revisions of this API.