BLbluestaq
Closely Spaced Objects

GET /udl/closelyspacedobjects/history

Changed on

Service operation to dynamically query historical data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information.

Request

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

Query parameters

columnsstring

optional, fields for retrieval. When omitted, ALL fields are assumed. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid query fields that can be selected.

eventStartTimestring date-time required

Timestamp representing the events start 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.

extIdstring

Unique identifier of the record from the originating system. This field has no meaning within UDL and is provided as a convenience for systems that require tracking of an internal system generated ID.

csoStatestring required

Indicates the current state that characterizes Closely Spaced Objects (CSO) analysis steps and conclusions. Values include: ACTIVE, ACTUAL, CANCELED, CLOSED, COMPLETED, DETECTED, INDICATED, PENDING, PLANNED, POSSIBLE, PREDICTED, SEPARATED, UPDATED.

idOnOrbit1string

Unique identifier of the primary satellite on-orbit object, if correlated. For rendezvous and proximity operations, this is the target on-orbit object. When the secondary object is on the rendezvous capable list, this can be any object.

satNo1integer

Satellite/catalog number of the target on-orbit primary object.

origObjectId1string

Optional place holder for an OnOrbit ID that does not exist in UDL.

idOnOrbit2string

Unique identifier of the secondary satellite on-orbit object, if correlated. For rendezvous and proximity operations, this is the actor. When the primary object is a satellite being protected on the neighborhood watch list (NWL), this can be any object encroaching on the primary.

satNo2integer

Satellite/catalog number of the target on-orbit secondary object.

origObjectId2string

Optional place holder for an OnOrbit ID that does not exist in UDL.

eventTypestring required

The type of event associated with this record. Values include: DOCK, UNDOCK, SEPARATION, RENDEZVOUS, PROXIMITY, PEZ, WEZ.

eventStartTimestring date-time required

Timestamp representing the events start time in ISO 8601 UTC format with millisecond precision.

eventEndTimestring date-time

Timestamp representing the events end time in ISO 8601 UTC format with millisecond precision.

actorSVEpochstring date-time

State vector epoch time of the actor satellite in ISO 8601 UTC format with millisecond precision.

targetSVEpochstring date-time

State vector epoch time of the target satellite in ISO 8601 UTC format with millisecond precision.

idActorSVstring

Optional ID of the UDL State Vector at epoch time of the actor satellite. When performing a create, this id will be ignored in favor of the UDL generated id of the actor state vector.

idTargetSVstring

Optional ID of the UDL State Vector at epoch time of the target satellite. When performing a create, this id will be ignored in favor of the UDL generated id of the target state vector.

analysisEpochstring date-time

Epoch time of the beginning of the analysis period in ISO 8601 UTC format with millisecond precision.

analysisDurationnumber double

Timespan of the rendezvous analysis in seconds.

durationThresholdnumber double

The threshold of the event duration in seconds.

rangeThresholdnumber double

The threshold of the event range in kilometers.

eventIntervalCoveragenumber double

Percentage of the event interval that is within the plane tolerance specified as a percent value between 0 and 100.

numSubIntervalsinteger

The number of oscillations within the event interval which are within the plane tolerance.

minRangenumber double

Minimum range (apogee and perigee differences) within the event interval measured in kilometers.

minRangeEpochstring date-time

Epoch time of the minimum range occurrence in ISO 8601 UTC format with millisecond precision.

minRangeAnalysisDurationnumber double

Timespan of satellites within the range tolerance in seconds.

minPlaneSepAnglenumber double

Minimum angle between the target's position and the projection of the actor's position into the target's nominal orbit plane over the event interval measured in degrees.

minPlaneSepEpochstring date-time

Epoch time of the minimum in-plane separation angle occurrence in ISO 8601 UTC format with millisecond precision.

orbitAlignDelnumber double

The change in angle between the angular momentum vectors between the actor and target relative to plane orientation in degrees.

maxRangenumber double

Maximum range (apogee and perigee differences) within the event interval measured in kilometers.

hohmannDeltaVnumber double

The Hohmann DeltaV (kilometers per second) is the minimum delta velocity for the in-plane orbit change. The in-plane maneuvers change the semi-major axis (perigee and/or apogee). It is the minimum assuming two maneuvers; a lower delta velocity is possible with bi-elliptic transfers involving three maneuvers.

inclinationDeltaVnumber double

The Inclination DeltaV is the minimum delta velocity for the out-of-plane change, assuming alignment of the right ascensions measured in kilometers per second.

totalDeltaVnumber double

The Total DeltaV is the sum of the Hohmann and Inclination DeltaVs measured in kilometers per second.

orbitPlaneTolnumber double

The tolerance value for the difference in the orbital plane measured in degrees.

rangeTolnumber double

The tolerance value for the range in kilometers.

deltaVTolnumber double

The tolerance value for the DeltaV, in kilometers per second.

lonTolnumber double

The tolerance value for the longitude in degrees.

stationLimLonTolnumber double

The tolerance value for the optimal longitude for station-keeping in degrees.

relPosMagnumber double

Range of closest approach: relative position magnitude, in kilometers, of the difference in the physical position between the actor and target objects.

relSpeedMagnumber double

Indicates the closure rate specified as a relative velocity magnitude in kilometers per second of the difference in the velocities between the actor and target objects.

relPosnumber[]

Indicates the relative position vector of the event occurrence measured in kilometers.

relVelnumber[]

Indicates the relative velocity vector of the event occurrence measured in kilometers per second.

indicationSourcestring

Identifies the source of the indication, if the latest event info was manually input, not computed.

notesstring

Contains other descriptive information associated with an indicated event.

compTypestring

Computation type, values (e.g. PLANARALIGNMENT, LONGITUDE).

contextKeysstring[]

An optional string array containing additional data (keys) representing relevant items for context of fields not specifically defined in this schema. This array is paired with the contextValues string array and must contain the same number of items. Please note these fields are intended for contextual use only and do not pertain to core schema information. To ensure proper integration and avoid misuse, coordination of how these fields are populated and consumed is required during onboarding.

contextValuesstring[]

An optional string array containing the values associated with the contextKeys array. This array is paired with the contextKeys string array and must contain the same number of items. Please note these fields are intended for contextual use only and do not pertain to core schema information. To ensure proper integration and avoid misuse, coordination of how these fields are populated and consumed is required during onboarding.

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",
    "extId": "EXTERNAL-ID",
    "csoState": "POSSIBLE",
    "idOnOrbit1": "ONORBIT1-ID",
    "satNo1": 1,
    "origObjectId1": "ORIGONORBIT1-ID",
    "idOnOrbit2": "ONORBIT2-ID",
    "satNo2": 2,
    "origObjectId2": "ORIGONORBIT2-ID",
    "eventType": "RENDEZVOUS",
    "eventStartTime": "2023-11-17T20:18:40.123",
    "eventEndTime": "2023-11-17T20:20:40.123",
    "actorSVEpoch": "2023-11-17T20:19:40.123",
    "targetSVEpoch": "2023-11-17T20:19:40.123",
    "idActorSV": "ACTOR-SV-ID",
    "idTargetSV": "TARGET-SV-ID",
    "analysisEpoch": "2023-11-17T20:18:40.123",
    "analysisDuration": 60.1,
    "durationThreshold": 60.1,
    "rangeThreshold": 0.1,
    "eventIntervalCoverage": 22.3,
    "minRange": 0.5,
    "minRangeEpoch": "2023-11-17T20:19:40.123",
    "minRangeAnalysisDuration": 60.1,
    "minPlaneSepAngle": 30.1,
    "minPlaneSepEpoch": "2023-11-17T20:19:40.341",
    "orbitAlignDel": 12.3,
    "maxRange": 233.266,
    "csoDetails": [
      {
        "id": "026dd511-8ba5-47d3-9909-836149f87686",
        "classificationMarking": "U",
        "idCSO": "CSO-ID",
        "objectEvent": "MEAN",
        "objectType": "DELTA",
        "apogee": 1.1,
        "perigee": 1.1,
        "inclination": 45.1,
        "longitude": 45.1,
        "dataMode": "TEST"
      }
    ],
    "hohmannDeltaV": 0.012,
    "inclinationDeltaV": 0.012,
    "totalDeltaV": 2.46,
    "orbitPlaneTol": 1.23,
    "rangeTol": 0.123,
    "deltaVTol": 0.123,
    "lonTol": 30.1,
    "stationLimLonTol": 12.5,
    "relPosMag": 0.12,
    "relSpeedMag": 1.23,
    "relPos": [
      0.12,
      0.23,
      -0.12
    ],
    "relVel": [
      0.12,
      0.23,
      -0.12
    ],
    "indicationSource": "Manually input",
    "notes": "FREE-TEXT",
    "compType": "LONGITUDE",
    "contextKeys": [
      "MsnID_DescLabel",
      "msnVer",
      "serVer"
    ],
    "contextValues": [
      "MissionID Descriptive Label text",
      "1",
      "001.9b"
    ],
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "sourceDL": "AXE",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "dataMode": "TEST"
  }
]

Changes

  • 173e4aff893fRevision changes
    • breaking

      the / response property's minItems was decreased from 3 to 0 for the response status

    • breaking

      the / response property's minItems was decreased from 3 to 0 for the response status

  • 7b321e16ea56Revision changes
    • info

      endpoint added

Some revisions have not been checked yet.