Skip to content

Setter State

- id: a
  type: setter
  - key: x 
    scope: workflow
    mimeType: text/plain
    value: 'jq(.x)'


To create or change variables, use the setter state. See Variables.

Parameter Description Type Required
type Identifies which kind of StateDefinition is being used. In this case it must be set to setter. string yes
id An identifier unique within the workflow to this one state. string yes
log If defined, the workflow will generate a log when it commences this state. See StateLogging. Structured JQ no
metadata If defined, updates the instance's metadata. See InstanceMetadata. Structured JQ no
transform If defined, modifies the instance's data upon completing the state logic. See StateTransforms. Structured JQ no
transition Identifies which state to transition to next, referring to the next state's unique id. If undefined, this state terminates the workflow. string no
catch Defines behaviour for handling of catchable errors. []ErrorCatchDefinition no
variables Defines variables to push. []VariableSetterDefinition yes


Parameter Description Type Required
key Variable name. string yes
scope Selects the scope to which the variable belongs. If undefined, defaults to instance. See Variables. yes no
mimeType Store a MIME type with the variable. If left undefined, it will default to application/json. Two specific MIME types cause this state to behave differently: text/plain and application/octet-stream. If the value evaluates to a JSON string the MIME type is text/plain, that string will be stored in plaintext (without JSON quotes and escapes). If if the value is a JSON string containing base64 encoded data and the MIME type is application/octet-stream, the base64 data will be decoded and stored as binary data. string no
value Select or generate the data to store. Structured JQ yes