Skip to main content
Proton v5

Change the run status

PUT 
/dataset-run/:datasetRunId/update-status

Sets the run status. The automation uses Running at the start, Passed at the end and Failed when something goes wrong.

  • Failed and Stopped close the open step with the same status.
  • Passed, Failed, Stopped and Cancelled are final: they trigger the batch end notice and, with Failed, the rerun on error, when configured.
  • Stopped does not accept another status afterwards (409). To actually stop a run, use PUT /dataset-run/{id}/stop.

Send the status name (status) or its id (idStatus); with both, the name wins. Use only the run statuses listed in status.

Along with Failed, the reason (reason) says why the run failed, without changing the status. Without a reason, the failure counts as technical. The final status also records the end, the duration and the end reason of the run (finishedAt, durationMs and endReason in GET /dataset-run/{id}). Sending the same final status again changes nothing: when the automation sends Failed with the business reason and the runner, at the end of the process, sends Failed again without a reason, the automation's end and reason are kept.

Permission: Runs: update.

Request​

Responses​

Status changed. The response has no body.