projects/{pid}/workflows/{did}/status/{trg}
Returns detailed workflow information and status for a document and its specified target language.
Note: Workflows are unique to each target language, operating independently from one another.
URL
(GET) /api/projects/{pid}/workflows/{did}/status/{trg}
PARAMETERS
The URL parameters are:
pid | The project ID | int, Mandatory |
did | The document ID | int, Mandatory |
trg | The target language code | string, Mandatory |
RESULTS
The JSON result includes the workflow details. Example:
{
"branch": "fr",
"status": 4,
"statusTitle": "Work delivered",
"statusDate": "2024-04-03T06:32:37.683Z",
"openJobs": 0,
"steps": 2,
"file": {
"exists": true,
"date": "2024-03-27T11:08:33.7731701Z",
"name": "file-002.htm",
"size": 96,
"encoding": "UTF-8"
}
}
The properties are:
branch | A project target locale. The branch locale is the language of the ultimate deliverable. | string |
status | The workflow status. See Workflow Status (Enumeration)
| int |
statusTitle | Name of status. | string |
statusDate | Date of current status. | datetime |
openJobs | Number of jobs that are unfinished. | int |
steps | In most cases this will be 1. The total number of source/target language combinations to go from the document source language to the branch language. Greater than 1 exclusively with workflows such as back-translation or parallel translation. | int |
file | Information about the translated file:
You are ready to pull the deliverable if the workflow status is 3 or 4 and the deliverable file exists. | object |
Copyright Wordbee - Buzzin' Outside the Box since 2008