Jobs

Retrieve all Jobs

Changed on

Get all Jobs within a given offset and limit. You can retrieve jobs from your account using the above API.

Example CURL command:

curl -X GET 'https://api.lilt.com/v2/jobs?key=API_KEY&isArchived=false'
get/v2/jobs

Request

  • Base URL
    https://api.lilt.com
  • URL
    https://api.lilt.com/v2/jobs
  • Auth
    HTTP basic

Query parameters

isArchivedboolean

Retrieves all jobs that are archived.

isDeliveredboolean

Retrieves all jobs that are delivered.

offsetinteger

Return jobs starting at the offset row. If not given the default offset will be 0.

limitinteger

The maximum number of jobs to be returned. If not given the default limit will be 25.

Response

A list of Job objects.

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

    • info

      api operation id retrieveAllJobs was added

    • info

      added the new optional query request parameter isArchived

    • info

      added the new optional query request parameter isDelivered

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the non-success response with the status

    • info

      added the success response with the status