Load a High Priority Target List by RID.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:target-read.
objectSuccess response with the requested Target Board.
objectThe High Priority Target List object.
integerThe current version of the retrieved HighPriorityTargetList. Any modifying operations should be accompanied by this version to avoid concurrent operations made since this version. If there are any conflicting edits that result in changes to these operations when they are applied, it will be noted in the response.
1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/targetWorkbench/highPriorityTargetLists/ri.gotham-artifact.0-0.hptl.example/load"1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
"highPriorityTargetList": {
"areaGeo": {
"points": [
{
"elevation": 0,
"latitude": 0,
"longitude": 0
}
]
},
"areaObjectId": "ri.gotham.123-456.object-internal.example",
"rid": "ri.gotham-artifact.0-0.hptl.example",
"targets": [
{
"targetSubtypes": [
"Red Car"
],
"when": "ACQUIRED"
}
]
},
"baseRevisionId": 1
}| Error Name | ||
|---|---|---|
High | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | Cannot find High Priority Target List from provided RID | |
| Parameters | highPriorityTargetListRid | |
Load | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not load the HighPriorityTargetList. | |
| Parameters | highPriorityTargetListRid | |
See Errors for a general overview of errors in the platform.