Organisations
List the boards a library diagram is on
The boards with a tab that came from, or was saved to, this library diagram: named when the caller may open them, and counted in hidden when not.
GET
/orgs/{org}/diagrams/{id}/boardsTL;DR
| Question | Answer |
|---|---|
| What does it do? | List the boards a library diagram is on. |
| What does it take? | org, id in the path. |
| What does it return? | Status 200 with a body of type DiagramBoards. |
| What can go wrong? | 401 not signed in; 403 boards are not turned on for this organisation (boards.not_enabled), the caller may look but not change it (boards.forbidden), or the request came from an origin that may not make changes; 404 no such organisation, board or tab, or the board is not open to the caller: the cases look alike; 429 too many requests; 503 organisations or boards are not set up on this server. Every failure uses the one error envelope. |
What it does
The boards with a tab that came from, or was saved to, this library diagram: named when the caller may open them, and counted in hidden when not.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
id | string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The boards. | DiagramBoards |
| 401 | Not signed in. | ErrorResponse |
| 403 | Boards are not turned on for this organisation (boards.not_enabled), the caller may look but not change it (boards.forbidden), or the request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation, board or tab, or the board is not open to the caller: the cases look alike. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations or boards are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type DiagramBoards.
| Field | Type | Required | Description |
|---|---|---|---|
items | object[] | yes | |
items[].id | string | yes | at least 22 characters; at most 22 characters; pattern ^[0-9A-Za-z]+$. |
items[].name | string | yes | |
items[].tab | string | yes | at least 12 characters; at most 12 characters; pattern ^[0-9A-Za-z]+$. |
hidden | integer | yes | minimum 0. |
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 |