Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

token

The session token obtained when connecting.

filter

An optional JSON string. If omitted this the method enumerates all translated files in all target languages.

 

Find status for a specific target language

{ "targetLocale": "es" }

If you do not specify the language the result will return one record per project target language and per file.

 

Find status for all files matching a regular expression:

{ "patterns": { "fpath": "\\.docx?" } }

Note: "\" must be escaped in JSON using "\\".

{ "patterns": { "fpath": "(\\.docx?)|(^marketing\\\\)" } }
Note: Use | and parenthesis to match any of multiple patterns.

 

Find status for a list of specific files:

{ "filePaths": [ 
   { "Item1": "", "Item2": "myfile.docx" },
   { "Item1": "", "Item2": "subfolder\\myfile2.html" }  
] }

This retrieves the status of two files (“Item2”) by their name. “Item1” must be set to an empty string, always.

 

More filters

You can combine the different filter properties into a single JSON. There are many more filter options and these are described in the online documentation.

 

skip

Optional number, default is 0. Used for pagination. The files to skip.

count

Optional number, default is 100. Used for pagination and indicates the total number of files to return from this call. Make sure to specify a limit corresponding to your page size (e.g. 100).

...