Search documentation
karat

+

K

User Documentation ↗

Load a HighPriorityTargetList

GET/api/gotham/v1/twb/highPriorityTargetList/{rid}

Load a High Priority Target List by RID.

Path parameters

rid
string

High Priority Target List RID

Query parameters

preview
boolean
optional

Represents a boolean value that restricts an endpoint to preview mode when set to true.

Response body

LoadHighPriorityTargetListResponseV2
object

Success response with the requested High Priority Target List.

Hide child attributes

Hide child attributes

highPriorityTargetList
object

The High Priority Target List object.

Show child attributes

Show child attributes

baseRevisionId
integer

The current version of the HighPriorityTargetList retrieved. 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're applied, that will be noted in the response.

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/gotham/v1/twb/highPriorityTargetList/ri.gotham-artifact.0-0.hptl.example?preview=true"

Response

Copied!
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 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 { "rid": "ri.gotham-artifact.0-0.hptl.example", "description": "Example description.", "targets": [ { "highPriorityTargetListTargetId": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "targetType": "Airplane", "priority": 1, "subPriority": 4, "category": "Transport", "when": "PLANNED", "agm": { "agmId": "2a46fbf6-ff93-4710-951a-015ed5c92441", "effectType": "NEUTRALIZE", "effector": "F-16C", "effectorPriority": 2, "timelinessInMinutes": 5 }, "aoiId": "123e4567-e89b-12d3-a456-426614174000" }, { "highPriorityTargetListTargetId": "54ac3383-b953-4d65-8f98-7c3fbbbb481a", "targetType": "Ship", "priority": 1, "subPriority": 2, "category": "Transport", "when": "PLANNED", "agm": { "agmId": "2f0df2cb-0737-4675-a481-2c93259a78ae", "effectType": "DESTROY", "effector": "M777", "effectorPriority": 2, "timelinessInMinutes": 5 }, "aoiId": "123e4567-e89b-12d3-a456-426614174020" } ], "areaObjectRid": "ri.gotham-artifact.0-0.object-internal.example", "areaGeo": { "points": { "longitude": 1, "latitude": 1, "elevation": 1 } }, "targetAois": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Lake215", "data": { "entity": "ri.gotham.123-456.object-internal.example" } }, { "id": "123e4567-e89b-12d3-a456-426614174020", "name": "Lake230", "data": { "entity": "ri.gotham.123-456.object-internal.example" } } ], "baseRevisionId": 1 }