enhancedocs
For agentsOpen Enhance ↗
Reference / canvas.version.name

Enhance documentation

canvas.version.name

Name the current or a retained canvas version so it is kept.

↓ Markdown

canvas.version.name

mutation write

Use when the requested change exactly matches canvas.version.name; read the current state first when a version or identifier may have changed.

Before calling

  • Authenticate as the accountable Enhance person.
  • Use only resource identifiers returned by an earlier capability result or supplied by the person.
  • Reuse clientToken only when retrying this exact mutation input.

Input

Show complete JSON Schema 
{"$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)$"},"target":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"current"},"expectedVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["kind","expectedVersion"]},{"type":"object","properties":{"kind":{"type":"string","const":"version"},"versionId":{"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":["kind","versionId"]}]},"title":{"type":"string","minLength":1},"description":{"default":null,"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]}},"required":["canvasId","target","title"]}

Example

Show example input 
{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "target": {
  "kind": "current",
  "expectedVersion": 1
 },
 "title": "x"
}

Result

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

  • Read the affected canvas resource to confirm the result.

Compatibility: ae6f0f0109e2b9f3ec4fcbab4b3797c2d0277412abb6dd3e9a1d8c0c73aab4b4.