Organisations
List members' public diagrams for review
While the organisation requires its library: the public diagrams members published since they joined, newest first, at most 200.
GET
/orgs/{org}/publishing/public-diagramsTL;DR
| Question | Answer |
|---|---|
| What does it do? | List members' public diagrams for review. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type MemberPublicDiagramList. |
| What can go wrong? | 401 not signed in; 403 only the owner or an admin may (orgs.forbidden); 404 no such organisation, or the caller is not a member of it; 409 the organisation does not require its library now (orgs.publish_review_unavailable); 429 too many requests; 503 organisations or hosting are not set up on this server. Every failure uses the one error envelope. |
What it does
While the organisation requires its library: the public diagrams members published since they joined, newest first, at most 200. The owner or an admin.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The list. | MemberPublicDiagramList |
| 401 | Not signed in. | ErrorResponse |
| 403 | Only the owner or an admin may (orgs.forbidden). | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 409 | The organisation does not require its library now (orgs.publish_review_unavailable). | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations or hosting are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type MemberPublicDiagramList.
| Field | Type | Required | Description |
|---|---|---|---|
items | MemberPublicDiagram[] | yes | At most 200, newest published first. |
items[].id | string | yes | The personal diagram's id. |
items[].name | string | null | yes | |
items[].url | string | yes | Its public link, which anyone who has it can open. |
items[].createdAt | integer | yes | |
items[].publishedAt | integer | yes | |
items[].bytes | integer | yes | |
items[].locked | boolean | yes | Whether the member locked it. Moving and unpublishing override the member's lock. |
items[].stableLinks | integer | yes | How many of the member's stable links show it now. minimum 0. |
items[].member | object | yes | |
items[].member.userId | string | yes | |
items[].member.email | string | yes | |
total | integer | yes | How many there are, which may be more than the list holds. 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 |