WorkflowDocumentInfo

A single document slot inside an envelope. Carries the slot identifier (key) plus the workflow-runtime payload supplied at create time and editable during workflow review (fieldOverrides, adhocFields, inputMap). Template-derived metadata (template identity, template fields, inputs, roles, file pointer) is not included here — fetch the source template directly via GET /templates/{key}?version={version} if you need it.

  • adhocFields
    Type: array object[]
    required

    Ad-hoc fields added beyond the template's declared schema. Initially supplied at workflow create time (POST /workflowsdocuments[].adhocFields); can be modified during workflow review while the workflow is pending. The only place to discover non-template fields on a workflow document.

    Empty object
  • fieldOverrides
    Type: array object[]
    required

    Per-document field overrides — values that override the template's defaults at render time. Initially supplied at workflow create time (POST /workflowsdocuments[].fieldOverrides); can be modified during workflow review while the workflow is pending.

    Empty object
  • inputMap
    Type: array object[]
    required

    Wires this document's underlying template inputs to the workflow's blueprint inputs — same shape as the blueprint's documents[].inputMap it was derived from. Each entry says "feed blueprintInputKey from the running workflow into templateInputKey on this template." Defaults come from the blueprint at workflow create time and can be modified during workflow review while the workflow is pending.

    • blueprintInputKey
      Type: string

      Input key declared on the workflow's blueprint that supplies the data — matches an entity key in the workflow's entity set.

    • templateInputKey
      Type: string

      Input key declared on the document's underlying template — matches one of the source template's inputs[].key.

  • key
    Type: string
    required

    Document key, matching the document declared on the workflow's blueprint envelope. For iterator-expanded documents, suffixed with the iterator index.