Filtering API
Go Up to API Reference
Most of the ER/Studio Team Server APIs that provide a list of resources that allow you to filter resources by the first letter of the name, by search terms, and by pagination parameters:
| Item | Example | Description |
|---|---|---|
|
|
|
A letter by which to filter the list of resources. If specified in an API request, the response includes only resources with a |
|
|
|
A string by which to search in the properties of the target set of resources. If specified in an API request, the response includes only resources with properties that match the specified search terms. |
|
|
|
The maximum number of resources to return. |
|
|
|
A value that indicates where in the list to start, the first resource being You can also think of this field as the number of resources to skip at the beginning of the list. |
The fields used for filtering are included in the response, inside a special "metadata_" resource. This metadata resource contains the specified or default filtering fields, in addition to:
| Item | Example | Description |
|---|---|---|
|
|
|
The total count of available resources in the list, regardless of the number of resources returned in the response. |