Versions Compared

Key

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

...

file

Relative file path.

locale

The target language code.

uptodateBoolean. True if the file is translated and ready for download. You can now proceed with a download.

localename

The target language name.

segments

Total segments.

words

Total words.

folder

Folder name. Always an empty string.

status & statuststatusc

Detailed status information: status is a numeric value and statust statusc is a string.

"status""statuststatusc"Comments
1UptodateFile translated and ready to download. Same as when uptodate field is true.
4NewPass-through projects only. See PT - Translation Workflow
5SubmittingPass-through projects only.
6InProgressTranslation workflow in progress
7DoneTranslation finished but not yet downloadable.
8ErrorPass-through projects only.
10CancelledTranslation workflow cancelled.

sfdate

Source file date, as shown in the Beebox "in" directory.

sfdatemin

Minutes since the source file was saved to Beebox.

tfdate

Deliverable file date. The date when the deliverable (translated file) was created.

tdate

Minutes since the deliverable file date.

  
 Regular and CMS projects only:
readyToBuild

Boolean. True if deliverable is ready to be created physically because all text contents have been translated.Usually, the physical creation is done by a Beebox automatic operation (if enabled) but it can also be triggered through the API or the administrator UItranslation finished but not yet downloadable. Same as status = 7.

notReadyToBuildBoolean. True if the translated file is not ready because not all texts are yet translated or validatedtranslation is in progress. Same as status = 6.
  
 Pass-through projects only:
tms

Advanced workflow information. Provides additional error and workflow status information, including history of events: A JSON object with these properties:

  • error: Last workflow error text.
  • info: Last workflow info text.
  • pfdt: Date when preliminary file was last downloaded. If not null then a preliminary file is available for download.
  • Note: There are more undocumented properties. Ask Wordbee.

 

NAVIGATING RESULTS

Iterate the “items” node, an array with one record per translated file and target language.

...