Deliveries

Deliveries are always related to a translationTask. Each translationTask has one delivery for each accepted/delivered target language.

Endpoints

Method URI
GET /rest/api/translationDeliveries/{delivery_id}
PATCH /rest/api/translationDeliveries/{delivery_id}

Default Schema

{
  "id": "t6Ar4pHtDTPrk9",
  "state": "NEW",
  "target": "en-GB",
  "targetDocumentIds": [
    "5c0558e75da1ea000878e266"
  ],
  "translationTaskId": "ZMyzj4FhSWTZEjw"
}

Properties

Property Writeable Value
id readonly The id that identifies the delivery.
target readonly The target language as BCP-47 code.
state readonly The state of a delivery. The state can be:
NEW
A delivery is created.
IN_REVIEW
The delivery is under review.
DELIVERED
The delivery is available and can be downloaded.
postEditing Flag indication if this is a post editing delivery. Only available if true
translationTaskId readonly The unique id of the TranslationTask the delivery is associated with.
targetDocumentIds readonly The id's of the target documents of the translationTask are listed here.

Description of Endpoints

GET  /rest/api/translationDeliveries/{delivery_id}

Get a delivery.

Example Request:

GET /rest/api/deliveries/t6Ar4pHtDTPrk9 HTTP/1.1

Example Response:

{
  "id": "t6Ar4pHtDTPrk9",
  "state": "NEW",
  "target": "en-GB",
  "targetDocumentIds": [],
  "translationTaskId": "ZMyzj4FhSWTZEjw"
}

PATCH  /rest/api/translationDeliveries/{delivery_id}

Change an existing delivery.

Example Request:

PATCH /rest/api/translationDeliveries/ZMyzj4FhSWTZEjw HTTP/1.1

{
  "postEditing": true
}

Example Response:

{
  "id": "t6Ar4pHtDTPrk9",
  "state": "DELIVERED",
  "target": "en-GB",
  "postEditing": true,
  "targetDocumentIds": [],
  "translationTaskId": "ZMyzj4FhSWTZEjw"
}