canvas.version.list

query read

Use when current canvas state is missing from the task context.

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)$"
  },
  "limit": {
   "default": 50,
   "type": "integer",
   "minimum": 1,
   "maximum": 100
  },
  "cursor": {
   "type": "string",
   "minLength": 1,
   "maxLength": 1000
  },
  "includeAutomatic": {
   "default": false,
   "type": "boolean"
  },
  "actor": {
   "default": "all",
   "type": "string",
   "enum": [
    "all",
    "mine"
   ]
  }
 },
 "required": [
  "canvasId",
  "limit",
  "includeAutomatic",
  "actor"
 ],
 "additionalProperties": false
}

Example

{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "limit": 50,
 "includeAutomatic": false,
 "actor": "all"
}

Result

Returns a typed canvas.version.list 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: check the supplied resource and selection; do not substitute unrelated content. Ask for corrected access or scope if needed.
• 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

• Choose an id from the result before another canvas operation.

Compatibility: 7d473408c1c47dffaf04bd66532cde5916e8861f764282a5deb22f0fbc6b6e7b.