Simulator [CH - QA]
QueryType
objectfiltersarray[object]
Filters restricting the search. All of the values in the Array represent AND operation.
Show Child Parameters
restrictionsarray[object]
List of restrictions applied to the collection
Show Child Parameters
Example
FilterType
objectattributestring
Name of the attribute to be restricted, filtered or searched
Example:sessionDate
valuesarray[string]
Value of the filter or restriction done.
Example:20200101, 20200102
Example
UUIDType
stringUUID type implementing the RFC 4122.
Match pattern:^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
Example
LinksPaginationType
objectfirststringrequired
First position of the collection
Example:https://api.domain.com/resources?page[number]=1
laststringrequired
Last page of the collection
Example:https://api.domain.com/resources?page[number]=50
prevstring
Navigates to the previous page on the list provided. If the page is the first one, prev should be null or not be present
Example:https://api.domain.com/resources?page[number]=1
nextstring
Navigates to the next page on the list provided. If the page is the last one, prev should be null or not be present
Example:https://api.domain.com/resources?page[number]=3
Example
PaginationType
objecttotalEntitiesinteger(int32)
Total of the entities returned in the collection. Depending of the operation pattern:
- SEARCH: return the number of elements of the search criteria
- GET: return all the elements or the search criteria
totalPagesinteger(int32)
Total of the pages that the collection could return. Last page = to totalPages.
pageSizeinteger(int32)
Size of the page.
pageinteger(int32)
Current Page of the return collection
Example