Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Returns workflow information and status for a document and ALL its target languages.

Note: Each target languages has its own workflow, independent from each other.

URL

(GET) /api/projects/{pid}/workflows/{did}/status

PARAMETERS

The URL parameters are:

pid

The project ID

int, Mandatory

did

The document ID

int, Mandatory

RESULTS

The JSON result includes the workflow details for each branch language (aka target language).

In below example, we have a file to translate into Spanish and French. The details for the 2 workflows are contained in the array:

[
    {
        "branch": "es",
        "status": 3,
        "statusTitle": "Action required",
        "statusDate": "2024-03-27T10:29:35.183Z",
        "openJobs": 1,
        "steps": 1,
        "file": {
            "exists": true,
            "date": "2024-03-28T09:40:45.5804981Z",
            "name": "specialname.htm",
            "size": 96,
            "encoding": "UTF-8"
        }
    },
    {
        "branch": "fr",
        "status": 4,
        "statusTitle": "Work delivered",
        "statusDate": "2024-04-03T06:32:37.683Z",
        ...
    }
]

For a detailed explanation of the properties please refer to:

projects/{pid}/workflows/{did}/status/{trg}

  • No labels