canvas.get

query read

Use when current canvas state is needed before deciding or changing anything.

Before calling

• Authenticate as the accountable Enhance person.
• Use only resource identifiers returned by an earlier capability result or supplied by the person.

Input

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "canvasId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "canvasId"
  ],
  "additionalProperties": false
}

Example

{
  "canvasId": "00000000-0000-4000-8000-000000000010"
}

Result

Returns a typed canvas.get result from the Enhance API without transport-specific prose.

Recovery

• BAD_REQUEST: correct the named fields and call again.
• UNAUTHORIZED: restore Enhance authentication, then retry once.
• FORBIDDEN or NOT_FOUND: list accessible resources and choose an allowed identifier.
• CONFLICT: read the current resource, merge the intended change, and retry with its version.
• INTERNAL: run Enhance diagnostics, report the failure, and stop repeating the call.

Continue with

• Use the returned identifiers and version in the next canvas operation.

Compatibility: e38af6fdeaf329c1c0ef02530585c0ea2a7aa33279048ed58bf3b6aff7bc147a.