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.
Modify a High Priority Target List by RID.
booleanRepresents a boolean value that restricts an endpoint to preview mode when set to true.
objectThe request body to modify a High Priority Target List from a R
stringThe 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>integerThe current version of the HighPriorityTargetList to be modified. 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.
1
2
3
4
5
curl -X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/gotham/v1/twb/highPriorityTargetList/ri.gotham-artifact.0-0.target.example?preview=true" \
-d '{"description":"Example description.","targets":[{"highPriorityTargetListTargetId":"f81d4fae-7dec-11d0-a765-00a0c91e6bf6","targetType":"Airplane","priority":1,"when":"PLANNED","agm":{"agmId":"2a46fbf6-ff93-4710-951a-015ed5c92441","effectType":"NEUTRALIZE","effector":"F-16C","effectorPriority":2,"timelinessInMinutes":"5`"}},{"highPriorityTargetListTargetId":"54ac3383-b953-4d65-8f98-7c3fbbbb481a","targetType":"Ship","priority":1,"when":"PLANNED","agm":{"agmId":"2f0df2cb-0737-4675-a481-2c93259a78ae","effectType":"DESTROY","effector":"M777","effectorPriority":2,"timelinessInMinutes":5}}],"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"}}],"baseRevisionId":1}'