Canvas share
/v1/canvases/{id}/share
Signed-in sessionLaunch key product.canvasOperation canvas_share
A canvas is a drawing in the workspace or a page in a project's Docs tree.
Headers
- X-Specify-Account-IdstringRequired
- The account the request acts in.
- X-Specify-Service-Tenancy-IdstringRequired
- The service tenancy the request acts in.
Path parameters
- idstringRequired
Body
- visibility"private" | "tenant"Required
- expectedAuthorizationVersionstringRequired
- expectedVersionnumberRequired
Returns
- idstringRequired
- titlestringRequired
- ownerobjectRequired
- seqnumberRequired
- elementCountnumberRequired
- bytesnumberRequired
- versionnumberRequired
- canEditbooleanRequired
- minebooleanRequired
- createdAtnumberRequired
- lastEditAtnumberRequired
- lastEditBynull | objectRequired
- deletedAtnull | numberRequired
- canvasSchemaVersionnumberRequired
- appStatestringRequired
- openCheckpointIdnull | stringRequired
- lastCheckpointSeqnumberRequired
- limitsobjectRequired
Errors
400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}. A call without a valid credential gets 401 before its input is checked, and so does an address that is not an operation: 404 and 400 come only once the credential is accepted. Public operations answer without one.