JSON API

Reading Data

All resources can be reached by specifying their path in the data model. The format for this is:

/api/PROJECT_NAME/BRANCH/LOCALE/path/to/Messages.properties

Requesting /api/Jabylon/master/de for example produces this output:

{"percentComplete":100,"name":"de","locale":"de","propertyCount":126}

This is the content of the de locale in branch master of project Jabylon. To get to a specific property file, append the file path to the URI. Since the template language usually does not have a defined locale itself, use template as the locale if you are interested in the template properties.

By default, a query on a model object will only serialize one depth level of the given object. To obtain more data at once, the query parameter depth can be used (just like in the Jenkins API).

This query returns the first level properties for this file (statistic, locale, location,…) as well as the properties of its child objects (the actual key/value pairs and review information). Since it is sometimes easier to just download the properties file then parsing a JSON output, the query parameter type=file will instead allow you to query the properties file directly. If you use the ?type=file parameter on a version, locale or folder the contents will be downloaded as a zip archive.

Uploading Property Files

You can also upload new property files through the API. To do so, execute a PUT request on the path where you want the properties file to be stored:

/api/testproject/master/en_EN/some/path/Messages.properties

If the resource already exists, it will be replaced with the uploaded one, otherwise the resource will be created. However, this will only create property files. Project, branch and version cannot be created by a PUT (yet) and need to exist prior to the call.