Skip to content

WorkflowShareResponseDto

Endpoints · All schemas

FieldRequiredDescription
descriptionYesWorkflow description
extraYesAdditional fields of an imported definition, kept and exported unchanged
nameYesWorkflow name
stepsYesWorkflow steps
triggerYesWorkflow trigger type

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: WorkflowShareStepDto

{
  "properties": {
    "description": {
      "description": "Workflow description",
      "nullable": true,
      "type": "string"
    },
    "extra": {
      "additionalProperties": {},
      "description": "Additional fields of an imported definition, kept and exported unchanged",
      "type": "object"
    },
    "name": {
      "description": "Workflow name",
      "nullable": true,
      "type": "string"
    },
    "steps": {
      "description": "Workflow steps",
      "items": {
        "$ref": "#/components/schemas/WorkflowShareStepDto"
      },
      "type": "array"
    },
    "trigger": {
      "description": "Workflow trigger type",
      "type": "string"
    }
  },
  "required": [
    "description",
    "extra",
    "name",
    "steps",
    "trigger"
  ],
  "type": "object"
}