Organisations
Download an organisation diagram's SVG
Streams the stored picture to a signed-in member, an organisation's key, or a member's own key, with headers that keep it out of shared caches and out of scripts.
GET
/orgs/{org}/diagrams/{id}/svgTL;DR
| Question | Answer |
|---|---|
| What does it do? | Download an organisation diagram's SVG. |
| What does it take? | org, id in the path, and download in the query string. |
| What does it return? | Status 200 with no body. |
| What can go wrong? | 401 not signed in, or the key is not valid; 404 no such organisation or diagram, the caller is not a member, or the key belongs to another organisation; 429 too many requests, or the daily limit is used up; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
Streams the stored picture to a signed-in member, an organisation's key, or a member's own key, with headers that keep it out of shared caches and out of scripts. With ?download=1 it is an attachment named after the diagram.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
id | string | yes |
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
download | "0" | "1" | no | 1 sends the file as an attachment, named after the diagram. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The SVG. | none |
| 401 | Not signed in, or the key is not valid. | ErrorResponse |
| 404 | No such organisation or diagram, the caller is not a member, or the key belongs to another organisation. | ErrorResponse |
| 429 | Too many requests, or the daily limit is used up. | 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 |