Version 1.3¶
This is the last maintained version of TruSTAR API.
Pagination¶
All endpoints that can potentially return large lists of results are paginated, in a standardized way.
Some accept two parameters: pageNumber (defaults to 0) and pageSize (defaults to 25, max is 50).
Others require the user to paginate by constantly shrinking the time window for the query by using the from and to
parameters (both will always be in milliseconds since epoch). The reason for not offering a simple pageNumber parameter
on these endpoints is related to performance.
The JSON response of a paginated endpoint will always have a field called items, containing the list of results,
and a field called hasNext, a boolean representing whether a next page exists.
Timestamps¶
Previous API versions dealt with timestamps in an inconsistent way. In this version, this has been fixed.
If any timestamp, in either a request or a response, is given as an integer, it represents milliseconds since the Unix epoch.
When using request parameters to filter based on time, the filters will always be applied to the resource’s updated time,
not its created time.
URIs¶
All resource names in URLs in this version are plural.