API referenceEndpoints
Search checkpoints
Returns checkpoints matching optional text, area and status filters.
GET
/referential/v1/checkpointsReturns checkpoints matching optional text, area and status filters.
Authorization
oauth2 AuthorizationBearer <token>
In: header
Query Parameters
search?string
Matches part of a code or name.
Default
nullfromAreaId.value?string
toAreaId.value?string
status?string
Restrict to one lifecycle status; defaults to ACTIVE.
Default
nullValue in
- "ACTIVE"
- "DECOMMISSIONED"
- "ACTIVE"
- "DECOMMISSIONED"
sort?string
Result ordering.
Default
nullValue in
- "codeAsc"
- "codeDesc"
- "newest"
- "oldest"
- "codeAsc"
- "codeDesc"
- "newest"
- "oldest"
- "codeAsc"
- "codeDesc"
- "newest"
- "oldest"
page?integer
Zero-based page index.
Format
int32Range
0 <= valueDefault
nullsize?integer
Page size, at most 200.
Format
int32Range
0 <= value <= 200Default
nullResponse Body
*/*
curl -X GET "https://example.com/referential/v1/checkpoints"{ "data": [ { "id": "string", "code": "string", "name": "string", "fromAreaId": "string", "toAreaId": "string", "status": "string", "capabilities": [ { "type": "string", "wiringReference": "string", "active": true } ], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "page": 0, "size": 0, "total": 0}