--- title: "Update job status" method: PATCH path: "/jobs/{jobId}/status" tags: ["Manage Jobs"] --- # Update job status `PATCH /jobs/{jobId}/status` ## Request - Base URL: `/` (relative, and the document was published on a file host, not at the API’s origin) - URL: `/jobs/{jobId}/status` - Auth: one of: - API key in query parameter `access_token` - HTTP bearer Update job status using provided action ## Path parameters - `jobId` string, required ## Request body - JobStatus: The runtime status of a job contains information about the job's execution. - `desiredAction` 'START' | 'CANCEL' | 'RESUME': Description of possible actions: - START (Request to start the job execution. Only applicable for jobs which do not start automatically, because they're in state NOT_READY. See description of "state".) - CANCEL (Request to cancel the job execution. This will stop the execution of all tasks of the job. Later the job can be resumed using the RESUME action.) - RESUME (Only applicable to jobs in states CANCELLED or FAILED and being "resumable" - See: state FAILED. Requests to start the execution again. The system will try to continue the execution from the point at which it previously stopped.) - `state` 'NOT_READY' | 'SUBMITTED' | 'PENDING' | 'RUNNING' | 'CANCELLING' | 'CANCELLED' | 'FAILED' | 'RESUMING' | 'SUCCEEDED': Description of possible states: - NOT_READY (The job is not ready to be started yet as not all pre-conditions are met. E.g. that could be the input data was not provided by the user yet.) - SUBMITTED (The job is ready for execution, but was not started yet.) - PENDING (The system is trying to start the job, but it is still waiting for free execution resources.) - RUNNING (The job execution is currently in progress.) - CANCELLING (The job got the signal that it should be cancelled and is currently in the progress of cancelling all its internal steps and performing the clean up work.) - CANCELLED (Terminal state. The job was cancelled. That could be done by the request of the job owner, or because the system had to cancel the job. A job can be resumed if its "resumable" flag is true. See: desiredAction: RESUME) - FAILED (Terminal state. The job failed, because one of its internal steps failed. A job can be resumed if its "resumable" flag is true. See: desiredAction: RESUME) - RESUMING (The job got the signal to resume execution after it was previously cancelled or has failed. The job currently is preparing to start the execution again.) - SUCCEEDED (The job is completed. All its work has been done and all outputs are ready.) - `lastUpdatedAt` integer: A timestamp in milliseconds of when the job's status was updated the last time. - `startedAt` integer: A timestamp in milliseconds of when the job was started. - `estimatedProgress` number, float: An estimation of the progress of the job. This is a value between 0 .. 1 where 0 means 0% and 1 means 100%. - `estimatedEndTime` integer: A timestamp in milliseconds of when the job most probably will complete its execution. This is a rough estimation and the actual value could differ. ## Response `202` The Job's runtime status - JobStatus: The runtime status of a job contains information about the job's execution. - `desiredAction` 'START' | 'CANCEL' | 'RESUME': Description of possible actions: - START (Request to start the job execution. Only applicable for jobs which do not start automatically, because they're in state NOT_READY. See description of "state".) - CANCEL (Request to cancel the job execution. This will stop the execution of all tasks of the job. Later the job can be resumed using the RESUME action.) - RESUME (Only applicable to jobs in states CANCELLED or FAILED and being "resumable" - See: state FAILED. Requests to start the execution again. The system will try to continue the execution from the point at which it previously stopped.) - `state` 'NOT_READY' | 'SUBMITTED' | 'PENDING' | 'RUNNING' | 'CANCELLING' | 'CANCELLED' | 'FAILED' | 'RESUMING' | 'SUCCEEDED': Description of possible states: - NOT_READY (The job is not ready to be started yet as not all pre-conditions are met. E.g. that could be the input data was not provided by the user yet.) - SUBMITTED (The job is ready for execution, but was not started yet.) - PENDING (The system is trying to start the job, but it is still waiting for free execution resources.) - RUNNING (The job execution is currently in progress.) - CANCELLING (The job got the signal that it should be cancelled and is currently in the progress of cancelling all its internal steps and performing the clean up work.) - CANCELLED (Terminal state. The job was cancelled. That could be done by the request of the job owner, or because the system had to cancel the job. A job can be resumed if its "resumable" flag is true. See: desiredAction: RESUME) - FAILED (Terminal state. The job failed, because one of its internal steps failed. A job can be resumed if its "resumable" flag is true. See: desiredAction: RESUME) - RESUMING (The job got the signal to resume execution after it was previously cancelled or has failed. The job currently is preparing to start the execution again.) - SUCCEEDED (The job is completed. All its work has been done and all outputs are ready.) - `lastUpdatedAt` integer: A timestamp in milliseconds of when the job's status was updated the last time. - `startedAt` integer: A timestamp in milliseconds of when the job was started. - `estimatedProgress` number, float: An estimation of the progress of the job. This is a value between 0 .. 1 where 0 means 0% and 1 means 100%. - `estimatedEndTime` integer: A timestamp in milliseconds of when the job most probably will complete its execution. This is a rough estimation and the actual value could differ. ## Other responses - `400`: Malformed or Bad Request. - `404`: Not found. --- [API](https://skmtc.dev/here/apis/here-xyz-job-service.md) - [All operations](https://skmtc.dev/here/apis/here-xyz-job-service/llms.txt) - [OpenAPI document](https://skmtc.dev/here/apis/here-xyz-job-service/revisions/88b5563c7e8b?raw)