StartWorkflowRun

StartWorkflowRun

This API starts a workflow run for a specified workflow definition.

Important

Number of concurrent workflow runs, and number of steps executed in a given run is defined at Workflow System Limits.

Parameters

Parameter	Type	Required	Description
`scope.id`	String	Yes	Your account ID.
`scope.type`	Enum	Yes	The scope type (ACCOUNT).
`definition.name`	String	Yes	The name of the workflow definition to run.
`workflowInputs`	Array	No	Optional key-value pairs to pass as inputs to the workflow.
`options.logLevel`	Enum	No	Controls logging during execution. Values: `NONE` (default), `INFO`, `DEBUG`.

logLevel option

The logLevel option controls the amount of logging information generated during workflow execution.

Available values:

NONE (default): No log outputs will be generated.
INFO: Outputs step level information.
DEBUG: Adds attribute to the step started logs with all the action step inputs.

Example

Use the Query Builder to create and edit a workflow. See NerdGraph API explorer.

mutation {
  workflowAutomationStartWorkflowRun(
    definition: { name: "json-parsing" }
    workflowInputs: [
      { key: "checkOperational", value: "false" }
      { key: "checkNonOperational", value: "true" }
    ]
    scope: { id: "11933347" }
    idempotencyKey: "45e65924-5316-479c-a977-f6adfa17e07a"
    options: { logLevel: INFO }
  ) {
    runId
  }
}

Response

The mutation returns:

runId: The unique identifier for the workflow run. Use this ID with WorkflowRunInfo, SignalWorkflowRun, or StopWorkflowRun APIs.

Important

Parameters.css-21sua1{background:none;border:none;width:0;padding:0;}

logLevel option

Example

Response

Parameters