BLbluestaq
Report and Activity

GET /udl/poi/{id}

Changed on

Service operation to get a single POI by its unique ID passed as a path parameter.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/poi/{id}
  • Auth
    none declared

Path parameters

idstring required

The ID of the POI to retrieve.

Query parameters

firstResultinteger
maxResultsinteger

Response

OK

idstring

Unique identifier of the record, auto-generated by the system.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

ppsstring

The purpose of this Point of Interest record (e.g., BDA, EQPT, EVENT, GEOL, HZRD, PPLI, SHOTBOX, SURVL, TGT, TSK, WTHR).

msnidstring

Optional mission ID related to the POI.

priinteger

Priority of the POI target object.

trkidstring

Optional ID of an associated track related to the POI object, if applicable. This track ID should correlate the Point of Interest to a track from the Track service.

idWeatherReportstring[]

Array of one or more unique identifiers of weather records associated with this POI. Each element in array must be 36 characters or less in length.

poiidstring required

Identifier of the actual Point of Interest or target object, which should remain the same on subsequent POI records of the same Point of Interest.

namestring required

Name of the POI target object.

descstring

Description of the POI target object.

specstring

Specific point/object type (e.g., 82/GROUND, LIGHT_TANK, etc.).

identstring

Estimated identity of the point/object (e.g., FRIEND, HOSTILE, SUSPECT, ASSUMED_FRIEND, UNKNOWN, etc.).

envstring

POI environment type (e.g., LAND, SURFACE, SUBSURFACE, UNKNOWN, etc.).

platstring

POI/object platform type (e.g., 14/GROUND, COMBAT_VEHICLE, etc.).

activitystring

The activity in which the POI subject is engaged. Intended as, but not constrained to, MIL-STD-6016 environment dependent activity designations. The activity can be reported as either a combination of the code and environment (e.g. 30/LAND) or as the descriptive enumeration (e.g. TRAINING), which are equivalent.

tsstring date-time required

Activity/POI timestamp in ISO8601 UTC format.

startstring date-time

Start time of event validity (optional), in ISO8601 UTC format.

stalestring date-time

Stale timestamp (optional), in ISO8601 UTC format.

howstring

How the event point was generated, in CoT object heirarchy notation (optional, CoT).

typestring

Event type, in CoT object heirarchy notation (optional, CoT).

latnumber double

WGS-84 latitude of the POI, in degrees (+N, -S), -90 to 90.

lonnumber double

WGS-84 longitude of the POI, in degrees (+E, -W), -180 to 180.

altnumber double

Point height above ellipsoid (WGS-84), in meters.

aznumber double

Target object pointing azimuth angle, in degrees (for target with sensing or emitting capability).

elnumber double

Target object pointing elevation angle, in degrees (for target with sensing or emitting capability).

lenumber double

Height above lat/lon point, in meters (1-sigma, if representing linear error).

cenumber double

Radius of circular area about lat/lon point, in meters (1-sigma, if representing error).

ellenumber[]

Elliptical area about the lat/lon point, specified as [semi-major axis (m), semi-minor axis (m), orientation (deg) off true North at POI].

cntctstring

Contact information for assets reporting PPLI (Precise Participant Location and Identification). PPLI is a Link 16 message that is used by units to transmit complete location, identification, and limited status information.

confnumber double

