Organisations
Read where the organisation's library is sent
The plan, Plotwork’s issuer for the organisation, whether Google Drive can be connected, and each storage destination with its sending.
GET
/orgs/{org}/storageTL;DR
| Question | Answer |
|---|---|
| What does it do? | Read where the organisation's library is sent. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type StorageOverview. |
| What can go wrong? | 401 not signed in; 403 not the owner or an admin (orgs.forbidden), the plan does not include it (plan.storage_not_included), or the origin may not make changes; 404 no such organisation or destination, or the caller is not a member; 429 too many requests; 503 sending to your storage is not available on this server (storage.unavailable). Every failure uses the one error envelope. |
What it does
The plan, Plotwork’s issuer for the organisation, whether Google Drive can be connected, and each storage destination with its sending. The owner and the admins only.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The storage destinations. | StorageOverview |
| 401 | Not signed in. | ErrorResponse |
| 403 | Not the owner or an admin (orgs.forbidden), the plan does not include it (plan.storage_not_included), or the origin may not make changes. | ErrorResponse |
| 404 | No such organisation or destination, or the caller is not a member. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Sending to your storage is not available on this server (storage.unavailable). | ErrorResponse |
Response body
A 200 answer has the type StorageOverview.
| Field | Type | Required | Description |
|---|---|---|---|
available | boolean | yes | Whether the plan sends the library to your storage: Pro and Enterprise. |
plan | string | yes | |
issuer | string | null | yes | Plotwork’s issuer for this organisation, which a bucket trusts; null when this server is no issuer. |
google | object | yes | |
google.configured | boolean | yes | Whether this server can connect Google Drive. |
google.picker | boolean | yes | Whether the Google folder picker is set up, so an existing folder can be chosen. |
destinations | StorageDestination[] | yes | At most one of each type. |
destinations[].id | string | yes | |
destinations[].type | "google_drive" | "s3" | "azure_blob" | "gcs" | yes | google_drive, s3, azure_blob or gcs. |
destinations[].state | "setup" | "on" | "paused" | yes | setup while the steps are not done (nothing is sent), on, or paused. |
destinations[].connected | boolean | yes | False for Google Drive until a Google account has granted access; true for a bucket. |
destinations[].target | StorageGoogleDriveTarget | StorageS3Target | StorageAzureBlobTarget | StorageGcsTarget | yes | |
destinations[].send | StorageSend | yes | |
destinations[].send.folders | array | null | yes | Library folders to send, each with the folders inside it; null for every folder that has no access rule. |
destinations[].send.formats | ("svg" | "source")[] | yes | svg sends the picture; source sends the .diagram text the picture carries, when it carries one. |
destinations[].send.scheme | "published" | "light" | "dark" | yes | A picture that follows the reader’s color scheme is sent as it is, or pinned to light or dark. |
destinations[].send.mirrorDeletions | boolean | yes | Remove a file when its diagram is deleted from the library or moved out of what is sent. |
destinations[].send.skipConfidential | boolean | yes | Leave out diagrams labelled Confidential. |
destinations[].subject | string | null | yes | The subject Plotwork’s issuer signs for this destination, which the bucket’s trust names. Null for Google Drive. |
destinations[].createdAt | integer | yes | |
destinations[].updatedAt | integer | yes | |
destinations[].status | StorageStatus | yes | |
destinations[].status.queued | integer | yes | |
destinations[].status.delivered | integer | yes | |
destinations[].status.dropped | integer | yes | |
destinations[].status.droppedLast24h | integer | yes | |
destinations[].status.files | integer | yes | Diagrams the destination holds a copy of now. |
destinations[].status.lastSuccessAt | integer | null | yes | |
destinations[].status.lastErrorAt | integer | null | yes | |
destinations[].status.lastError | string | null | yes | What failed last, in our words. Never what the destination answered. |
destinations[].status.nextAttemptAt | integer | null | yes | |
destinations[].status.failingSince | integer | null | yes |
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 |