Sign in
Jobs (public v2)

Update Job Public V2

patch/v2/jobs/{job_id}

Path parameters

job_idstring required

Request body

descriptionstring nullable

New description.

display_namestring nullable

New display name.

Response

Successful Response

created_atstring date-time nullable

When the job was created.

descriptionstring nullable

Free-text description of the job.

display_namestring nullable

Human-friendly job name shown in the UI.

extract_template_namestring nullable

Name of the extract template this job runs.

idstring required

Unique job identifier (job_<n>).

last_run_atstring date-time nullable

Timestamp of the most recent run.

last_run_status'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'TIMEOUT' | 'WARNING' nullable

Status of the most recent run.

namestring required

Job name.

updated_atstring date-time nullable

When the job was last updated.

Changes

Changed in 3 of the 55 revisions of this API.14

  • 22c2a22911462See the full diff
    • ○

      added the new optional request property //

      new-optional-request-property

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 104 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 623b3bec8d8711See the full diff
    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d4e4f170f4f41See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog