Skip to content

Schemas

Definition objects

Schema Purpose Identity and important relationships
WorkflowDef.json A reusable workflow blueprint. name and version identify a definition. tasks contains WorkflowTask configurations; inputParameters, outputParameters, timeouts, owner, and failure-workflow settings shape its contract.
TaskDef.json Registered configuration for a worker (SIMPLE) task type. name identifies the task definition. Retry policy, timeout values, rate limits, and concurrency settings apply when a workflow task refers to that type.

Runtime objects

Schema Purpose Identity and lifecycle relationships
Workflow.json One execution of a WorkflowDef. workflowId identifies the execution; workflowName, workflowVersion, status, timestamps, input/output, variables, and tasks record its lifecycle.
Task.json One scheduled or executed task inside a workflow. taskId identifies the runtime task; workflowInstanceId links it to its workflow. taskType, referenceTaskName, status, input/output, and retry/timeout state describe execution.

Definition objects are submitted through the Metadata API. Runtime objects are returned by the Workflow API and Task API. Use the linked schema files when generating clients, validating payloads, or checking the complete list of fields.