Enhance documentation

comment.list

List comment threads and replies on a canvas.

↓ Markdown

comment.list

query read

Use when current comment 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

Show complete JSON Schema

{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"context":{"type":"object","properties":{"canvasRef":{"type":"string","minLength":1},"expectedVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["canvasRef","expectedVersion"],"additionalProperties":false},"page":{"type":"object","properties":{"cursor":{"default":null,"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}]},"limit":{"default":20,"type":"integer","minimum":1,"maximum":100}}},"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)$"},"filter":{"default":"open","type":"string","enum":["open","resolved","all"]},"authorPersonId":{"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)$"},"agentActionable":{"default":false,"type":"boolean"},"query":{"type":"string","maxLength":200}},"required":["canvasId"]}

Example

Show example input

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

Result

Returns a typed comment.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 comment operation.

Compatibility: 2539f61a74f6820e1d8d53d997de55fcf8ecd9508c307b0291c5a783e7384bb0.