v2

latestOpenAPI 3.0.02026-08-07103189636.5 KB
Files

Download all translations of file

Download a ZIP archive with all translations for the requested file.

Unlike the "Download translated file" endpoint, you get a ZIP archive with all translations of a specific file.

It is important to check the HTTP response status code. If Smartling finds and returns the file normally, you will receive a 200 SUCCESS response. If you receive any other response status code than 200, the requested files will not be part of the response.

When you upload a UTF-16 character encoded file, then /file/get requests for that file will have a character encoding of UTF-16. All other uploaded files will be returned with a character encoding of UTF-8.

You can always use the content-type header in the response of a file/get request to determine the character encoding.

get/files-api/v2/projects/{projectId}/locales/all/file/zip

Path parameters

projectIdstring required

A unique project identifier. This can be found in the Smartling Dashboard under Account Settings > API.

Query parameters

fileUristring required

Smartling value that uniquely identifies a file in Smartling

retrievalType'pending' | 'published' | 'pseudo' | 'contextMatchingInstrumented'

Determines the desired format for the download. Applies to translated files only.

retrievalTypeDescription
pendingSmartling returns any translations (including non-published translations).
publishedSmartling returns only published/pre-published translations.
pseudoSmartling returns a modified version of the original text with certain characters transformed, and the text expanded. For example, the uploaded string "This is a sample string", will return as "Thís ís á sámplé str~íñg". Pseudo translations enable you to test how a longer string integrates into your application.
contextMatchingInstrumentedSmartling returns a modified version of the original file with strings wrapped in a specific set of Unicode symbols that can later be recognized and matched by the Chrome Context Capture Extension.
includeOriginalStringsboolean

Specifies whether Smartling will return the original string or an empty string where no translation is available. This parameter is only supported for ANDROID, ARB, GETTEXT, IDML, IOS, JAVA Properties, JSON, QT, STRINGSDICT, XLIFF, XML, and YAML files. If unset, the default is <code>true</code>.

ValueDescription
trueIf there is no translation, Smartling returns the original string.
falseIf there is no translation, Smartling returns an empty string.
zipFileNamestring

Name for the downloaded zip file. If unset, the default is translations.zip

Response

OK