BLbluestaq
Observation

POST /udl/sarobservation/createBulk

Changed on

Service operation intended for initial integration only, to take a list of SAR observations as a POST body and ingest into the database. This operation is not intended to be used for automated feeds into UDL. Data providers should contact the UDL team for specific role assignments and for instructions on setting up a permanent feed through an alternate mechanism.

Request

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

Request body

idstring

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

classificationMarkingstring required

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

idOnOrbitstring

Unique identifier of the spacecraft hosting the sensor associated with this collection.

satNointeger

Satellite/Catalog number of the spacecraft hosting the sensor associated with this collection.

origObjectIdstring

Optional identifier provided by the source to indicate the onorbit object hosting the sensor associated with this collection. This may be an internal identifier and not necessarily a valid satellite number.

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.

externalIdstring

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

collectionIdstring

Optional identifier to indicate the specific collection tasking which produced this observation.

detectionIdstring

Identifier of the specific detection within a collection which produced this observation.

collectionStartstring date-time required

Collection start time in ISO 8601 UTC format with microsecond precision.

collectionEndstring date-time required

Collection end time in ISO 8601 UTC format with microsecond precision.

centerTimestring date-time

The datetime at the center point of the collection in ISO 8601 UTC format with microsecond precision.

detectionStartstring date-time

The detection start time in ISO 8601 UTC format, with microsecond precision.

detectionEndstring date-time

The detection end time in ISO 8601 UTC format, with microsecond precision.

dwellTimenumber double

The duration, in seconds, of this detection.

orbitStatestring

The orbital direction (ASCENDING, DESCENDING) of the platform during the collection.

sarModestring required

Collection mode setting for this collection (e.g. AREA, SPOTLIGHT, STRIP, etc.).

operatingBandstring

Name of the band containing operating frequency for the collection (e.g. C, E, EHF, HF, K, Ka, Ku, L, Q, S, SHF, UNK, UHF, V, VHF, VLF, W, X). See RFBandType for more details and descriptions of each band name.

operatingFreqnumber double

The operating frequency, in Mhz, for the collection.

snrnumber double

Signal to noise ratio, in dB.

txPolarizationstring

Transmit polarization e.g. H - (Horizontally Polarized) Perpendicular to Earth's surface, V - (Vertically Polarized) Parallel to Earth's surface, L - (Left Hand Circularly Polarized) Rotating left relative to the earth's surface, R - (Right Hand Circularly Polarized) Rotating right relative to the earth's surface.

rxPolarizationstring

Receive polarization e.g. H - (Horizontally Polarized) Perpendicular to Earth's surface, V - (Vertically Polarized) Parallel to Earth's surface, L - (Left Hand Circularly Polarized) Rotating left relative to the earth's surface, R - (Right Hand Circularly Polarized) Rotating right relative to the earth's surface.

grazeAnglenumber double

The graze angle (also referred to as look angle) for the collection in degrees.

incidenceAnglenumber double

The center incidence angle in degrees.

squintAnglenumber double

The squint angle for the collection in degrees.

pulseBandwidthnumber double

The bandwidth frequency of the pulse in Mhz.

pulseDurationnumber double

The duration of a pulse in seconds.

continuousSpotAnglenumber double

Required sweep angle for the continuous spot scene in degrees.

slantRangenumber double

Slant distance from sensor to center point of imaging event in kilometers.

nearRangenumber double

Specifies the closest range, in kilometers, from the flight path to target during the collection.

farRangenumber double

Specifies the farthest range, in kilometers, from the flight path to target during the collection.

swathLengthnumber double

The length of the collection as projected on the ground in kilometers.

areastring

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

andimsinteger

Number of dimensions of the geometry depicted by region.

asridinteger

Geographical spatial_ref_sys for region.

spacingRangenumber double

The pixel spacing in the range direction measured in meters.

spacingAzimuthnumber double

The pixel spacing in the azimuth direction measured in meters.

looksAzimuthinteger

The number of looks in the azimuth direction.

looksRangeinteger

The number of looks in the range direction.

multilookNumbernumber double

Averages the input synthetic aperture radar (SAR) data by looks in range and azimuth to approximate square pixels, mitigates speckle, and reduces SAR tool processing time.

resolutionRangenumber double

The resolution in the range direction measured in meters.

resolutionAzimuthnumber double

The resolution in the azimuth direction measured in meters.

groundResolutionProjectionnumber double

Distance between independent measurements, representing the physical dimension that represents a pixel of the image.

obDirectionstring

The antenna pointing direction (LEFT, RIGHT).

coordSysstring

The coordinate system used for the sensor velocity and target position vectors for the collection.

