ShareResourcesListShares Method |  |
List shares of a given object.
It mirrors to the following Smartsheet REST API method:
GET /workspaces/{workspaceId}/shares
GET /sheets/{sheetId}/shares
GET /reports/{reportId}/shares
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
SyntaxPaginatedResult<Share> ListShares( long objectId, PaginationParameters paging, ShareScope shareScope )
Parameters
- objectId
- Type: SystemInt64
the object Id - paging
- Type: Smartsheet.Api.ModelsPaginationParameters
the pagination request - shareScope
- Type: Smartsheet.Api.ModelsShareScope
when specified with a value of Workspace, the response will contain both item-level shares (scope=‘ITEM’) and workspace-level shares (scope='WORKSPACE’).
Return Value
Type: PaginatedResultSharethe list of Share objects (note that an empty list will be returned if there is none).
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