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 Target. Returns the RID of the created Target.
If sidc field is specified and invalid according to MIL-STD-2525C specification,
an InvalidSidc error is thrown.
booleanRepresents a boolean value that restricts an endpoint to preview mode when set to true.
objectThe request body to create a Target. The objectRid is the RID of the object being targeted.
stringstringstringThe unique resource identifier of a Target Board. This is equivalent to a collection RID.
stringEquivalent to a collection column ID. The ID of a TargetCollectionColumn, default values are: DRAFT (Identified target), PLAN_DEVELOPMENT (Prioritized target), PLANNED (In coordination), EXECUTION (In execution), CLOSED (Complete).
stringThe resource type of the target. Example: Building
stringThe primary key/unique identifier of an object, useful for interacting with Gotham APIs to load and mutate objects.
stringMIL-STD 2525C Symbol Identification Code
objectTarget identifier object for different identifier types
objectAn object containing the location source for a target. This can either be a Location3dWithError and/or a geotimeTrack.
stringThis subtype will be matched against the subType stored on HptlTarget in order to determine a target's subPriority, as well as priority in addition to priority and AGM.
list<TargetAimpointV2>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 RID of the created target.
string1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/gotham/v1/twb/target?preview=true" \
-d '{"name":"Enemy Building","description":"Known enemy building.","targetBoard":"ri.gotham-artifact.0-0.target-board.example","column":"DRAFT","targetType":"Building","entityRid":"ri.gotham.123-456.object-internal.example","sidc":"SEGPU-------","aimpoints":[{"id":"f81d4fae-7dec-11d0-a765-00a0c91e6bf6","number":1,"name":"Example targetAimPoint name","location":{"center":{"longitude":0.0,"latitude":0.0,"elevation":0.0},"radius":1.1},"geotimeTrack":"ri.gotham.0-0.geotime-track.aa.bb.cc.example","entityRid":"ri.gotham.123-456.object-internal.example"},{"id":"54ac3383-b953-4d65-8f98-7c3fbbbb481a","number":1,"name":"Example targetAimPoint name","location":{"center":{"longitude":0.0,"latitude":0.0,"elevation":0.0},"radius":1.1},"geotimeTrack":"ri.gotham.0-0.geotime-track.aa.bb.cc.example","entityRid":"ri.gotham.123-456.object-internal.example"}],"targetIdentifier":{"customTargetIdentifier":"Example Identifier 000"},"location":{"manualLocation":{"lat":0.0,"lng":0.0,"circularErrorInMeters":0.0,"hae":0.0,"msl":0.0,"agl":0.0}},"highPriorityTargetListTargetSubtype":"Red Car","security":{"portionMarkings":["SENSITIVE"]}}'1
2
3
{
"targetRid": "ri.gotham-artifact.0-0.target.example"
}