Versions Compared

Key

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

Work in progress. The APIs in this section will be available early May 2024.

This section details API methods designed for reading and managing project document workflows.

...

These methods are specifically useful (but not limited) to efficiently integrate Content Management Systems with Wordbee Translator. Read our primer: Content CMS Integration - Quick Start

Understanding Workflows

A workflow is essentially the sequence of tasks involved in translating content from one language to another. This process typically includes translation and revision stages, along with a variety of settings to customize each step to suit specific project needs.

...

.

  • A document is a file uploaded to a project. It is uniquely identified by the “Document ID” (“did”).

  • A document is to be translated into 1 or more target languages (“trg”)

  • A workflow denotes the work to be done to translate a document into a target language. This is why most API methods in this section ask you for the project ID (“pid”), the document ID (“did”) and the target language (“trg”).
    A workflow within a project is uniquely identified by pairing “Document ID” and “trg“ (Target language).

  • A Codyt project workflow is always for a single file, while a Standard project workflow can comprise any number of files. This is because Standard jobs can include more than one file.

Limitations

  • The workflow API currently supports both Standard (from Dec 2024) and Codyt projects exclusively, with potential future expansion to Standard projects. Functional focus is on the integration with content management system.

  • With Standard projects:

    • Pivot workflows are not supported for CMS translations.

Documentation

Child pages (Children Display)
depth2
allChildrentrue
style
sortAndReverse
first0

...