...
The data format is JSON. On PUT requests not all data fields must be given, only the fields with changed data are sufficient.
Currently the JSON can not be transferred as raw HTTP content, but must be put into a form variable named "data". In future plain JSON will be possible too!
Therefore the HTTP Header Content-Type must be: "application/x-www-form-urlencoded; charset=UTF-8". The form-data body should look like:
| Code Block | ||
|---|---|---|
| ||
// just upload the JSON as raw body {HERE-DATA-AS-JSON-URL-ENCODED} //EXCEPTION FOR FILE UPLOADS: //The JSON can not be transferred as raw HTTP content, but must be put into a form variable named "data". data = {HERE-DATA-AS-JSON-URL-ENCODED} |
...
| Note |
|---|
We try to keep a backwards compatibility of the existing API. If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog. Adding new fields to an entity is not considered as incompatible change. But if a field is being removed, renamed or the data format changes, this is considered as incompatible change. |
Each answer of the API contains a HTTP header field "X-Translate5-Version" which contains the current version of translate5.
Filtering
All GET calls without an ID provide a list of resources. With the GET Parameter “filter” this list can be filtered. In general all fields are filterable. Exceptions in single cases.
...