WorkflowResponseDto

Endpoints · All schemas

Field	Required	Description
createdAt	Yes	Creation date
description	Yes	Workflow description
enabled	Yes	Workflow enabled
extra	Yes	Additional fields of an imported definition, kept and exported unchanged
id	Yes	Workflow ID
issues	Yes	What prevents this definition from running on this server; empty when it can run
logging	Yes	Workflow logs run results
name	Yes	Workflow name
steps	Yes	Workflow steps
trigger	Yes	Workflow trigger type
updatedAt	Yes	Update date

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.

Field definitions: WorkflowIssueDto, WorkflowStepResponseDto

{
  "properties": {
    "createdAt": {
      "description": "Creation date",
      "type": "string"
    },
    "description": {
      "description": "Workflow description",
      "nullable": true,
      "type": "string"
    },
    "enabled": {
      "description": "Workflow enabled",
      "type": "boolean"
    },
    "extra": {
      "additionalProperties": {},
      "description": "Additional fields of an imported definition, kept and exported unchanged",
      "type": "object"
    },
    "id": {
      "description": "Workflow ID",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "issues": {
      "description": "What prevents this definition from running on this server; empty when it can run",
      "items": {
        "$ref": "#/components/schemas/WorkflowIssueDto"
      },
      "type": "array"
    },
    "logging": {
      "description": "Workflow logs run results",
      "type": "boolean"
    },
    "name": {
      "description": "Workflow name",
      "nullable": true,
      "type": "string"
    },
    "steps": {
      "description": "Workflow steps",
      "items": {
        "$ref": "#/components/schemas/WorkflowStepResponseDto"
      },
      "type": "array"
    },
    "trigger": {
      "description": "Workflow trigger type",
      "type": "string"
    },
    "updatedAt": {
      "description": "Update date",
      "type": "string"
    }
  },
  "required": [
    "createdAt",
    "description",
    "enabled",
    "extra",
    "id",
    "issues",
    "logging",
    "name",
    "steps",
    "trigger",
    "updatedAt"
  ],
  "type": "object"
}