canvas.find

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":{"collection":{"default":"everything","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":{"type":"string","minLength":1},"includeDestinations":{"default":true,"type":"boolean"},"limit":{"default":25,"type":"integer","exclusiveMinimum":0,"maximum":50},"cursor":{"type":"string","minLength":1,"maxLength":16384}},"additionalProperties":false}

Example

{
 "collection": "everything",
 "includeDestinations": true,
 "limit": 25
}

Result

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

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

Compatibility: 0710a3924ebaa9e65c664fa7cb3c1a5d7f6a7ae6709842ec0987d8c0a8cb6c96.