BLbluestaq
Ground Imagery

POST /udl/groundimagery

Changed on

Service operation to take a single GroundImagery object as a POST body and ingest into the database. A specific role is required to perform this service operation. Please contact the UDL team for assistance.

Request

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

Request body

idstring

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

idSensorstring

Optional ID of the sensor that produced this ground image.

classificationMarkingstring required

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

imageTimestring date-time required

Timestamp the image was captured/produced.

filenamestring required

Name of the image file.

regionstring

Geographical region or polygon (lon/lat pairs) of the image as projected on the ground in geoJSON or geoText format. This is an optional convenience field only used for create operations. The system will auto-detect the format (Well Known Text or GeoJSON) and populate both regionText and regionGeoJSON fields appropriately. When omitted, regionText or regionGeoJSON is expected.

regionTextstring

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 create operation that also specifies a valid region.

regionGeoJSONstring

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. Reference: https://geojson.org/. Ignored if included with a create operation that also specifies a valid region or regionText.

regionTypestring

Type of region as projected on the ground.

regionNDimsinteger

Number of dimensions of the geometry depicted by region.

regionSRidinteger

Geographical spatial_ref_sys for region.

origSensorIdstring

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

subjectIdstring

Optional identifier of the subject/target of the image, useful for correlating multiple images of the same subject.

namestring

Optional name/description associated with this image.

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' | '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.

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.

transactionIdstring

Optional identifier to track a commercial or marketplace transaction executed to produce this 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.

keywordsstring[]

Optional array of keywords for this image.

notesstring

Description and notes of the image.

formatstring

Optional, field indicating type of image, NITF, PNG, etc.

filesizeinteger

Size of the image file. Units in bytes. If filesize is provided without an associated file, it defaults to 0.

checksumValuestring

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

Example request

{
  "id": "GROUNDIMAGERY-ID",
  "idSensor": "SENSOR-ID",
  "classificationMarking": "U",
  "imageTime": "2021-01-01T01:01:01.123456Z",
  "filename": "Example file name",
  "region": "POLYGON((26.156175339112 67.3291113966927,26.0910220642717 67.2580009640721,26.6637992964562 67.1795862381682,26.730115808233 67.2501237475598,26.156175339112 67.3291113966927))",
  "regionText": "POLYGON((67.3291113966927 26.156175339112,67.2580009640721 26.091022064271,67.1795862381682 26.6637992964562,67.2501237475598 26.730115808233,67.3291113966927 26.156175339112))",
  "regionGeoJSON": "{\"type\":\"Polygon\",\"coordinates\":[ [ [ 67.3291113966927, 26.156175339112 ], [ 67.2580009640721, 26.091022064271 ], [ 67.1795862381682, 26.6637992964562 ], [ 67.2501237475598, 26.730115808233 ], [ 67.3291113966927, 26.156175339112 ] ] ] }",
  "regionType": "Polygon",
  "regionNDims": 2,
  "regionSRid": 4326,
  "origSensorId": "ORIGSENSOR-ID",
  "subjectId": "SUBJECT-ID",
  "name": "Example name",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "origNetwork": "OPS1",
  "sourceDL": "AXE",
  "dataMode": "TEST",
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "transactionId": "37bdef1f-5a4f-4776-bee4-7a1e0ec7d35a",
  "tags": [
    "PROVIDER_TAG1",
    "PROVIDER_TAG2"
  ],
  "keywords": [
    "KEYWORD1",
    "KEYWORD2"
  ],
  "notes": "Example notes",
  "format": "PNG",
  "checksumValue": "120EA8A25E5D487BF68B5F7096440019"
}

Response

Success

Changes

  • 45631f9bb3f0Revision changes
    • info

      the request optional property became write-only

  • 75f764c843a9Revision changes
    • breaking

      request body became required

    • info

      api operation id create_50 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.