List direct shares accessible to you in Dynatrace with the Document API, with filtering and pagination for document access.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/document/v1/direct-shares |
List all direct-shares accessible to you.
Shares accessible to you include those of your own documents, as well as those of reshareable documents owned by other users to which you have write access. If you are only concerned with a specific document's shares, or a specific share, you can use the filter parameter to narrow down the result set. If you attempt to retrieve shares which are not accessible to you the result set will be empty.
Note, that at the moment we offer a naive pagination, and therefore interim mutations can lead to result inconsistencies (such as duplicates, missing entries).
To execute this request, you need a platform token or OAuth access token with document:direct-shares:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| filter | string | The filter query, as explained here. Filtering is only possible on the | query | Optional |
| page-key | string | The page key is used to query results from the next page.
You get a | query | Optional |
| page | integer | The page parameter is used to directly access a specific page. The value of the page parameter, if specified, has to be a value greater than zero. If the value of the page parameter exceeds the highest available page on the backend, an empty page is returned. | query | Optional |
| page-size | integer | The page size which defines the requested number of result entries. You can request a maximum of 1000 result entries. If this parameter is omitted, the default value of 20 will be used. | query | Optional |
| admin-access | boolean | Indicates whether the operation should be performed with elevated permissions - additionally requires document:documents:admin. If provided, the user effectively operates as owner of all documents. This isn't supported for ready-made documents. | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Direct | A list of direct-shares accessible to you. |
| 400 | - | - |
| 401 | - | - |
| 403 | - | - |
| 500 | - | - |
| 503 | - | - |
| default | - | - |
DirectShareList objectA list of direct-shares.
| Element | Type | Description |
|---|---|---|
| direct-shares | Direct | - |
| nextPageKey | string | - |
| totalCount | integer | - |
DirectShare object| Element | Type | Description |
|---|---|---|
| id | string | System-generated id. |
| documentId | string | The shared document's id. |
| access | string[] | The access granted by this share. |
| userCount | integer | Number of users who have been directly assigned to this share and therefore can access the document and collaborate on it. Not that potentially assigned groups and their users (see groupCount) are not reflected in this number. |
| groupCount | integer | Number of groups which have been assigned to this share. |
{"direct-shares": [{"id": "af21cc73-bb1c-45f1-ad1b-12e8f91b9fbc","documentId": "1d1cf013-fd4c-463e-a8ad-912485daf711","access": ["read"],"userCount": 5,"groupCount": 0},{"id": "f0ed12ec-f232-45db-b667-26b2cf414787","documentId": "1d1cf013-fd4c-463e-a8ad-912485daf711","access": ["read","write"],"userCount": 0,"groupCount": 5},{"id": "9dc638d0-0cea-4c9c-ad9c-85ec02d967d6","documentId": "4f135fa6-0c1b-456d-b962-20f14a2ac67e","access": ["read","write"],"userCount": 167,"groupCount": 2}],"nextPageKey": "bmQgUXVhcms=","totalCount": 3}