---
title: "GET /udl/analyticimagery/{id}"
method: GET
path: "/udl/analyticimagery/{id}"
tags: ["Report and Activity"]
---

# GET /udl/analyticimagery/{id}

`GET /udl/analyticimagery/{id}`

## Request

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

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.

## Path parameters

- `id` string, required

## Query parameters

- `firstResult` integer
- `maxResults` integer

## Response `200`

OK

- AnalyticImageryFull: The analytic imagery schema supports data plots and graphics of various types. The records contain general file information, allows for annotations to user-defined areas of interest on the graphics, and supports keyword searching.
  - `id` string: Unique identifier of the record, auto-generated by the system.
  - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format.
  - `content` string, required: General type of content of this image (CONTOUR, DIAGRAM, HEATMAP, HISTOGRAM, PLOT, SCREENSHOT).
  - `msgTime` string, date-time, required: The message time of this image record, in ISO8601 UTC format with millisecond precision.
  - `imageType` string, required: The type of image associated with this record (GIF, JPG, PNG, TIF).
  - `idSensor` string: Unique identifier of the reporting sensor.
  - `origSensorId` string: 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.
  - `filename` string, required: The image file name.
  - `filesize` integer, 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.
  - `imgWidth` integer: The image width (horizontal), in pixels.
  - `imgHeight` integer: The image height (vertical), in pixels.
  - `xUnits` string: Optional field indicating the units that apply to the x-axis of the attached image, when applicable.
  - `yUnits` string: Optional field indicating the units that apply to the y-axis of the attached image, when applicable.
  - `zUnits` string: Optional field indicating the units that apply to the z-axis of the attached image, when applicable.
  - `imageSetId` string: User-defined set ID of a sequence of images. Used to associate related analytic image records.
  - `imageSetLength` integer: The number of images in an image set.
  - `sequenceId` integer: 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.
  - `description` string, required: Description of the image content and utility.
  - `dataStart` string, 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.
  - `dataStop` string, 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.
  - `annLims` array[]: Rectangular annotation limits, specified in pixels, as an array of arrays of the coordinates [ [UL1x, UL1y], [UR1x, UR1y], [LR1x, LR1y], [LL1x, LL1y] ], indicating the corners of a rectangle beginning with the Upper Left (UL) and moving clockwise. Allows the image provider to highlight one or more rectangular area(s) of interest. The array must contain Nx4 two-element arrays, where N is the number of rectangles of interest. The associated annotation(s) should be included in the annText array.
    - integer[]
  - `annText` string[]: 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.
  - `keywords` string[]: Array of searchable keywords for this analytic imagery record.
  - `area` string: Optional geographical region or polygon (lat/lon pairs) of the area surrounding the point of interest as projected on the ground.
  - `atext` string: 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.
  - `agjson` string: 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.
  - `atype` string: Type of region as projected on the ground.
  - `andims` integer: Number of dimensions of the geometry depicted by region.
  - `asrid` integer: Geographical spatial_ref_sys for region.
  - `satId` string[]: Assessed satellite ID (NORAD RSO object number). The 'satId' and 'satIdConf' arrays must match in size.
  - `satIdConf` number[]: 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.
  - `srcTyps` string[]: 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.
  - `srcIds` string[]: 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.
  - `tags` string[]: 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.
  - `checksumValue` string: MD5 checksum value of the file. The ingest/create operation will automatically generate the value.
  - `transactionId` string: Optional identifier to track a commercial or marketplace transaction executed to produce this data.
  - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system.
  - `createdBy` string: Application user who created the row in the database, auto-populated by the system.
  - `source` string, required: Source of the data.
  - `origin` string: 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.
  - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system.
  - `sourceDL` string: 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.
  - `featureAssessments` FeatureAssessmentFull[]: A collection of feature assessments associated with the analytic imagery record.
    - `id` string: Unique identifier of the record, auto-generated by the system.
    - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format.
    - `featureTs` string, date-time, required: Datetime type value associated with this record, in ISO 8601 UTC format with millisecond precision.
    - `idAnalyticImagery` string, required: Unique identifier of the Analytic Imagery associated with this Feature Assessment record.
    - `type` string: 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.
    - `externalId` string: 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.
    - `name` string: 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.
    - `length` number, double: Estimated physical length of the feature, in meters.
    - `width` number, double: Estimated physical width of the feature, in meters.
    - `height` number, double: Estimated physical height of the feature, in meters.
    - `heading` number, double: The feature object heading, in degrees clockwise from true North at the object location.
    - `speed` number, double: Feature's speed of travel, in meters per second.
    - `featureUoM` string, 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.
    - `featureValue` number, 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.
    - `featureString` string: 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.
    - `featureArray` number[]: 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.
    - `featureStringArray` string[]: 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.
    - `featureBool` boolean: 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.
    - `assessment` string: Descriptive or additional information associated with this feature/assessment.
    - `confidence` number, double: Analytic confidence of feature accuracy (0 to 1).
    - `area` string: Optional geographical region or polygon (lat/lon pairs) of the area surrounding the feature assessment as projected on the ground.
    - `atext` string: 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.
    - `agjson` string: 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.
    - `atype` string: Type of region as projected on the ground (POLYGON, POINT, LINE).
    - `andims` integer: Number of dimensions of the geometry depicted by region.
    - `asrid` integer: Geographical spatial_ref_sys for region.
    - `annLims` array[]: Polygonal annotation limits, specified in pixels, as an array of arrays N x M. Allows the image provider to highlight one or more polygonal area(s) of interest. The array must contain NxM two-element arrays, where N is the number of polygons of interest. The associated annotation(s) should be included in the annText array.
      - integer[]
    - `annText` string[]: 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.
    - `srcTyps` string[]: 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.
    - `srcIds` string[]: 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.
    - `srcTs` string[]: 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.
    - `tags` string[]: 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.
    - `transactionId` string: Optional identifier to track a commercial or marketplace transaction executed to produce this data.
    - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system.
    - `createdBy` string: Application user who created the row in the database, auto-populated by the system.
    - `sourceDL` string: 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.
    - `source` string, required: Source of the data.
    - `origin` string: 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.
    - `origNetwork` string: 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.

## Other responses

- `400`: Bad Request
- `401`: Invalid/Missing User Credentials
- `403`: User Is Not Authorized
- `404`: Item Not Found
- `405`: Method Not Allowed
- `406`: MediaType Not Accepted by Request Headers
- `429`: Rate of Requests Exceeds Allowed Limit
- `500`: Internal Server Error

## Changes

> 12 revisions in range; 1 could not be searched.

- **2025-09-26** `45631f9bb3f0`: 2 info
  - the response optional property `area` became write-only for the status `200`
  - the response optional property `featureAssessments/items/area` became write-only for the status `200`
- **2025-05-29** `4e1cbc17e814`: 3 info
  - added the new optional `query` request parameter `firstResult`
  - added the new optional `query` request parameter `maxResults`
  - added the optional property `featureAssessments` to the response with the `200` status
- **2025-04-16** `75f764c843a9`: 4 info
  - api operation id `find_13` removed and replaced with ``
  - the endpoint scheme security `BasicAuth` was removed from the API
  - added the optional property `idSensor` to the response with the `200` status
  - added the optional property `origSensorId` to the response with the `200` status

[Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/analyticimagery/:id/get.md)

---

[API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)