Batch Files Download API

Description

This method lets you download translated files for one or more documents as a single ZIP archive.
The files are the translations for the specified target language.

If you need to download files for other purposes or using different filters, see the other resources/files APIs in this section.

URL

CODE

(POST) /resources/files/download/zip

PARAMETERS

The body must contain a JSON object.

A typical payload may look as follows:

CODE

{
  "scope": { "projectId": 123 },
  "locale": "fr-FR",
  "dids": [1001, 1002, 1003]
}

Another example, downloading all documents in the scope:

CODE

{
  "scope": { "projectId": 123 },
  "locale": "fr-FR"
}

Body properties

Parameter	Description	Required
scope	Scope object for the project.	Mandatory
locale	Target language locale. The translated files for this language will be downloaded.	Mandatory
dids	Array of document IDs (1–50 distinct integers). If omitted, retrieves files for all documents in scope (capped at 50).	Optional

Validation

locale is required and must be available in the scope.
If dids is provided, it must contain between 1 and 50 distinct integer document IDs.
All document IDs in dids must be accessible within the project scope.

RESULTS

The API returns an HTTP response with a ZIP file containing all requested translated files.

Filename format:

CODE

translations-{locale}-{yyyy-MM-dd_HH-mm-ss}.zip

If no files could be retrieved, an error is returned with the list of failed document IDs.

ERROR RESPONSES

Error	Description
`No file management available.`	User does not have file management access.
`Locale not available in scope.`	The specified locale is not valid for the project.
`Document {did} is not accessible.`	A document ID in `dids` is not accessible to the user.
`No documents found in scope.`	No documents were found in the specified scope.
`No files could be retrieved...`	Files could not be generated for any of the specified documents.