BLbluestaq
Report and Activity

GET /udl/featureassessment/history

Changed on

Service operation to dynamically query historical data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/featureassessment/history
  • Auth
    none declared

Query parameters

columnsstring

optional, fields for retrieval. When omitted, ALL fields are assumed. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid query fields that can be selected.

idAnalyticImagerystring required

Unique identifier of the Analytic Imagery associated with this Feature Assessment record.

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.

featureTsstring date-time required

Datetime type value associated with this record, in ISO 8601 UTC format with millisecond precision.

idAnalyticImagerystring required

Unique identifier of the Analytic Imagery associated with this Feature Assessment record.

typestring

The type of feature (e.g. AIRCRAFT, ANTENNA, SOLAR ARRAY, SITE, STRUCTURE, VESSEL, VEHICLE, UNKNOWN, etc.) detailed in this feature assessment record. This type may be a primary feature within an image, for example a VESSEL, or may be a component or characteristic of a primary feature, for example an ANTENNA mounted on a vessel.

externalIdstring

Feature Assessment ID from external systems. This field has no meaning within UDL and is provided as a convenience for systems that require tracking of an internal system generated ID.

namestring

Source defined name of the feature associated with this record. If an annotation for this feature element exists on the parent image it can be referenced here.

lengthnumber double

Estimated physical length of the feature, in meters.

widthnumber double

Estimated physical width of the feature, in meters.

heightnumber double

Estimated physical height of the feature, in meters.

headingnumber double

The feature object heading, in degrees clockwise from true North at the object location.

speednumber double

Feature's speed of travel, in meters per second.

featureUoMstring required

The Unit of Measure associated with this feature. If there are no physical units associated with the feature a value of NONE should be specified.

featureValuenumber double

A single feature/assessment value expressed in the specified unit of measure (featureUoM). Because of the variability of the Feature Assessment data types, each record may employ a numeric observation value (featureValue), a string observation value (featureString), a Boolean observation value (featureBool), an array of numeric observation values (featureArray), or any combination of these.

featureStringstring

A single feature/assessment string expressed in the specified unit of measure (featureUoM). Because of the variability of the Feature Assessment data types, each record may employ a numeric observation value (featureValue), a string observation value (featureString), a Boolean observation value (featureBool), an array of numeric observation values (featureArray), or any combination of these.

featureArraynumber[]

An array of numeric feature/assessment values expressed in the specified unit of measure (featureUoM). Because of the variability of the Feature Assessment data types, each record may employ a numeric observation value (featureValue), a string observation value (featureString), a Boolean observation value (featureBool), an array of numeric observation values (featureArray), or any combination of these.

featureStringArraystring[]

An array of string feature/assessment expressions. Because of the variability of the Feature Assessment data types, each record may employ a numeric observation value (featureValue), a string observation value (featureString), a Boolean observation value (featureBool), an array of numeric observation values (featureArray), or any combination of these.

featureBoolboolean

A boolean feature/assessment. Because of the variability of the Feature Assessment data types, each record may employ a numeric observation value (featureValue), a string observation value (featureString), a Boolean observation value (featureBool), an array of numeric observation values (featureArray), or any combination of these.

assessmentstring

Descriptive or additional information associated with this feature/assessment.

confidencenumber double

Analytic confidence of feature accuracy (0 to 1).

areastring

Optional geographical region or polygon (lat/lon pairs) of the area surrounding the feature assessment 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 feature assessment 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 feature assessment 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 (POLYGON, POINT, LINE).

andimsinteger

Number of dimensions of the geometry depicted by region.

asridinteger

Geographical spatial_ref_sys for region.

annTextstring[]

Annotation text, a string array of annotation(s) corresponding to the rectangular areas specified in annLims. This array contains the annotation text associated with the areas of interest indicated in annLims, in order. This array should contain one annotation per four values of the area (annLims) array.

srcTypsstring[]

