Retrieve a Project

curl --request GET \
  --url 'https://api.lilt.com/v2/projects?key='

[
  {
    "id": 448,
    "memory_id": 1234,
    "job_id": 1234,
    "srclang": "en",
    "trglang": "fr",
    "srclocale": "US",
    "trglocale": "FR",
    "name": "My New Project",
    "state": "backlog",
    "due_date": 1489147692,
    "archived": false,
    "metadata": {
      "connectorType": "github",
      "notes": "example metadata"
    },
    "sample_review_percentage": 20,
    "created_at": 1489147692,
    "updated_at": 1489147692,
    "workflowStatus": "READY_TO_START",
    "document": [
      {
        "id": 46530,
        "project_id": 287,
        "srclang": "en",
        "trglang": "de",
        "name": "Introduction.xliff",
        "import_in_progress": false,
        "import_succeeded": false,
        "import_error_message": "Could not parse XML.",
        "export_in_progress": false,
        "export_succeeded": false,
        "export_error_message": "Could not parse XML.",
        "is_pretranslating": false,
        "status": {
          "pretranslation": "idle"
        },
        "translator_email": "[email protected]",
        "reviewer_email": "[email protected]",
        "customer_reviewer_email": "[email protected]",
        "created_at": 1489147692,
        "updated_at": 1489147692,
        "is_review_complete": true
      }
    ]
  }
]

Projects

Retrieve a Project

Retrieves one or more projects, including the documents associated with each project. Retrieving a project is the most efficient way to retrieve a single project, multiple projects or a list of all available projects.

To retrieve a specific project, specify the id request parameter or you can retrieve multiple projects by adding comma (,) between ids eg. ?id=1234,5678. To retrieve all projects, omit the id request parameter. To limit the retrieved projects to those with a particular source language or target language, specify the corresponding ISO 639-1 language codes in the srclang and trglang request parameters, respectively.

GET

projects

Retrieve a Project

curl --request GET \
  --url 'https://api.lilt.com/v2/projects?key='

[
  {
    "id": 448,
    "memory_id": 1234,
    "job_id": 1234,
    "srclang": "en",
    "trglang": "fr",
    "srclocale": "US",
    "trglocale": "FR",
    "name": "My New Project",
    "state": "backlog",
    "due_date": 1489147692,
    "archived": false,
    "metadata": {
      "connectorType": "github",
      "notes": "example metadata"
    },
    "sample_review_percentage": 20,
    "created_at": 1489147692,
    "updated_at": 1489147692,
    "workflowStatus": "READY_TO_START",
    "document": [
      {
        "id": 46530,
        "project_id": 287,
        "srclang": "en",
        "trglang": "de",
        "name": "Introduction.xliff",
        "import_in_progress": false,
        "import_succeeded": false,
        "import_error_message": "Could not parse XML.",
        "export_in_progress": false,
        "export_succeeded": false,
        "export_error_message": "Could not parse XML.",
        "is_pretranslating": false,
        "status": {
          "pretranslation": "idle"
        },
        "translator_email": "[email protected]",
        "reviewer_email": "[email protected]",
        "customer_reviewer_email": "[email protected]",
        "created_at": 1489147692,
        "updated_at": 1489147692,
        "is_review_complete": true
      }
    ]
  }
]

Authorizations

key

string

query

required

Query Parameters

integer

A unique Project identifier. It can be a single id or multiple ids separated by a comma

srclang

string

An ISO 639-1 language code.

trglang

string

An ISO 639-1 language code.

from_time

integer

Unix time stamp (epoch, in seconds) of Projects with created_at greater than or equal to the value.

to_time

integer

Unix time stamp (epoch, in seconds) of Projects with created_at less than the value.

state

string

A project state (backlog, inProgress, inReview, inQA, done).

archived

boolean

A flag that toggles whether to include archived projects in the response (the default is true).

connector_id

integer

A unique Connector identifier.

Response

A list of Project objects.

integer

A unique number identifying the Project.

Example:

448

memory_id

integer

A unique number identifying the associated Memory.

Example:

1234

job_id

integer

A unique number identifying the associated Job.

Example:

1234

srclang

string

An ISO 639-1 language identifier.

Example:

"en"

trglang

string

An ISO 639-1 language identifier.

Example:

"fr"

srclocale

string

A locale identifier, supported for srclang.

Example:

"US"

trglocale

string

A locale identifier, supported for trglang.

Example:

"FR"

name

string

A name for the project.

Example:

"My New Project"

state

string

The project's state. The possible states are backlog, inProgress, inReview, inQA, and done.

Example:

"backlog"

due_date

integer

The due date. Measured in seconds since the Unix epoch.

Example:

1489147692

archived

boolean

The archived state of the Project.

Example:

false

metadata

object

A JSON object of key/value string pairs. Stores custom project information.

Example:

{
  "connectorType": "github",
  "notes": "example metadata"
}

sample_review_percentage

integer

The project's sample review percentage.

Example:

20

created_at

integer

Time at which the object was created. Measured in seconds since the Unix epoch.

Example:

1489147692

updated_at

integer

Time at which the object was created. Measured in seconds since the Unix epoch.

Example:

1489147692

workflowStatus

enum<string>

The status of the Workflow for the current project. This may not be present for all project endpoints even with workflows enabled.

Available options:

READY_TO_START,

IN_PROGRESS,

DONE

Example:

"READY_TO_START"

document

object[]

A list of Documents.

Show child attributes

document.id

integer

A unique number identifying the Document.

Example:

46530

document.project_id

integer

A unique number identifying the Project.

Example:

287

document.srclang

string

An ISO 639-1 language identifier.

Example:

"en"

document.trglang

string

An ISO 639-1 language identifier.

Example:

"de"

document.name

string

The document name.

Example:

"Introduction.xliff"

document.import_in_progress

boolean

True if the document is currently being imported

Example:

false

document.import_succeeded

boolean

True if the import process succeeded.

Example:

false

document.import_error_message

string

Error message if import_succeeded=false

Example:

"Could not parse XML."

document.export_in_progress

boolean

True if the document is currently being exported for download

Example:

false

document.export_succeeded

boolean

True if the export process succeeded.

Example:

false

document.export_error_message

string

Error message if export_succeeded=false

Example:

"Could not parse XML."

document.is_pretranslating

boolean

True if the document is currently being pretranslated.

Example:

false

document.status

object

A list of translations for the query term.

Show child attributes

document.status.pretranslation

enum<string>

Available options:

idle,

pending,

running

Example:

"idle"

Example:

{ "pretranslation": "idle" }

document.translator_email

string

The email of the assigned translator.

Example:

"[email protected]"

document.reviewer_email

string

The email of the assigned reviewer.

Example:

"[email protected]"

document.customer_reviewer_email

string

The email of the assigned customer reviewer. Only present if the project was request by id.

Example:

"[email protected]"

document.created_at

integer

Time at which the object was created. Measured in seconds since the Unix epoch.

Example:

1489147692

document.updated_at

integer

Time at which the object was created. Measured in seconds since the Unix epoch.

Example:

1489147692

document.is_review_complete

boolean

Document review status.

Example:

true

Download a Job Create a Project

⌘I

Docs

API Reference

Retrieve a Project

Authorizations

Query Parameters

Response