Versions Compared

Key

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

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

...

  • 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.

Current Scope

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.

...