ProcessInstance

A Process instance (1.62.0, ADR 0039): one durable execution of a published process-scope Workflow version, with its status, where it waits and who started it. Identifiers, codes and instants, and its content only on include=content.

An object with 22 fields.

Fields

Field	Type	Required	Description
`compliance_profile_version`	integer or null	yes	The Compliance profile version pinned at the start (section 10, rule 3).
`correlated`	boolean	yes	True when the instance has a correlation key, which Process events match on; the key is kept as a keyed hash and never answered.
`current_nodes`	array of WorkflowNodeId	yes	The nodes the instance is at; empty once it ended.
`ended_at`	Timestamp or null	yes
`environment`	Environment	yes
`error_code`	string or null	yes	Why a `failed` instance failed, such as `max_steps_reached`, `max_lifetime_reached` or the failure code of the node that ended it `failed`; null otherwise.
`id`	ProcessInstanceId	yes
`inputs`	object or null	yes	The start inputs. Content; null unless the read names `include=content`.
`interpreter_version`	string	yes	The version of Vocal's interpreter the instance pinned at its start, kept by the runner until the instance ends.
`object`	`"process"`	yes
`organization_id`	OrganizationId	yes
`outputs`	object or null	yes	The declared outputs, once the instance ended on an `end` node. Content; null unless the read names `include=content`.
`project_id`	ProjectId or null	yes	The instance's Project: the default Project until Projects ship.
`started_at`	Timestamp	yes
`started_by`	ProcessStartedBy	yes
`status`	ProcessInstanceStatus	yes
`updated_at`	Timestamp	yes
`vars`	object or null	yes	The working data. Content; null unless the read names `include=content`.
`waiting_on`	ProcessWaitingOn or null	yes
`wake_at`	Timestamp or null	yes	The next timer of a waiting instance, mirrored from the runner; null when none.
`workflow_id`	WorkflowId	yes
`workflow_version`	integer	yes	The process-scope Workflow version the instance runs to its end (section 10).

Used by

The operations whose parameters, request body or responses name this shape directly.