Organisations
An organisation pattern's picture
The picture drawn when the pattern was last saved, light or dark, with an organisation diagram's locked-down headers.
GET
/orgs/{org}/patterns/{name}/pictureTL;DR
| Question | Answer |
|---|---|
| What does it do? | An organisation pattern's picture. |
| What does it take? | org, name in the path, and theme, v 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, pattern or picture, 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
The picture drawn when the pattern was last saved, light or dark, with an organisation diagram's locked-down headers. A pattern saved before pictures were kept has none (404).
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or slug. |
name | string | yes | The name after org:. |
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
theme | "light" | "dark" | no | Which picture: light (the default) or dark. |
v | string | no | The save time the list gave, so a new save is a new address. Not read. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The SVG. | none |
| 401 | Not signed in, or the key is not valid. | ErrorResponse |
| 404 | No such organisation, pattern or picture, 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 |
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 |