BLbluestaq
Observation

GET /udl/obscorrelation/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/obscorrelation/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.

msgTsstring date-time required

Correlation message generation time, in ISO 8601 UTC format with millisecond precision. (YYYY-MM-DDTHH:MM:SS.sssZ)

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.

msgTsstring date-time required

Correlation message generation time, in ISO 8601 UTC format with millisecond precision.

corrType'OBSERVATION' | 'TRACK' required

Indicator of whether the type of correlation is OBSERVATION or TRACK: OBSERVATION: Identifies an observation is being correlated. TRACK: Identifies the entire track of observations is being correlated.

obType'DOA' | 'EO' | 'PASSIVE_RADAR' | 'RADAR' | 'RF' | 'SAR' | 'SOISET' required

Indicator of whether the type of Observation(s) being correlated is DOA, EO, PASSIVE_RADAR, RADAR, RF, SAR, or SOISET: DOA: The observation type being correlated is Difference of Arrival. EO: The observation type being correlated is Electro-Optical. PASSIVE_RADAR: The observation type being correlated is Passive Radar. RADAR: The observation type being correlated is Radar. RF: The observation type being correlated is Radio Frequency. SAR: The observation type being correlated is Synthetic Aperture Radar. SOISET: The observation type being correlated is Space Object Identification Observation Set.

obIdstring required

Identifier of the Observation associated with this Correlation. If corrType=TRACK then this field should reference the first Observation in the track. Note: To retrieve all remaining Observations in the track, the GET query should include this Observation's source and origin field values, along with the trackId.

idParentCorrelationstring

Identifier of the ObsCorrelation record from which this ObsCorrelation record originated. This behavior allows for different source providers/systems to make changes to a given correlation and maintain traceability back to the original correlation.

trackIdstring

Identifier of the Track associated with this ObsCorrelation.

referenceOrbitIdstring required

Identifier of the orbit state used for correlation.

referenceOrbitType'ELSET' | 'ESID' | 'SV' required

Indicator of whether the reference orbit type used for correlation is an ELSET, ESID, or SV: ELSET: The reference orbit type is an Element Set. ESID: The reference orbit type is an Ephemeris Set. SV: The reference orbit type is a State Vector.

algorithmCorrTypestring

Type of algorithm used for this correlation (e.g. ROTAS, GEOMETRIC, STATISTICAL, MAHALANOBIS, AI/ML, OTHER).

corrQualitynumber double

Correlation score ranging from 0.0 to 1.0. A score of 1.0 represents perfect correlation to the orbit of the corresponding satellite, such as when all observation residuals equal 0.

astatinteger

Astrostandard ROTAS correlation result (0 - 4), if applicable. Refer to ROTAS documentation for an explanation of ASTAT values.

satNointeger

Current 18th SDS satellite/catalog number of the target on-orbit object. Useful to know in the case where an observation is correlated to another satellite/catalog number.

origObjectIdstring

Optional identifier indicates the target on-orbit object being correlated. This may be an internal identifier and not necessarily a valid satellite number.

idOnOrbitstring

Identifier of the correlated target on-orbit object, if associated with a valid satNo.

altNamespacestring

Associates one or more alternate catalogs with a source provider or system. Namespaces may be defined by their respective data providers or systems (e.g. JCO, 18SDS, EOSSS, EXO, KBR, KRTL, LeoLabs, NorthStar, SAFRAN, Slingshot).

altObjectIdstring

Alternate unique object ID within the namespace.

altCatalogstring

Name of the alternate catalog.

altUctboolean

Boolean indicating whether the observation or track can be correlated to the alternate object specified under altObjectId. This flag should only be set to true by data providers after an attempt to correlate to an on-orbit object was made and failed. If unable to correlate, the 'origObjectId' field may be populated with an internal data provider specific identifier.

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.

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.

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.

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": "026dd511-8ba5-47d3-9909-836149f87686",
    "classificationMarking": "U",
    "msgTs": "2021-01-01T01:01:01.123Z",
    "corrType": "OBSERVATION",
    "obType": "EO",
    "obId": "e69c6734-30a1-4c4f-8fe2-7187e7012e8c",
    "idParentCorrelation": "ID-PARENT-CORRELATION",
    "trackId": "TRACK-ID",
    "referenceOrbitId": "21826de2-5639-4c2a-b68f-30b67753b983",
    "referenceOrbitType": "ELSET",
    "algorithmCorrType": "ROTAS",
    "corrQuality": 0.96,
    "astat": 2,
    "satNo": 12100,
    "origObjectId": "ORIGOBJECT-ID",
    "idOnOrbit": "ONORBIT-ID",
    "altNamespace": "18SDS",
    "altObjectId": "26900",
    "altCatalog": "CATALOG",
    "tags": [
      "TAG1",
      "TAG2"
    ],
    "transactionId": "TRANSACTION-ID",
    "createdAt": "2021-01-01T01:02:00.123Z",
    "createdBy": "some.user",
    "sourceDL": "AXE",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "dataMode": "TEST"
  }
]

Changes

Some revisions have not been checked yet.