Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Load Target

GET/api/v2/targetWorkbench/targets/{targetRid}/load

Load Target by RID.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:target-read.

Path parameters

targetRid
string

The unique identifier for a Target

Response body

LoadTargetResponse
object

Success response with the requested Target. The objectRid is the RID of the object being targeted.

Hide child attributes

Hide child attributes

target
object
Show child attributes

Show child attributes

baseRevisionId
string

The current version of the Target 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 \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/targetWorkbench/targets/ri.gotham-artifact.0-0.target.example/load"

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 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 { "baseRevisionId": 1, "target": { "sidc": "SEGPU-------", "entityRid": "ri.gotham.123-456.object-internal.example", "highPriorityTargetListTargetSubtype": "Red Car", "targetIdentifier": { "customTargetIdentifier": "Example Identifier 000" }, "aimpoints": [ { "entityRid": "ri.gotham.123-456.object-internal.example", "geotimeTrack": "ri.gotham.0-0.geotime-track.aa.bb.cc.example", "name": "Example targetAimPoint name", "location": { "circularErrorInMeters": 0, "lng": 0, "msl": { "elevationInMeters": 0, "linearErrorInMeters": 0 }, "agl": { "elevationInMeters": 0, "linearErrorInMeters": 0 }, "hae": { "elevationInMeters": 0, "linearErrorInMeters": 0 }, "lat": 0 }, "id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6" } ], "name": "Example target name.", "description": "Example target description.", "targetBoards": [ "ri.gotham-artifact.0-0.target-board.example" ], "targetType": "Building", "location": { "manualLocation": { "circularErrorInMeters": 0, "lng": 0, "msl": { "elevationInMeters": 0, "linearErrorInMeters": 0 }, "agl": { "elevationInMeters": 0, "linearErrorInMeters": 0 }, "hae": { "elevationInMeters": 0, "linearErrorInMeters": 0 }, "lat": 0 }, "geotimeTrack": "ri.gotham.0-0.geotime-track.aa.bb.cc.example", "geotrackableEntity": "ri.gotham.123-456.object-internal.example" }, "rid": "ri.gotham-artifact.0-0.target.example", "intel": [ { "domain": "SIGINT", "confidence": 3, "name": "Example Intel Name", "description": "Intel containing location.", "intelType": { "type": "geotimeObservation", "geotimeTrack": "ri.gotham.0-0.geotime-track.aa.bb.cc.example" }, "validTime": "2023-10-04T14:48:00.000Z", "location": { "center": { "elevation": 0, "latitude": 0, "longitude": 0 }, "radius": 1.1 }, "id": "Example Intel Id" } ] } }

Error responses

Error Name
TargetNotFoundError CodeINVALID_ARGUMENT
Status Code400
DescriptionCannot find target from provided rid.
ParameterstargetRid
LoadTargetPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not load the Target.
ParameterstargetRid