Simulator [CH - QA]
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
MetaType
objecthistoryobject
Contains the historical information object
Show Child Parameters
paginationobject
Show Child Parameters
Example
MetaHistoryType
objectContains the historical information object
createdstring(date-time)required
When the JSON:API Object has been created
Example:2022-01-02T18:25:43.511Z
createdBystring
Who created the JSON:API object. This should not share login information (by example, use email)
Example:chris.doe@sixgroup.com
lastModifiedstring(date-time)
When the object has been modified by the last time. This is optional value.
Example:2022-01-02T18:25:43.511Z
lastModifiedBystring
Who modified the JSON:API object.
Example:michael.rodriguez@sixgroup.com
versionstring
This is the version of the object. Should contain hash of the object to detect if this has changed before commit again new changes.
Example:AF9e94334rr44
Example
DERBase64Certificate
stringClient certificate presented by the client when connecting to the API Platform. Is a PEM
Base64-encoded.
Only present for APIs secured by Mutual TLS flow on the API Platform.
One of ‘X-Token’ or ‘X-SSL-Client-DER’ must be provided.
Example