| Jira Legacy | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Table of Contents |
|---|
...
Proposed APIs
The GET Endpoints URIs depends on the CPS datatype and URI contains information about the dataspace and anchor and the rest of the filtering criteria are passed as query parameter. The supported query parameters which are supported by all endpoints are
- after - timestamp ( ISO Format) to consider data created after the specified Timestamp
- payload - to define payload filtering criteria
- index - to define the page number (required for pagination)
- maxSize - to limit the response size
- pointInTime - to consider data changed or added before this time.
- sortBy - to define the order of data in the result set
...
By Dataspace and Anchor
URL: GET /dataspaces/{dataspace-name}/anchors/{anchor-name}
Example: GET /dataspaces/{dataspace-name}/anchors/{anchor-name}?after=2021-03-21T00:00:00-0:00&payload=/device/port/interface[status=up]&maxSize=500
By Dataspace and Schema-set
URL: GET /dataspaces/{dataspace-name}/schema-sets/{schema-setanchors?schemaSet={schemaset-name}
Example: GET /dataspaces/{dataspace-name}/schema-sets/{schema-set}?anchors?schemaSet={schemaset-name}&after=2021-03-21T00:00:00-0:00&payload=/device/port/interface[status=up]
Response Anchor responseBody responseBody
| responseBody | |
| responseBody |
| name | type | |
|---|---|---|
| nextRecordsLink | string | added only if there are remaining records to be fetched for the query. |
| previousRecordsLink | string | added only if it is not the first set of records. |
| records | list | contains one record for each timestamp that meets filtering criteria. It contains header information along with data. |
...