Array of UDL record types (AIS, GROUNDIMAGE, MTI, ONORBIT, POI, SAR, SKYIMAGE, SOI, TRACK) related to this feature assessment. See the associated 'srcIds' and 'srcTs' arrays for the record UUIDs and timetsmps. respectively, positionally corresponding to the record types in this array. The 'srcTyps', 'srcIds', and 'srcTs' arrays must contain the same number of elements.

srcIdsstring[]

Array of UUIDs of the UDL data records that are related to the determination of this activity or event. See the associated 'srcTyps' array for the specific types of data, positionally corresponding to the UUIDs in this array. The 'srcTyps', 'srcIds', and 'srcTs' arrays must contain the same number of elements. See the corresponding srcTyps array element for the data type of the UUID and use the appropriate API operation to retrieve that object.

srcTsstring[]

Array of the primary timestamps, in ISO 8601 UTC format, with appropriate precision for the datatype of each correspondng srcTyp/srcId record. See the associated 'srcTyps' and 'srcIds' arrays for the record type and UUID, respectively, positionally corresponding to the record types in this array. The 'srcTyps', 'srcIds', and 'srcTs' arrays must contain the same number of elements. These timestamps are included to support services which do not include a GET by {id} operation. If referencing a datatype which does not include a primary timestamp, the corresponding srcTs array element should be included as null.

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.

transactionIdstring

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

createdAtstring date-time

Time the row was created in the database, auto-populated by the system.

createdBystring

Application user who created the row in the database, auto-populated by the system.

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.

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.

origNetworkstring

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

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.

Example response

[
  {
    "id": "026dd511-8ba5-47d3-9909-836149f87686",
    "classificationMarking": "U",
    "featureTs": "2024-06-22T17:53:06.123Z",
    "idAnalyticImagery": "fa1509ae-c19d-432e-9542-e5d1e0f47bc3",
    "type": "VESSEL",
    "externalId": "2024-06-22-17-53-05_UMBRA-05_GEC",
    "name": "HEADING",
    "length": 10.54,
    "width": 3.74,
    "height": 7.25,
    "heading": 97.1,
    "speed": 0.1,
    "featureUoM": "MHz",
    "featureValue": 1227.6,
    "featureString": "TRANSMITTING FREQUENCIES",
    "featureArray": [
      1227.6,
      1575.42
    ],
    "featureStringArray": [
      "String1",
      "String2"
    ],
    "featureBool": true,
    "assessment": "Vessel bigger than other small fishing boats commonly found along the coastline",
    "confidence": 0.85,
    "area": "POINT(52.23486096929749 16.191937138595005)",
    "atext": "POINT(52.23486096929749 16.191937138595005)",
    "agjson": "{\"type\":\"Point\",\"coordinates\":[52.23486096929749 16.191937138595005]}",
    "atype": "POINT",
    "andims": 1,
    "asrid": 4326,
    "annLims": [
      [
        1,
        1
      ],
      [
        1,
        2
      ],
      [
        1,
        3
      ],
      [
        1,
        4
      ]
    ],
    "annText": [
      "rec1",
      "rec2"
    ],
    "srcTyps": [
      "SAR",
      "AIS"
    ],
    "srcIds": [
      "b008c63b-ad89-4493-80e0-77bc982bef77",
      "3565a6dd-654e-4969-89e0-ee7c51ab1e1b"
    ],
    "srcTs": [
      "2025-02-24T16:27:18.471Z",
      "2025-02-24T16:29:31.000000Z"
    ],
    "tags": [
      "TAG1",
      "TAG2"
    ],
    "transactionId": "c3bdef1f-5a4f-4716-bee4-7a1e0ec7d37d",
    "createdAt": "2023-04-22T17:51:40.854Z",
    "createdBy": "some.user",
    "sourceDL": "AXE",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "dataMode": "TEST"
  }
]

Changes

  • 45631f9bb3f0Revision changes
    • info

      the response optional property / became write-only for the status

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

Some revisions have not been checked yet.