Start workflow run
start_workflowStart a run of one workflow from an Idea, a planned existing Batch whose Work has not begun, or a new batch plan (name and ordered works, as in create_batch_plan). A workflow that starts at Delivery takes none of them: the run begins on its Start to Delivery connection, and create_delivery or assign_batch_to_delivery completes it. With batch, the Batch is planned and the run started in one call, its review step is skipped, and edgeId can name the Batch stage route; a retry while that run is open returns the same run. A Batch run governs that Batch's Work queue until it is ready. The run is pinned to the workflow's current revision and returns its current step. Each instruction body is sent once per run; a document already sent earlier in the run comes back as a uri reference.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| batch | No | New Batch plan to create and start the run from. | |
| edgeId | No | Batch stage route to take when the run starts from a Batch. | |
| ideaId | No | Idea to start the run from. | |
| batchId | No | Planned Batch to start the run from. | |
| projectId | Yes | Id of the Project. | |
| workflowId | Yes | Id of the Workflow. |