Jobs
Pause job
Pause an ongoing batch job
POST
Requires version 1.1.5 or later of the Archetype platform.
Overview
This endpoint pauses a job identified by its job ID. Per the job status lifecycle, a job in thePENDING, ADMITTED, or RUNNING state can transition to PAUSED. A paused job can later be
returned to PENDING with the Resume Job endpoint.
On success the endpoint returns the job ID, its new status, and the time at which it was paused.
Request
string
required
Job identifier. A TypeID-encoded identifier with the
job_ prefix.Response
On success, returns the paused job record.string
The identifier of the paused job (a TypeID-encoded
JobId).string
The job’s status after the transition:
PAUSED.string
The date and time at which the job was paused.