WorkspaceResourcesGetWorkspace Method |  |
Gets the specified Workspace (and lists its contents).
It mirrors to the following Smartsheet REST API method: GET /workspaces/{workspaceid}
RemarksBy default, this operation only returns the top-level items in the Workspace. To load all of the contents, including nested Folders, include the loadAll query string parameter with a value of true.
If no Folders, Sheets, Reports, or Templates are present in the Workspace, the corresponding attribute (e.g., "folders", "sheets") will not be present in the response object.
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
SyntaxWorkspace GetWorkspace( long workspaceid, Nullable<bool> loadAll, IEnumerable<WorkspaceInclusion> include )
Parameters
- workspaceid
- Type: SystemInt64
the workspace id - loadAll
- Type: SystemNullableBoolean
Defaults to false. If true, loads all of the contents, including nested Folders. - include
- Type: System.Collections.GenericIEnumerableWorkspaceInclusion
When specified with a value of "source", response will include the source for any sheet that was created from another sheet or template
Return Value
Type: Workspacethe workspace (note that if there is no such resource, this method will throw ResourceNotFoundException rather than returning null)
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 |
See Also