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

« Previous Version 2 Next »

Returns workflow information and status for a document and target language.

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

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)

  • 3: Work completed, all jobs done.

  • 4: Work was flagged for successful delivery

  • See link for other statuses.

int, Mandatory

statusTitle

statusDate

openJobs

steps

file

  • No labels