Organisations
Lock an organisation diagram
Locks the diagram so nobody can delete, rename or move it, the member who published it and the owner included, until the owner unlocks it.
PUT
/orgs/{org}/diagrams/{id}/lockTL;DR
| Question | Answer |
|---|---|
| What does it do? | Lock an organisation diagram. |
| What does it take? | org, id in the path. |
| What does it return? | Status 204 with no body. |
| What can go wrong? | 401 not signed in; 403 only the owner may lock a diagram (orgs.forbidden), or the request came from an origin that may not make changes; 404 no such organisation or diagram, the diagram is in a folder the caller may not use, or the caller is not a member; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
Locks the diagram so nobody can delete, rename or move it, the member who published it and the owner included, until the owner unlocks it. Only the owner may lock or unlock. A lock does not stop the plan's expiry. Session only.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
id | string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
| 204 | Locked. | none |
| 401 | Not signed in. | ErrorResponse |
| 403 | Only the owner may lock a diagram (orgs.forbidden), or the request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation or diagram, the diagram is in a folder the caller may not use, or the caller is not a member. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |