--- title: "GET /udl/obscorrelation" method: GET path: "/udl/obscorrelation" tags: ["Observation"] --- # GET /udl/obscorrelation `GET /udl/obscorrelation` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/obscorrelation` - Auth: none declared Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (`/udl//queryhelp`) for more details on valid/required query parameter information. ## Query parameters - `msgTs` string, date-time, required - `firstResult` integer - `maxResults` integer ## Response `200` OK - ObsCorrelationAbridged[] - `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. - `msgTs` string, 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. - `obId` string, 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. - `idParentCorrelation` string: 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. - `trackId` string: Identifier of the Track associated with this ObsCorrelation. - `referenceOrbitId` string, 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. - `algorithmCorrType` string: Type of algorithm used for this correlation (e.g. ROTAS, GEOMETRIC, STATISTICAL, MAHALANOBIS, AI/ML, OTHER). - `corrQuality` number, 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. - `astat` integer: Astrostandard ROTAS correlation result (0 - 4), if applicable. Refer to ROTAS documentation for an explanation of ASTAT values. - `satNo` integer: 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. - `origObjectId` string: Optional identifier indicates the target on-orbit object being correlated. This may be an internal identifier and not necessarily a valid satellite number. - `idOnOrbit` string: Identifier of the correlated target on-orbit object, if associated with a valid satNo. - `altNamespace` string: 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). - `altObjectId` string: Alternate unique object ID within the namespace. - `altCatalog` string: Name of the alternate catalog. - `altUct` boolean: 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. - `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 - `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`: 1 info - endpoint added [Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/obscorrelation/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)