List (/v1/file/list)

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

Lists recently uploaded files. Returns a maximum of 500 files.

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.

locale (optional)

If not specified, the Smartling Files API will return a listing of the original files matching the specified criteria. When the locale is not specified, completedStringCount will be "0".

uriMask (optional)

Returns only files with a URI containing the given substring. Case is ignored. For example, the value .json will match strings.json and STRINGS.JSON but not json.strings

fileTypes (optional)

Identifiers: android, ios, gettext, html, javaProperties, yaml, xliff, xml, json, docx, pptx, xlsx, idml, qt, resx, plaintext, cvs. File types are combined using the logical "OR".

lastUploadedAfter (optional)

Return all files uploaded after the specified date. See Date Format for more details.

lastUploadedBefore (optional)

Return all files uploaded before the specified date. See Date Format for more details.

offset (optional)

For result set returns, the offset is a number indicating the distance from the beginning of the list; for example, for a result set of "50" files, you can set the offset at 10 to return files 10 - 50.

limit (optional)

For result set returns, limits the number of files returned; for example, for a result set of 50 files, a limit of "10" would return files 0 - 10.

conditions (optional)

An array of the following conditions: haveAtLeastOneUnapproved, haveAtLeastOneApproved, haveAtLeastOneTranslated, haveAllTranslated, haveAllApproved, haveAllUnapproved. Conditions are combined using the logical "OR".

orderBy (optional)

Sets the name of the parameter to order results by: fileUri, stringCount, wordCount, approvedStringCount, completedStringCount, lastUploaded and fileType. You can specify ascending or descending with each parameter by adding "_asc" or "_desc"; for example, "fileUri_desc". If you do not specify ascending or descending, the default is ascending.

Returns
{
    "fileCount": "[number]",
    "fileList" : [{
        "fileUri": "[/myproject/i18n/ui.properties]"
        "stringCount": "[number]",
        "wordCount": "[number]",
        "approvedStringCount": "[number]",
        "completedStringCount": "[number]",
        "lastUploaded": "[YYYY-MM-DDThh:mm:ss]",
        "fileType": "[fileType]" },
    { ... } ]
}

fileCount

The number of files that match your specified criteria.

fileUri

A unique identifier for the uploaded file.

stringCount

The number of strings in the uploaded file.

wordCount

The number of words in the uploaded file.

approvedStringCount

The number of strings in the uploaded file that are approved (available for translation).

completedStringCount

The number of published strings in the uploaded file.

lastUploaded

The time and date of the last upload: YYYY-MM-DDThh:mm:ss

fileType

The type of file: android, ios, gettext, javaProperties, xliff, yaml, etc

Examples