Update a Job

curl --request PUT \
  --url 'https://api.lilt.com/v2/jobs/{jobId}?key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My new Job",
  "dueDate": 123,
  "isProcessing": "ExportError",
  "processingErrorMsg": "Authentication failed. Check your Contentful API Key."
}
'

{
  "name": "My New Job",
  "creationStatus": "COMPLETE",
  "deliveredAt": "2021-06-03T13:43:00Z",
  "status": "active",
  "due": "2021-06-03T13:43:00Z",
  "id": 241,
  "isProcessing": 0,
  "stats": {
    "exactWords": 0,
    "fuzzyWords": 0,
    "newWords": 0,
    "numDeliveredProjects": 0,
    "numLanguagePairs": 0,
    "numProjects": 0,
    "percentReviewed": 0,
    "percentTranslated": 0,
    "projects": [
      {
        "id": 123,
        "srcLang": "en",
        "srcLocale": "US",
        "trgLang": "fr",
        "trgLocale": "CA",
        "name": "My new project",
        "due": "2021-10-03T13:43:00.000Z",
        "isComplete": false,
        "isArchived": false,
        "state": "inProgress",
        "numSourceTokens": 2134,
        "createdAt": "2021-04-01T13:43:00.000Z",
        "updatedAt": "2021-06-03T13:43:00.000Z",
        "isDeleted": false,
        "memoryId": 2134,
        "workflowStatus": "READY_TO_START",
        "workflowName": "Translate > Review > Analyst Review"
      }
    ],
    "sourceWords": 0,
    "uniqueLanguagePairs": 1,
    "uniqueLinguists": 1,
    "workflowStatus": "READY_TO_START"
  }
}

Jobs

Update a Job

Updates a job with the new job properties. To update a specific job, you will need the job id in the url path.

You can update job’s name and due date by passing the property and new value in the body.

Example CURL command:

curl -X PUT 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "test job",
  "due": "2022-05-05T10:56:44.985Z"
}'

PUT

jobs

{jobId}

Update a Job

curl --request PUT \
  --url 'https://api.lilt.com/v2/jobs/{jobId}?key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My new Job",
  "dueDate": 123,
  "isProcessing": "ExportError",
  "processingErrorMsg": "Authentication failed. Check your Contentful API Key."
}
'

{
  "name": "My New Job",
  "creationStatus": "COMPLETE",
  "deliveredAt": "2021-06-03T13:43:00Z",
  "status": "active",
  "due": "2021-06-03T13:43:00Z",
  "id": 241,
  "isProcessing": 0,
  "stats": {
    "exactWords": 0,
    "fuzzyWords": 0,
    "newWords": 0,
    "numDeliveredProjects": 0,
    "numLanguagePairs": 0,
    "numProjects": 0,
    "percentReviewed": 0,
    "percentTranslated": 0,
    "projects": [
      {
        "id": 123,
        "srcLang": "en",
        "srcLocale": "US",
        "trgLang": "fr",
        "trgLocale": "CA",
        "name": "My new project",
        "due": "2021-10-03T13:43:00.000Z",
        "isComplete": false,
        "isArchived": false,
        "state": "inProgress",
        "numSourceTokens": 2134,
        "createdAt": "2021-04-01T13:43:00.000Z",
        "updatedAt": "2021-06-03T13:43:00.000Z",
        "isDeleted": false,
        "memoryId": 2134,
        "workflowStatus": "READY_TO_START",
        "workflowName": "Translate > Review > Analyst Review"
      }
    ],
    "sourceWords": 0,
    "uniqueLanguagePairs": 1,
    "uniqueLinguists": 1,
    "workflowStatus": "READY_TO_START"
  }
}

Authorizations

key

string

query

required

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"

dueDate

integer

An ISO string date.

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"

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.

Show child attributes

stats.exactWords

integer

Total number of exact words.

Example:

0

stats.fuzzyWords

integer

Total number of fuzzy words.

Example:

0

stats.newWords

integer

Total number of fuzzy words.

Example:

0

stats.numDeliveredProjects

integer

Total number of delivered projects.

Example:

0

stats.numLanguagePairs

integer

Total number of delivered projects.

Example:

0

stats.numProjects

integer

Total number of projects.

Example:

0

stats.percentReviewed

integer

Overall percentage of documents reviewed.

Example:

0

stats.percentTranslated

integer

Overall percentage of documents translated.

Example:

0

stats.projects

object[]

Show child attributes

stats.projects.id

integer

An id for the project.

stats.projects.srcLang

string

Source language, an ISO 639-1 language identifier.

Example:

"en"

stats.projects.srcLocale

string

A locale identifier, supported for source language.

Example:

"US"

stats.projects.trgLang

string

Target language, an ISO 639-1 language identifier.

Example:

"fr"

stats.projects.trgLocale

string

A locale identifier, supported for target language.

Example:

"CA"

stats.projects.name

string

A name for the project.

Example:

"My new project"

stats.projects.due

string

An ISO date.

Example:

"2021-10-03T13:43:00.000Z"

stats.projects.isComplete

boolean

A state that checks project was completed.

Example:

false

stats.projects.isArchived

boolean

The archived state of the project.

Example:

false

stats.projects.state

string

Current state of the project. Example, backlog, inProgress, inReview, done.

Example:

"inProgress"

stats.projects.numSourceTokens

integer

Total number of source tokens.

Example:

2134

stats.projects.createdAt

string

Time at which the object was created.

Example:

"2021-04-01T13:43:00.000Z"

stats.projects.updatedAt

string

Time at which the object was updated.

Example:

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

stats.projects.isDeleted

boolean

A state that checks project was deleted.

Example:

false

stats.projects.memoryId

integer

A unique number identifying the associated Memory.

Example:

2134

stats.projects.workflowStatus

enum<string>

The status of the Workflow for the current project.

Available options:

READY_TO_START,

IN_PROGRESS,

DONE

Example:

"READY_TO_START"

stats.projects.workflowName

string

Human readable name of the workflow associated with the current project.

Example:

"Translate > Review > Analyst Review"

stats.sourceWords

integer

Total number of source words.

Example:

0

stats.uniqueLanguagePairs

integer

Number of unique language pairs.

Example:

1

stats.uniqueLinguists

integer

Number of unique linguists.

Example:

1

stats.workflowStatus

enum<string>

The status of the Workflow for the current job.

Available options:

READY_TO_START,

IN_PROGRESS,

DONE

Example:

"READY_TO_START"

Retrieve a Job Delete a Job

⌘I

Docs

API Reference

Update a Job

Authorizations

Path Parameters

Body

Response