Organisations
Keep a diagram from the library retention
True keeps the diagram whatever "Delete library diagrams not updated for" says; the plan's own retention still applies.
PUT
/orgs/{org}/diagrams/{id}/keptTL;DR
| Question | Answer |
|---|---|
| What does it do? | Keep a diagram from the library retention. |
| What does it take? | A JSON body of type SetDiagramKeptBody. |
| What does it return? | Status 200 with a body of type DiagramKept. |
| What can go wrong? | 400 the body is not valid; 401 not signed in; 403 the role may not (orgs.forbidden), or the request came from an origin that may not make changes; 404 no such organisation or diagram, or the caller is not a member, or the diagram is in a folder the caller may not use; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
True keeps the diagram whatever "Delete library diagrams not updated for" says; the plan's own retention still applies. The owner and admins.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
id | string | yes |
Request body
The body has the type SetDiagramKeptBody.
| Field | Type | Required | Description |
|---|---|---|---|
kept | boolean | yes | True keeps the diagram from the library retention; false lets it go when it is due. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The diagram's value now. | DiagramKept |
| 400 | The body is not valid. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | The role may not (orgs.forbidden), or the request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation or diagram, or the caller is not a member, or the diagram is in a folder the caller may not use. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type DiagramKept.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
kept | boolean | yes |
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 |