Inspect a document lock in Dynatrace with the Document API, showing whether the document is locked and who owns the lock.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/document/v1/documents/{id}:inspect-lock |
You pass the document id path parameter. The response returns lock details for the document, including whether it is locked and the user who currently owns the lock.
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 |
| Code | Description |
|---|---|
| 200 | - |
| 400 | - |
| 401 | - |
| 403 | - |
| 404 | - |
| 500 | - |
| 503 | - |
| default | - |