This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Create a High Priority Target List.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:target-write.
objectstringThe unique identifier for a Target Board
list<HptlTargetAoi>objectSecurity settings for board content
objectA Polygon representing the area where this High Priority Target List is applicable. If areaObjectRid exists, that field/area will be used and this field will be ignored.
stringThe primary key/unique identifier of an object, useful for interacting with Gotham APIs to load and mutate objects.
stringstringlist<HighPriorityTargetListTarget>objectThe created HighPriorityTargetList
stringThe unique identifier for a High Priority Target List
stringstringstringThe unique identifier for a Target Board
list<HighPriorityTargetListTarget>stringThe primary key/unique identifier of an object, useful for interacting with Gotham APIs to load and mutate objects.
objectA Polygon representing the area where this High Priority Target List is applicable. If areaObjectRid exists, that field/area will be used and this field will be ignored.
list<HptlTargetAoi>objectSecurity settings for board content
1
2
3
4
5
curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/targetWorkbench/highPriorityTargetLists?preview=true" \
-d '{"targetBoard":"ri.gotham-artifact.0-0.target-board.example","security":{"portionMarkings":["SENSITIVE"],"spaceRid":"ri.compass.main.folder.12345"},"areaGeo":{"points":[{"elevation":0.0,"latitude":0.0,"longitude":0.0}]},"areaObjectRid":"ri.gotham.123-456.object-internal.example","name":"Example target board name.","description":"Example target board description.","targets":[{"targetSubtypes":["Red Car"],"when":"ACQUIRED"}]}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
"targetBoard": "ri.gotham-artifact.0-0.target-board.example",
"security": {
"portionMarkings": [
"SENSITIVE"
],
"spaceRid": "ri.compass.main.folder.12345"
},
"areaGeo": {
"points": [
{
"elevation": 0,
"latitude": 0,
"longitude": 0
}
]
},
"areaObjectRid": "ri.gotham.123-456.object-internal.example",
"name": "Example target board name.",
"description": "Example target board description.",
"rid": "ri.gotham-artifact.0-0.hptl.example",
"targets": [
{
"targetSubtypes": [
"Red Car"
],
"when": "ACQUIRED"
}
]
}| Error Name | ||
|---|---|---|
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The specified portion markings are not valid. | |
| Parameters | portionMarkings | |
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The space rid is missing or invalid. | |
| Parameters | spaceRid | |
Create | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not create the HighPriorityTargetList. | |
| Parameters | | |
See Errors for a general overview of errors in the platform.