v1

latestOpenAPI 3.0.0Apache-2.02026-07-172384109.4 KB

reset a workflow

post/api/v1/workflow/reset

Request body

workflowIdstring required

workflowRunIdstring

resetType'HISTORY_EVENT_ID' | 'BEGINNING' | 'HISTORY_EVENT_TIME' | 'STATE_ID' | 'STATE_EXECUTION_ID' required

historyEventIdinteger

reasonstring

historyEventTimestring

stateIdstring

stateExecutionIdstring

skipSignalReapplyboolean

skipUpdateReapplyboolean

Example request

{
  "reason": "reason",
  "historyEventId": 0,
  "historyEventTime": "historyEventTime",
  "stateId": "stateId",
  "resetType": null,
  "skipSignalReapply": true,
  "workflowRunId": "workflowRunId",
  "workflowId": "workflowId",
  "skipUpdateReapply": true,
  "stateExecutionId": "stateExecutionId"
}

Response

successful operation

workflowRunIdstring required

Example response

{
  "workflowRunId": "workflowRunId"
}