Jobs

Close a job execution

Close a job execution as completed or failed.

Call this when an off-platform script finishes. Either status is final: re-sending the same status is a no-op, and changing it is rejected. Only executions opened by the start tool are accepted; the platform records every other execution's status itself.

Requires an API key with the write scope.

patch/api/v1/job-executions/{execution_id}

Request

  • Base URL: https://platform.labric.co
  • URL: https://platform.labric.co/api/v1/job-executions/{execution_id}
  • Auth: HTTP bearer

Path parameters

execution_idstring required

Request body

status'completed' | 'failed' required

How the run ended. Either status is final: the execution cannot change status afterwards.

Response

OK

job_execution_idstring uuid required

Pass this as job_execution_id to the write and upload-file tools.

job_idstring uuid required

ID of the job the execution belongs to.

job_namestring required

Name of the job the execution belongs to.

statusstring nullable required

The execution's current status.

started_atstring date-time nullable required

When the execution started.

completed_atstring date-time nullable required

When the execution ended, or null while it is still running.

Changes

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