jobs/offline/export (POST)

To add one or more files to an existing Codyt project.

Based on the project settings, the operation initiates translation workflows by saving files to the project, marking them online, conducting pre-translation and word count, and creating and assigning jobs.

URL

CODE

(POST) /api/jobs/offline/export

PARAMETERS

The request BODY contains a JSON object with these properties:

jobs	An array of jobs ids to export (job id starts with c if codyt s if standard)	string[], Mandatory
format	The output format. Must be one of these strings: Xliff : XLIFF format Word : Microsoft Word format. The document contains a table with the source texts and the translations. Excel : Microsoft Excel format. The document contains both source texts and translations.	string, Mandatory
includeComments	Boolean, default is false. If true then the document will include existing comments that are attached to the translation	bool, Optional
includeMatches	Boolean, default is false. If true, then the top memory hits are included with each segment in the document.	bool, Optional
includeTBMatches	Boolean, default is false. If true, then the top terminology hits are included with each segment in the document.	bool, Optional
generateTMX	Boolean, default is false. If true, then a TMX file (“TM.tmx“) is created and included in the exported ZIP archive. It contains the top memory hits of all the exported files. This option can be set independently of includeMatches	bool, Optional
generateTBX	Boolean, default is false. If true, a ZIP file (“Terms.zip“) is created and included in the exported ZIP archive. It contains the top terminology hits of all the exported files. This option can be set independently of includeTBMatches	bool, Optional
groupByProject	Boolean, default is false. If true, the exported jobs are grouped by project.	bool,Optional

RESULTS

The API method returns an Asynchronous operation result:

JS

{
  "trm": {
    "requestid":32230,
    "status":"Waiting",
    "statusText":"Waiting..."
  }
}

You can poll the status or use the callback parameter. When the operation is complete, the results are in the custom property

JSON

{
    "trm": {
        "requestid": 32230,
        "isbatch": false,
        "status": "Finished",
        "statusText": "Finished!"
    },
   "result": {
    "items": [
      {
        "k": "token",
        "v": {
          "token": "c8c885023ce244cd8cdb7c14fc31b136"
        }
      }
    ]
  },
  "custom": null
  }
}

The custom property is a JSON object:

filtetoken

The file token to download a ZIP archive with the exported XLIFF, Word or Excel files, the optional summary Excel and the optional TMX.

The exported files are grouped in folders by their source/target languages.

Usemedia/get/{token} to download the ZIP file.

string