Update document metadata in Dynatrace with the Document API, changing user-defined fields while leaving content untouched.
| PATCH | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/document/v1/documents/{id}/metadata |
Deprecated - the preferred way to update a document is the updateDocument operation.
Partially update a document's user-defined metadata. At least one property must be updated, otherwise the operation fails.
The document's content isn't affected by this operation.
Optimistic locking is enforced via the optimistic-locking-version parameter.
The document must be accessible to you - therefore, you must either own it or you have received access through sharing.
To execute this request, you need a platform token or OAuth access token with document:documents:write 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 |
| optimistic-locking-version | string | To protect users from accidental overrides, the current version of the document must match the optimistic locking version parameter - otherwise, this request will fail and the entity is left unchanged. | query | Required |
| 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 |
| body | object | - | body | Required |
RequestBody object| Element | Type | Description | Required |
|---|---|---|---|
| name | string | Document name. | Optional |
| type | string | Document type. | Optional |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"name": "","type": ""}
| Code | Description |
|---|---|
| 200 | - |
| 400 | - |
| 401 | - |
| 403 | - |
| 404 | - |
| 409 | - |
| 500 | - |
| 503 | - |
| default | - |