targetposxnumber double

The collection target X position in kilometers.

targetposynumber double

The collection target Y position in kilometers.

targetposznumber double

The collection target Z position in kilometers.

senaltnumber double

Sensor altitude during collection in kilometers.

senvelxnumber double

Sensor platform X-velocity during collection in kilometers/second.

senvelynumber double

Sensor platform Y-velocity during collection in kilometers/second.

senvelznumber double

Sensor platform Z-velocity during collection in kilometers/second.

senlatStartnumber double

WGS-84 sensor latitude sub-point at collect start time (collectionStart), represented as -90 to 90 degrees (negative values south of equator).

senlonStartnumber double

WGS-84 sensor longitude sub-point at collect start time (collectionStart), represented as -180 to 180 degrees (negative values west of Prime Meridian).

senlatEndnumber double

WGS-84 sensor latitude sub-point at collect end time (collectionEnd), represented as -90 to 90 degrees (negative values south of equator).

senlonEndnumber double

WGS-84 sensor longitude sub-point at collect end time (collectionEnd), represented as -180 to 180 degrees (negative values west of Prime Meridian).

azimuthAnglenumber double

The azimuth angle, in degrees, of the SAR satellite nadir subpoint measured clockwise from true north at the subpoint.

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.

srcTypsstring[]

Array of UDL record types (e.g. ANALYTICMAGERY, ESID, GROUNDIMAGE, NOTIFICATION, POI, SV, TRACK) that are related to the SAR Observation. 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 SAR Observation. 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/sarobservation/{uuid}).

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

[
  {
    "id": "SAROBSERVATION-ID",
    "classificationMarking": "U",
    "idOnOrbit": "36036",
    "satNo": 36036,
    "origObjectId": "36036",
    "idSensor": "36036-1L",
    "origSensorId": "SMOS-1L",
    "externalId": "EXTERNAL-ID",
    "collectionId": "COLLECTION-ID",
    "detectionId": "DETECTION-ID",
    "collectionStart": "2023-04-22T17:35:00.123456Z",
    "collectionEnd": "2023-04-22T17:38:10.201770Z",
    "centerTime": "2023-04-22T17:36:35.100885Z",
    "detectionStart": "2023-07-08T17:35:01.615396Z",
    "detectionEnd": "2023-07-08T17:35:20.772190Z",
    "dwellTime": 79.156794,
    "orbitState": "ASCENDING",
    "sarMode": "SPOTLIGHT",
    "operatingBand": "L",
    "operatingFreq": 2345.6,
    "snr": 10.1,
    "txPolarization": "H",
    "rxPolarization": "H",
    "grazeAngle": 45.1,
    "incidenceAngle": 45.1,
    "squintAngle": 1.2,
    "pulseBandwidth": 500.1,
    "pulseDuration": 0.000011,
    "continuousSpotAngle": 45.1,
    "slantRange": 60.1,
    "nearRange": 12.1,
    "farRange": 34.1,
    "swathLength": 12.1,
    "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": 3,
    "asrid": 3,
    "spacingRange": 0.123,
    "spacingAzimuth": 0.123,
    "looksAzimuth": 2,
    "looksRange": 1,
    "multilookNumber": 5,
    "resolutionRange": 0.123,
    "resolutionAzimuth": 0.123,
    "groundResolutionProjection": 0.5,
    "obDirection": "RIGHT",
    "coordSys": "ECEF",
    "targetposx": 50.23,
    "targetposy": 50.23,
    "targetposz": 50.23,
    "senalt": 1.1,
    "senvelx": 1.1,
    "senvely": 1.1,
    "senvelz": 1.1,
    "senlatStart": 45.1,
    "senlonStart": 179.1,
    "senlatEnd": 45.1,
    "senlonEnd": 179.1,
    "azimuthAngle": 285.4481793,
    "transactionId": "TRANSACTION-ID",
    "tags": [
      "PROVIDER_TAG1",
      "PROVIDER_TAG2"
    ],
    "srcTyps": [
      "ESID",
      "GROUNDIMAGE"
    ],
    "srcIds": [
      "f7e01cd4-626b-441f-a423-17b160eb78ba",
      "223833c4-be0d-4fdb-a2e4-325a48eccced"
    ],
    "createdAt": "2023-04-22T17:51:40.854Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "sourceDL": "AXE",
    "dataMode": "TEST"
  }
]

Response

Success

Changes

  • 45631f9bb3f0Revision changes
    • info

      the request optional property / became write-only

  • 75f764c843a9Revision changes
    • info

      api operation id createBulks_29 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

Some revisions have not been checked yet.