Versions Compared

Old Version 2

changes.mady.by.user Stephan Böhmig

Saved on

compared with

New Version Current

changes.mady.by.user Stephan Böhmig

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Returns detailed workflow information and status for a document and its specified target language.

Note: Each target languages has its own workflow, independent from each otherWorkflows are unique to each target language, operating independently from one another.

URL

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

...

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

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:

  • exists: Boolean. True if the translated file (deliverable) exists in the project

  • date: Date/time. Date of file

  • name: Name of file. Might be different from source file.

  • size: Size in bytes.

  • encoding: String. If applicable/known, indicates the encoding of the file. Example: UTF-8.

You are ready to pull the deliverable if the workflow status is 3 or 4 and the deliverable file exists.

object