POI confidence estimate (not standardized, but typically a value between 0 and 1, with 0 indicating lowest confidence.

urlsstring[]

List of URLs to before/after images of this Point of Interest entity.

areastring

Optional geographical region or polygon (lat/lon pairs) of the area surrounding the Point of Interest as projected on the ground.

atextstring

Geographical region or polygon (lon/lat pairs), as depicted by the Well-Known Text representation of the geometry/geography, of the image as projected on the ground. WKT reference: https://www.opengeospatial.org/standards/wkt-crs. Ignored if included with a POST or PUT request that also specifies a valid 'area' field.

agjsonstring

Geographical region or polygon (lat/lon pairs), as depicted by the GeoJSON representation of the geometry/geography, of the image as projected on the ground. GeoJSON Reference: https://geojson.org/. Ignored if included with a POST or PUT request that also specifies a valid 'area' or 'atext' field.

atypestring

Type of region as projected on the ground.

andimsinteger

Number of dimensions of the geometry depicted by region.

asridinteger

Geographical spatial_ref_sys for region.

createdAtstring date-time

Time the row was created in the database.

createdBystring

Application user who created the row in the database.

sourceDLstring

The source data library from which this record was received. This could be a remote or tactical UDL or another data library. If null, the record should be assumed to have originated from the primary Enterprise UDL.

sourcestring required

Source of the data.

dataMode'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE' required

Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data:

REAL: Data collected or produced that pertains to real-world objects, events, and analysis.

TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics.

EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data.

SIMULATED: Synthetic data generated by a model to mimic real-world datasets.

originstring

Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin.

groupsstring[]

Optional array of groups used when a POI msg originates from a TAK server. Each group must be no longer than 256 characters. Groups identify a set of users targeted by the cot/poi msg.

assetstring

ID/name of the platform or entity providing the POI data.

tagsstring[]

Optional array of provider/source specific tags for this data, where each element is no longer than 32 characters, used for implementing data owner conditional access controls to restrict access to the data. Should be left null by data providers unless conditional access controls are coordinated with the UDL team.

srcTypsstring[]

Array of UDL record types (GROUNDIMAGE, RFOBS) that are related to the determination of this Point of Interest. See the associated 'srcIds' array for the record UUIDs, positionally corresponding to the record types in this array. The 'srcTyps' and 'srcIds' arrays must match in size.

srcIdsstring[]

Array of UUIDs of the UDL data records that are related to the determination of this Point of Interest. See the associated 'srcTyps' array for the specific types of data, positionally corresponding to the UUIDs in this array. The 'srcTyps' and 'srcIds' arrays must match in size. See the corresponding srcTyps array element for the data type of the UUID and use the appropriate API operation to retrieve that object (e.g. /udl/rfobservation/{uuid}).

beNumberstring

The Basic Encyclopedia Number associated with the POI, if applicable.

orientationnumber double

The orientation of a vehicle, platform or other entity described by the POI. The orientation is defined as the pointing direction of the front/nose of the object in degrees clockwise from true North at the object point.

origNetworkstring

The originating source network on which this record was created, auto-populated by the system.

transactionIdstring

Optional identifier to track a commercial or marketplace transaction executed to produce this data.

Example response

{
  "id": "POI-ID",
  "classificationMarking": "U",
  "pps": "BDA",
  "msnid": "MSN-ID",
  "pri": 2,
  "trkid": "TRK-ID",
  "idWeatherReport": [
    "WEATHER-EVENT-ID1",
    "WEATHER-EVENT-ID2"
  ],
  "poiid": "POI-ID",
  "name": "POI_NAME",
  "desc": "Description of the object",
  "spec": "LIGHT_TANK",
  "ident": "FRIEND",
  "env": "SURFACE",
  "plat": "COMBAT_VEHICLE",
  "activity": "TRAINING",
  "ts": "2020-01-01T16:00:00.123456Z",
  "start": "2020-01-01T16:00:00.123456Z",
  "stale": "2020-01-01T16:00:00.123456Z",
  "how": "h-g-i-g-o",
  "type": "a-h-G",
  "lat": 45.23,
  "lon": 45.23,
  "alt": 5.23,
  "az": 45.23,
  "el": 45.23,
  "le": 10.23,
  "ce": 10.23,
  "elle": [
    125.5,
    85.1,
    125.75
  ],
  "cntct": "Contact Info",
  "conf": 0.5,
  "urls": [
    "URL1",
    "URL2"
  ],
  "area": "POLYGON((67.3291113966927 26.156175339112,67.2580009640721 26.091022064271,67.1795862381682 26.6637992964562,67.2501237475598 26.730115808233,67.3291113966927 26.156175339112))",
  "atext": "POLYGON((67.3291113966927 26.156175339112,67.2580009640721 26.091022064271,67.1795862381682 26.6637992964562,67.2501237475598 26.730115808233,67.3291113966927 26.156175339112))",
  "agjson": "{\"type\":\"Polygon\",\"coordinates\":[ [ [ 67.3291113966927, 26.156175339112 ], [ 67.2580009640721, 26.091022064271 ], [ 67.1795862381682, 26.6637992964562 ], [ 67.2501237475598, 26.730115808233 ], [ 67.3291113966927, 26.156175339112 ] ] ] }",
  "atype": "Type1",
  "andims": 3,
  "asrid": 3,
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "sourceDL": "AXE",
  "source": "Bluestaq",
  "dataMode": "TEST",
  "origin": "THIRD_PARTY_DATASOURCE",
  "groups": [
    "GROUP1",
    "GROUP2"
  ],
  "asset": "PLATFORM_NAME",
  "tags": [
    "TAG1",
    "TAG2"
  ],
  "srcTyps": [
    "TYPE1",
    "TYPE2"
  ],
  "srcIds": [
    "ID1",
    "ID2"
  ],
  "beNumber": "0427RT1030",
  "orientation": 45.23,
  "origNetwork": "OPS1",
  "transactionId": "TRANSACTION-ID"
}

Changes

Some revisions have not been checked yet.