...
To see the use of the REST API in action, a developer may have a look on the way translate5 JS-GUI frontend uses the REST API through tools like Firebug. This way it is easy for a programmer, to understand the way it works and to see, which values are used for which resources in which situations.
API backwards compatibility over different application versions
| 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. |
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.
...