Move multiple documents to the trash in Dynatrace with the Document API, making them inaccessible until restored and returning per-item results.
| POST | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/document/v1/documents:delete |
You provide the document ids in the request body, and you can use the admin-access query parameter to request elevated permissions. Dynatrace moves the listed documents to the trash and returns the result of the bulk operation for each object.
To execute this request, you need a platform token or OAuth access token with document:documents:delete scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | 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 | Bulk | - | body | Required |
BulkDeleteRequest object| Element | Type | Description | Required |
|---|---|---|---|
| ids | string[] | The ids of the documents that shall be deleted. Must not be empty. | Required |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"ids": ["0cf381b6-f235-4606-8675-27f96d954b18","b91371a5-925e-4ee2-868b-cad4d4057416","c1fc125a-e310-439a-9703-c7e3bdbeab5a","doc-123"]}
| Code | Description |
|---|---|
| 200 | - |
| 400 | - |
| 401 | - |
| 403 | - |
| 503 | - |
| default | - |