Basics
Allowed HTTP verbs are GET, PATCH, POST and DELETE. Here are detailed descriptions of the call types:
- GET: Retrieving data from Severa
- PATCH: Updating existing data
- JSON Patch is the format used for updating data in the REST API (more information at: http://jsonpatch.com/).
- Only Replace is supported.
- POST: Creating new data in Severa
- DELETE: Removing data from Severa.
- Use with caution, as deleted data is permanently removed
- Response codes for calls are Success, Created and Bad request
Pagination
By default, 20 rows are retrieved for each GET call, with a maximum of 1000. The parameters are firstRow and rowCount. It is recommended to use in heavy calls.
Text search
The parameter textToSearch can be used for quick searches. For example, the GET/users call has a parameter that allows searching by user name, code, email, or keywords. For each route, the fields from which the search is performed are defined in the technical documentation.
Sorting
Defined in many GET all for routes as a query parameter. It supports providing multiple values. Example:
- ?sortings[0]
- [key]=lastUpdatedDateTime&sortings[0]
- [value]=Desc&sortings[1]
- [key]=createdDateTime&sortings[1]
- [value]=Asc
Changed since
Parameter for retrieving data from a specific date forward. This parameter allows you to fetch data that has been changed after the given date. For example, the GET/users call has a ChangedSince parameter that retrieves users who have been added or changed after this date (greater than or equal to).
Scopes
Currently, only SeveraAll is enabled, but scopes will be added as they are implemented.
Did you find it helpful? Yes No
Send feedback