Download Files (/v1/file/get)

This v1 API method is scheduled for deprecation October 1, 2017. Where possible, use File API v2

Downloads the requested file from Smartling.

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 file 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 return with a character encoding of UTF-8.

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

Parameters

apiKey (required)

The API Key for your account. Available in the Smartling dashboard at Project Settings>API.

projectId (required)

The unique ID for your project. Available in the Smartling dashboard at Project Settings>API.

fileUri (required)

Value that uniquely identifies the downloaded file.

locale (optional)

A locale identifier as specified in project setup. If no locale is specified, original content is returned. You can find the list of locales for your project [in the Smartling dashboard](https://dashboard.smartling.com/settings/api). For CSV files only: use the locale code "all" to download all available locales in a single file.

retrievalType (optional)

Determines the desired format for the download.

pending Smartling returns any translations (including non-published translations).
published Smartling returns only published/pre-published translations.
pseudo Smartling 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 "T~hís ~ís á s~ámpl~é str~íñg". Pseudo translations enable you to test how a longer string integrates into your application.
contextMatchingInstrumented Smartling 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.

includeOriginalStrings (optional)

Specifies whether Smartling will return the original string or an empty string where no translation is available. This parameter is supported for gettext, java properties, custom XML, Android XML, and JSON files only.

true If there is no translation, Smartling returns the original string.
false For Android XML files, Smartling completely removes untranslated elements from the file. For all other compatible file types, Smartling returns an empty string if there is no translation.
Returns

A translated file with the following response header:

Content-Disposition: attachment; filename="fname.ext"

The filename is based on the fileUri associated with the requested file. In most cases, the filename is exactly the fileUri provided. The only exception to this is with .pot gettext files. When a .pot file is specified as the fileUri, Smartling returns a .po file.

Examples