Organisations
Keep an organisation's diagrams editable
Turns the owner's setting on or off.
PUT
/orgs/{org}/editableTL;DR
| Question | Answer |
|---|---|
| What does it do? | Keep an organisation's diagrams editable. |
| What does it take? | A JSON body of type KeepEditable. |
| What does it return? | Status 200 with a body of type KeepEditable. |
| What can go wrong? | 400 the body is not valid; 401 not signed in; 403 only the owner may change it (orgs.forbidden), or the request came from an origin that may not make changes; 404 no such organisation, or the caller is not a member of it; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
Turns the owner's setting on or off. On, a publish to the organisation that does not send embedSource writes the diagram source into the picture so members can edit it later; embedSource false still leaves it out. Only the owner may.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Request body
The body has the type KeepEditable.
| Field | Type | Required | Description |
|---|---|---|---|
keepEditable | boolean | yes | True to write the diagram source into every picture published to the organisation that does not say otherwise, so members can edit it in the portal later. A publish that sends embedSource false still leaves it out. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The value now. | KeepEditable |
| 400 | The body is not valid. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | Only the owner may change it (orgs.forbidden), or the request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type KeepEditable.
| Field | Type | Required | Description |
|---|---|---|---|
keepEditable | boolean | yes | True to write the diagram source into every picture published to the organisation that does not say otherwise, so members can edit it in the portal later. A publish that sends embedSource false still leaves it out. |
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 |