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. Returns the RID of the created High Priority Target List.
booleanRepresents a boolean value that restricts an endpoint to preview mode when set to true.
objectThe request body to create a High Priority Target List
stringstringstringThe unique resource identifier of a Target Board. This is equivalent to a collection RID.
list<HighPriorityTargetListTargetV2>A list of HighPriorityTargetListTargets
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 will be preferred.
list<HptlTargetAoi>objectSecurity mutation details for a target, target board, or hptl. Specifying security overrides the system's default security when creating and updating data. This model may evolve over time for other security features.
objectSuccess response with the ID of the created High Priority Target List.
string1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/gotham/v1/twb/highPriorityTargetList?preview=true" \
-d '{"name":"Example hptl name.","description":"Example description.","targetBoard":"ri.gotham-artifact.0-0.target-collection.example","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.0,"latitude":1.0,"elevation":1.0}},"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"}}]}'