Retrieve document metadata in Dynatrace with the Document API, including snapshot metadata when you request a specific version.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/document/v1/documents/{id}/metadata |
You pass the document id and can optionally use snapshot-version, admin-access, and add-fields. The response returns the document metadata, or the metadata of the requested snapshot when you specify a snapshot version.
To execute this request, you need a platform token or OAuth access token with document:documents:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string | System-generated or user-given id of a document. | path | Required |
| snapshot-version | integer | Snapshot version, to be used if you want to access a snapshot of the document. | 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 |
| add-fields | string | Comma-separated list of field names that are added to the default set of fields. You can include the following additional fields:
| query | Optional |
| Code | Description |
|---|---|
| 200 | - |
| 401 | - |
| 403 | - |
| 404 | - |
| 500 | - |
| 503 | - |
| default | - |