LIlilt
Jobs

Archive a Job

Changed on

Set job to archived, unassign all linguists and archive all projects and documents inside the job.

It will return the archived job.

Example CURL command:

curl -X POST 'https://api.lilt.com/v2/jobs/{id}/archive?key=API_KEY'
post/v2/jobs/{jobId}/archive

Request

  • Base URL
    https://api.lilt.com
  • URL
    https://api.lilt.com/v2/jobs/{jobId}/archive
  • Auth
    HTTP basic

Path parameters

jobIdinteger required

A job id.

Response

A job object.

namestring

A name for the job.

creationStatusstring

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

deliveredAtstring date-time
statusstring

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

duestring date-time

An ISO string date.

idinteger

An id for the job.

isProcessinginteger

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

Example response

{
  "name": "My New Job",
  "creationStatus": "COMPLETE",
  "deliveredAt": "2021-06-03T13:43:00Z",
  "status": "active",
  "due": "2021-06-03T13:43:00Z",
  "id": 241,
  "stats": {
    "projects": [
      {
        "srcLang": "en",
        "srcLocale": "US",
        "trgLang": "fr",
        "trgLocale": "CA",
        "name": "My new project",
        "due": "2021-10-03T13:43:00.000Z",
        "state": "inProgress",
        "numSourceTokens": 2134,
        "createdAt": "2021-04-01T13:43:00.000Z",
        "updatedAt": "2021-06-03T13:43:00.000Z",
        "memoryId": 2134,
        "workflowStatus": "READY_TO_START",
        "workflowName": "Translate > Review > Analyst Review"
      }
    ],
    "uniqueLanguagePairs": 1,
    "uniqueLinguists": 1,
    "workflowStatus": "READY_TO_START"
  },
  "domains": [
    {
      "id": 12,
      "name": "Marketing"
    }
  ]
}

Changes

  • 99b66cc7808dRevision changes
    • breaking

      added the new path request parameter jobId

    • info

      api operation id archiveJob was added

    • info

      added the non-success response with the status

    • info

      added the success response with the status