BLbluestaq
Report and Activity

GET /udl/analyticimagery/{id}

Changed on

Service operation to get a single AnalyticImagery record by its unique ID passed as a path parameter. AnalyticImagery represents metadata about an image, as well as the actual binary image data.

Request

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

Path parameters

idstring required

The ID of the AnalyticImagery to find.

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.

contentstring required

General type of content of this image (CONTOUR, DIAGRAM, HEATMAP, HISTOGRAM, PLOT, SCREENSHOT).

msgTimestring date-time required

The message time of this image record, in ISO8601 UTC format with millisecond precision.

imageTypestring required

The type of image associated with this record (GIF, JPG, PNG, TIF).

idSensorstring

Unique identifier of the reporting sensor.

origSensorIdstring

Optional identifier provided by the source to indicate the sensor for this collection. This may be an internal identifier and not necessarily a valid sensor ID.

filenamestring required

The image file name.

filesizeinteger required

The image file size, in bytes. The maximum file size for this service is 40,000,000 bytes (40MB). Files exceeding the maximum size will be rejected.

imgWidthinteger

The image width (horizontal), in pixels.

imgHeightinteger

The image height (vertical), in pixels.

xUnitsstring

Optional field indicating the units that apply to the x-axis of the attached image, when applicable.

yUnitsstring

Optional field indicating the units that apply to the y-axis of the attached image, when applicable.

zUnitsstring

Optional field indicating the units that apply to the z-axis of the attached image, when applicable.

imageSetIdstring

User-defined set ID of a sequence of images. Used to associate related analytic image records.

imageSetLengthinteger

The number of images in an image set.

sequenceIdinteger

The sequence number of an image within an image set. If null, then it is assumed that the order of images in an imageSet is not relevant.

descriptionstring required

Description of the image content and utility.

dataStartstring date-time

The start time, in ISO8601 UTC format with millisecond precision, of the data used in the analysis or composition of the image content, when applicable.

dataStopstring date-time

The stop time, in ISO8601 UTC format with millisecond precision, of the data used in the analysis or composition of the image content, when applicable.

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.

keywordsstring[]

Array of searchable keywords for this analytic imagery record.

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.

satIdstring[]

Assessed satellite ID (NORAD RSO object number). The 'satId' and 'satIdConf' arrays must match in size.

satIdConfnumber[]

Assessed satellite confidence corresponding to an assessment ID. Values are between 0.0 and 1.0. The 'satId' and 'satIdConf' arrays must match in size.

srcTypsstring[]

Array of UDL record types (AIS, CONJUNCTION, DOA, ELSET, EO, ESID, GROUNDIMAGE, POI, MANEUVER, MTI, NOTIFICATION, RADAR, RF, SIGACT, SKYIMAGE, SV, TRACK) that are related to this image. 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 this image. 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.

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.

checksumValuestring

MD5 checksum value of the file. The ingest/create operation will automatically generate the value.

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.

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.

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.

dataMode'REAL' | 'TEST' | 'EXERCISE' | 'SIMULATED' 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": "ANALYTIC-IMAGERY-ID",
  "classificationMarking": "U",
  "content": "CONTOUR",
  "msgTime": "2018-01-01T16:00:00.123Z",
  "imageType": "JPG",
  "idSensor": "SENSOR-ID",
  "origSensorId": "ORIG-SENSOR-ID",
  "filename": "IMAGE-NAME",
  "filesize": 7654321,
  "imgWidth": 123,
  "imgHeight": 123,
  "xUnits": "pixels",
  "yUnits": "pixels",
  "zUnits": "pixels",
  "imageSetId": "IMAGE-IDS",
  "imageSetLength": 123,
  "sequenceId": 123,
  "description": "Image description",
  "dataStart": "2018-01-01T16:00:00.123Z",
  "dataStop": "2018-01-01T16:00:00.123Z",
  "annLims": [
    [
      1,
      1
    ],
    [
      1,
      2
    ],
    [
      1,
      3
    ],
    [
      1,
      4
    ]
  ],
  "annText": [
    "rec1",
    "rec2"
  ],
  "keywords": [
    "Key1",
    "Key2"
  ],
  "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": "POLYGON",
  "andims": 2,
  "asrid": 4326,
  "satId": [
    "12004",
    "12005"
  ],
  "satIdConf": [
    0.98,
    0.22
  ],
  "srcTyps": [
    "MTI",
    "POI"
  ],
  "srcIds": [
    "DOA_ID",
    "DWELL_ID"
  ],
  "tags": [
    "TAG1",
    "TAG2"
  ],
  "checksumValue": "123",
  "transactionId": "a7bdef1f-5a4f-4716-bee4-7a1e0ec7d35a",
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "source": "Bluestaq",
  "origin": "ORIGIN",
  "origNetwork": "OPS1",
  "sourceDL": "AXE",
  "dataMode": "TEST",
  "featureAssessments": [
    {
      "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

    • 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

    • info

      added the optional property to the response with the status

Some revisions have not been checked yet.