Sign in
workflowRuns

Update One workflowRun

patch/workflowRuns/{id}

Request

  • Base URL: https://twenty.mardu.systems/rest
  • URL: https://twenty.mardu.systems/rest/workflowRuns/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Object id.

Query parameters

depth0 | 1

Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations

Request body

namestring

Name of the workflow run

enqueuedAtstring date-time

Workflow run enqueued at

startedAtstring date-time

Workflow run started at

endedAtstring date-time

Workflow run ended at

status'NOT_STARTED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'ENQUEUED' | 'STOPPING' | 'STOPPED'

Workflow run status

stateobject

State of the workflow run

contextobject

Context of the workflow run

outputobject

Output of the workflow run

positionnumber

Workflow run position

workflowVersionIdstring uuid
workflowIdstring uuid

Example request

{
  "name": "Workflow Run name",
  "status": "NOT_STARTED",
  "state": {},
  "workflowVersion": null,
  "workflow": null,
  "favorites": null,
  "timelineActivities": null
}

Response

Successful operation

Changes

No recorded changes to this operation across all 1 revision of this API.