BLbluestaq
Sensor

GET /udl/seradataopticalpayload/tuple

Changed on

Service operation to dynamically query data and only return specified columns/fields. Requested columns are specified by the 'columns' query parameter and should be a comma separated list of valid fields for the specified data type. classificationMarking is always returned. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information. An example URI: /udl/elset/tuple?columns=satNo,period&epoch=>now-5 hours would return the satNo and period of elsets with an epoch greater than 5 hours ago.

Request

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

Query parameters

columnsstring required

Comma-separated list of valid field names for this data type to be returned in the response. Only the fields specified will be returned as well as the classification marking of the data, if applicable. See the ‘queryhelp’ operation for a complete list of possible fields.

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.

spacecraftIdstring required

Seradata ID of the spacecraft (SeradataSpacecraftDetails ID).

idSensorstring

UUID of the Sensor record.

hostedForCompanyOrgIdstring

Hosted for company/Organization Id.

manufacturerOrgIdstring

Manufacturer Organization Id.

imagingPayloadCategorystring

Imaging category for this payload, e.g. Multispectral, Infrared, Panchromatic.

namestring

Sensor name from Seradata, e.g. TOURNESOL, MESSR (Multispectral Self-Scanning Radiometer), AWFI, etc.

spectralBandstring

Spectral Band supported by this payload, e.g. Green, Red, Mid-wave infrared, etc.

spectralFrequencyLimitsstring

Frequency limit for this payload, e.g. 0.51 - 0.59.

numberOfFilmReturnCanistersinteger

Number of film return canisters.

bestResolutionnumber double

Best resolution.

swathWidthnumber double

Swath width in kilometers.

recorderSizestring

Recorder size.

fieldOfViewnumber double

Field of view of this radar in kilometers.

fieldOfRegardnumber double

Field of regard of this radar in degrees.

pointingMethodstring

Point method for this radar, e.g. Spacecraft.

groundStationsstring

Ground Station info for this payload.

groundStationLocationsstring

Ground Station Locations for this payload.

notesstring

Payload notes.

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.

updatedAtstring date-time

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

updatedBystring

Application user who updated 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.

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": "SERADATAOPTICALPAYLOAD-ID",
    "classificationMarking": "U",
    "spacecraftId": "spacecraftId",
    "idSensor": "idSensor",
    "hostedForCompanyOrgId": "hostedForCompanyOrgId",
    "manufacturerOrgId": "manufacturerOrgId",
    "imagingPayloadCategory": "Infrared",
    "name": "TOURNESOL",
    "spectralBand": "Green",
    "spectralFrequencyLimits": "0.51",
    "numberOfFilmReturnCanisters": 1,
    "bestResolution": 1.23,
    "swathWidth": 1.23,
    "recorderSize": "1024",
    "fieldOfView": 1.23,
    "fieldOfRegard": 1.23,
    "pointingMethod": "Spacecraft",
    "groundStations": "groundStations",
    "groundStationLocations": "groundStationLocations",
    "notes": "Sample Notes",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "updatedAt": "2018-01-01T16:00:00.123Z",
    "updatedBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "dataMode": "TEST"
  }
]

Changes

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

  • 75f764c843a9Revision changes
    • breaking

      the / response's property format changed from int32 to int16 for status

    • info

      api operation id findAllTuples_112 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.