List environment shares accessible to you in Dynatrace with the Document API, with optional filtering and pagination for document access.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/document/v1/environment-shares |
List all environment-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 environment-shares, or a specific share, you can use the filter parameter to narrow down the result set. If you attempt to retrieve environment-shares of a document not accessible by you, the result set will be empty.
Furthermore, you can apply pagination via the pageKey, page and pageSize parameters.
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:environment-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 |
| Code | Type | Description |
|---|---|---|
| 200 | Environment | A list of the environment-shares accessible to you.
If the list was paginated (see |
| 400 | - | - |
| 401 | - | - |
| 403 | - | - |
| 500 | - | - |
| 503 | - | - |
| default | - | - |
EnvironmentShareList objectA list of environment-shares.
| Element | Type | Description |
|---|---|---|
| environment-shares | Environment | - |
| nextPageKey | string | Use this as |
| totalCount | integer | The total amount of matching results for this query, as if no pagination would have been applied. |
EnvironmentShare object| Element | Type | Description |
|---|---|---|
| id | string | System-generated id of a share resource. |
| documentId | string | The shared document's id. |
| access | string[] | Indicates which operations you may apply to this document. For example, if you own the document, this array contains the values ['read', 'write', 'delete'].
|
| claimCount | integer | Number of users who have claimed this share and therefore can access the document and collaborate on it. |
{"environment-shares": [{"id": "af21cc73-bb1c-45f1-ad1b-12e8f91b9fbc","documentId": "1d1cf013-fd4c-463e-a8ad-912485daf711","access": ["read"],"claimCount": 5},{"id": "f0ed12ec-f232-45db-b667-26b2cf414787","documentId": "1d1cf013-fd4c-463e-a8ad-912485daf711","access": ["read","write"],"claimCount": 0},{"id": "9dc638d0-0cea-4c9c-ad9c-85ec02d967d6","documentId": "4f135fa6-0c1b-456d-b962-20f14a2ac67e","access": ["read","write"],"claimCount": 42}],"nextPageKey": "bmQgUXVhcms=","totalCount": 42}