Body Parameters
The following body parameters are used throughout the API:
| Body Parameters |
||||
| offset |
If using paging, the index from which the singular resources are returned. |
Integer |
N |
0 |
| limit |
If using paging, number of results returned in this page. |
Integer |
N |
10 |
| orderBy |
Sorts the response by the specified field name and sort order. asc ? ascending order desc ? descending order Format: fieldName[":"("asc"/"desc")] |
String |
N |
autoMenuLevels.index:asc |
| searchCriteria |
Search criteria to filter results based on field value |
String, max 2000 chars |
N |
where equals(active,1) |
| include |
Objects included in response |
String, max 2000 chars |
N |
locations |
| languages |
If specified, limits translated strings returned |
String, max 2000 chars |
N |
"en-US, es-SS,lt-LT" |