In addition to API specific query parameters, ECE REST API define query parameters that are applicable to sets of APIs and are not closely related to the function of any API. Such parameters are referred to as "common query parameters" or simply "common parameters" in this documentation. Common parameters always start with '$' (dollar sign) symbol.
This page describes all the common query parameters that may appear in ECE REST APIs. While this is a comprehensive list of common parameters that are currently in use, each API may choose from below list which parameters to support.
All common query parameters are optional query parameters unless stated otherwise in a specific API documentation.
| Name | Description | Default value | Allowed Values |
|---|---|---|---|
$pagenum | Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize. | 1 | A positive integer |
$pagesize | Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum. | 25 | An integer between 1 and 75 |
$rangestart | Range parameter that specifies the starting index of the range of results to be returned. Used in conjunction with $rangesize. | 1 | A positive integer |
$rangesize | Range parameter that specifies the number (range) of results to be returned. Used in conjunction with $rangestart. | 25 | An integer between 1 and 75 |
$sort | Indicates the resource attribute name on which the results must be sorted. Only a single attribute name is allowed; comma separated values are not supported. | N/A | Each API that supports sorting, has its own set of allowed values |
$order | Indicates the sorting order. Must be accompanied by $sort. | 'asc' | 'asc' and 'desc' |
$lang | Mostly used in Authoring APIs to specify the language of requested Authoring resource, like article, folder, topic etc. | Default user language | Supported values of '$lang' |
$level | If the requested resource represents a hierarchical structure (e.g., folders), $level may be used to indicate the depth of hierarchy (starting from root node) up to which the results should be returned. | 0 |
|
$count | If this parameter is provided, only the total number of items qualifying the request will be returned, along with the link to the first page of the items. The actual items will not be returned. | 'N/A' | 'yes' |
$attribute | A comma separated list of attribute names to be returned in resource representation in addition to summary attributes. | N/A |
|
NOTE: Pagination and Range parameters cannot be used together in the same request and will result in 400 - Bad Request server response.
