NInimbleway
Jobs

Update Job

patch/v2/jobs/{job_id}

Request

  • Base URL
    https://sdk.nimbleway.com
  • URL
    https://sdk.nimbleway.com/v2/jobs/{job_id}
  • Auth
    HTTP bearer

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

No recorded changes to this operation across all 2 revisions of this API.