Enhance documentation

canvas.list

Find canvas ids by collection, title, access, review state, or deletion state.

↓ Markdown

canvas.list

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

Show complete JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "collection": {
      "default": "own",
      "anyOf": [
        {
          "type": "string",
          "const": "own"
        },
        {
          "type": "string",
          "const": "everything"
        },
        {
          "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)$"
        }
      ]
    },
    "title": {
      "description": "Title text to match before returning canvas ids.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "deleted": {
      "default": false,
      "type": "boolean"
    },
    "accessState": {
      "type": "string",
      "enum": [
        "invite-only",
        "link-view",
        "link-comment"
      ]
    },
    "scope": {
      "default": "all",
      "type": "string",
      "enum": [
        "all",
        "mine",
        "shared"
      ]
    },
    "hasUnresolved": {
      "default": false,
      "type": "boolean"
    }
  },
  "required": [
    "collection",
    "deleted",
    "scope",
    "hasUnresolved"
  ],
  "additionalProperties": false
}

Example

Show example input

{
  "collection": "own",
  "deleted": false,
  "scope": "all",
  "hasUnresolved": false
}

Result

Returns a typed canvas.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: 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

Choose an id from the result before another canvas operation.

Compatibility: 28695da0838aef5001bdb220011ff0896f2b59e8390189768565316561561813.