Sign in

v1

latestOpenAPI 3.0.32026-07-176179196.6 KB
workflows

Required scope: automation:workflows:run<br/><br/>Creates an Execution for the Workflow.

post/workflows/{id}/run

Path parameters

idstring uuid required

A UUID string identifying this workflow.

Query parameters

adminAccessboolean

Allow access to all workflows/executions - additionally requires automation:workflows:admin

Request body

inputobject
paramsobject
uniqueQualifierstring

Response

idstring uuid
workflowstring uuid nullable

Executed Workflow

labelsLabels
state'RUNNING' | 'SUCCESS' | 'ERROR' | 'WAITING' | 'IDLE' | 'PAUSED' | 'DELAYED' | 'CANCELLED'
  • RUNNING - RUNNING
  • SUCCESS - SUCCESS
  • ERROR - ERROR
  • WAITING - WAITING
  • IDLE - IDLE
  • PAUSED - PAUSED
  • DELAYED - DELAYED
  • CANCELLED - CANCELLED
stateInfostring nullable
inputobject
paramsobject
startedAtstring date-time
endedAtstring date-time nullable
runtimeinteger required

Calculate the runtime of an execution in seconds. If the Execution is not ended, runtime is calculated until now.

triggerstring nullable
schedulestring uuid nullable
eventTriggerstring uuid nullable
taskstring required
parentTaskExecutionstring uuid required
parentExecutionstring uuid required
resultobject
userstring nullable
titlestring required
triggerTypestring required