WorkflowStepDto

Endpoints · All schemas

Field	Required	Description
config	Yes	Step configuration
enabled	No	Step is enabled
extra	No	Additional fields of an imported definition, kept and exported unchanged
id	No	Step ID from a previous response. A credential left out of its configuration keeps its stored value
method	Yes	Step plugin method, as plugin#method

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

{
  "properties": {
    "config": {
      "additionalProperties": {},
      "description": "Step configuration",
      "nullable": true,
      "type": "object"
    },
    "enabled": {
      "description": "Step is enabled",
      "type": "boolean"
    },
    "extra": {
      "additionalProperties": {},
      "description": "Additional fields of an imported definition, kept and exported unchanged",
      "type": "object"
    },
    "id": {
      "description": "Step ID from a previous response. A credential left out of its configuration keeps its stored value",
      "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)$",
      "type": "string"
    },
    "method": {
      "description": "Step plugin method, as plugin#method",
      "maxLength": 300,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "config",
    "method"
  ],
  "type": "object"
}