Skip to main content
PUT
Update a Job

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

jobId
integer
required

A job id.

Body

application/json

The Job resource to update.

name
string

A name for the Job.

Example:

"My new Job"

due
string<date-time>

An ISO string date.

Example:

"2021-10-05T14:48:00.000Z"

isProcessing
enum<string>

The processing status of the job. Provide one of the following integers to indicate the status.

Ok = 0 Started = 1 ExportError = -2

Available options:
0,
1,
-2
Example:

"ExportError"

processingErrorMsg
string

The processing error message.

Example:

"Authentication failed. Check your Contentful API Key."

Response

A job object.

A Job is a collection of multiple Projects. Each project is specific to a language pair, and is associated with exactly one Memory for that language pair. The Memory association cannot be changed after the Project is created.

name
string

A name for the job.

Example:

"My New Job"

creationStatus
string

Status of job creation process that includes PENDING, COMPLETE, and FAILED.

Example:

"COMPLETE"

deliveredAt
string<date-time>
Example:

"2021-06-03T13:43:00Z"

status
string

Current status of job that includes archived, delivered, and active.

Example:

"active"

due
string<date-time>

An ISO string date.

Example:

"2021-06-03T13:43:00Z"

id
integer

An id for the job.

Example:

241

isProcessing
integer

Values include 1 while in progress, 0 when idle and -2 when processing failed.

Example:

0

stats
object

A job stats shows an overview of job's statistical data including total number of exact words, fuzzy words, language pairs, projects, etc.

domains
object[]

Domains associated with this Job. Returned on the GET /v2/jobs/{jobId} response so callers can drive domain-specific behaviour (e.g. quality thresholds) without falling back to BigQuery.