Organisations
Send the current version of a placed diagram now
Replaces the picture in its file with the library's current version.
POST
/orgs/{org}/documents/{id}/sendTL;DR
| Question | Answer |
|---|---|
| What does it do? | Send the current version of a placed diagram now. |
| What does it take? | org, id in the path. |
| What does it return? | Status 200 with a body of type DocumentPlacementAnswer. |
| What can go wrong? | 401 not signed in; 403 not the owner or an admin (orgs.forbidden), the plan does not include it (plan.documents_not_included), or the origin may not make changes; 404 no such organisation, diagram, placement or file, or the caller is not a member; 429 too many requests; 502 google refused or could not be reached (documents.google_failed); 503 placing diagrams in documents is not available on this server (documents.unavailable). Every failure uses the one error envelope. |
What it does
Replaces the picture in its file with the library's current version.
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 placement. | DocumentPlacementAnswer |
| 401 | Not signed in. | ErrorResponse |
| 403 | Not the owner or an admin (orgs.forbidden), the plan does not include it (plan.documents_not_included), or the origin may not make changes. | ErrorResponse |
| 404 | No such organisation, diagram, placement or file, or the caller is not a member. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 502 | Google refused or could not be reached (documents.google_failed). | ErrorResponse |
| 503 | Placing diagrams in documents is not available on this server (documents.unavailable). | ErrorResponse |
Response body
A 200 answer has the type DocumentPlacementAnswer.
| Field | Type | Required | Description |
|---|---|---|---|
placement | DocumentPlacement | yes | |
placement.id | string | yes | |
placement.diagramId | string | yes | |
placement.diagramName | string | null | yes | |
placement.kind | "slides" | "docs" | yes | slides for a Google Slides deck, docs for a Google Doc. |
placement.fileId | string | yes | |
placement.fileName | string | yes | |
placement.pageId | string | null | yes | The slide, for a deck; null for a Doc. |
placement.status | "ok" | "failing" | "gone" | yes | ok, failing (the last send failed; lastError says why) or gone (the file or the picture is no longer there). |
placement.lastError | string | null | yes | |
placement.lastSentAt | integer | null | yes | |
placement.current | boolean | yes | Whether the file shows the library's current version. |
placement.createdAt | integer | yes | |
placement.link | string | yes | The file in Google. |
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 |