--- title: "GET /udl/closelyspacedobjects/{id}" method: GET path: "/udl/closelyspacedobjects/{id}" tags: ["Closely Spaced Objects"] --- # GET /udl/closelyspacedobjects/{id} `GET /udl/closelyspacedobjects/{id}` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/closelyspacedobjects/{id}` - Auth: none declared Service operation to get a single CloselySpacedObjects (CSO) record by its unique ID passed as a path parameter. ## Path parameters - `id` string, required ## Query parameters - `firstResult` integer - `maxResults` integer ## Response `200` OK - CloselySpacedObjectsFull: This collection of services provides operations for manipulating and querying of closely spaced objects (on orbit) operations including docking, rendezvous, proximity and reporting of payload zone engagements observed and characterized over a period of time. - `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. - `extId` string: 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. - `csoState` string, 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. - `idOnOrbit1` string: 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. - `satNo1` integer: Satellite/catalog number of the target on-orbit primary object. - `origObjectId1` string: Optional place holder for an OnOrbit ID that does not exist in UDL. - `idOnOrbit2` string: 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. - `satNo2` integer: Satellite/catalog number of the target on-orbit secondary object. - `origObjectId2` string: Optional place holder for an OnOrbit ID that does not exist in UDL. - `eventType` string, required: The type of event associated with this record. Values include: DOCK, UNDOCK, SEPARATION, RENDEZVOUS, PROXIMITY, PEZ, WEZ. - `eventStartTime` string, date-time, required: Timestamp representing the events start time in ISO 8601 UTC format with millisecond precision. - `eventEndTime` string, date-time: Timestamp representing the events end time in ISO 8601 UTC format with millisecond precision. - `actorSVEpoch` string, date-time: State vector epoch time of the actor satellite in ISO 8601 UTC format with millisecond precision. - `targetSVEpoch` string, date-time: State vector epoch time of the target satellite in ISO 8601 UTC format with millisecond precision. - `idActorSV` string: 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. - `idTargetSV` string: 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. - `analysisEpoch` string, date-time: Epoch time of the beginning of the analysis period in ISO 8601 UTC format with millisecond precision. - `analysisDuration` number, double: Timespan of the rendezvous analysis in seconds. - `durationThreshold` number, double: The threshold of the event duration in seconds. - `rangeThreshold` number, double: The threshold of the event range in kilometers. - `eventIntervalCoverage` number, double: Percentage of the event interval that is within the plane tolerance specified as a percent value between 0 and 100. - `numSubIntervals` integer: The number of oscillations within the event interval which are within the plane tolerance. - `minRange` number, double: Minimum range (apogee and perigee differences) within the event interval measured in kilometers. - `minRangeEpoch` string, date-time: Epoch time of the minimum range occurrence in ISO 8601 UTC format with millisecond precision. - `minRangeAnalysisDuration` number, double: Timespan of satellites within the range tolerance in seconds. - `minPlaneSepAngle` number, 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. - `minPlaneSepEpoch` string, date-time: Epoch time of the minimum in-plane separation angle occurrence in ISO 8601 UTC format with millisecond precision. - `orbitAlignDel` number, double: The change in angle between the angular momentum vectors between the actor and target relative to plane orientation in degrees. - `maxRange` number, double: Maximum range (apogee and perigee differences) within the event interval measured in kilometers. - `csoDetails` CloselySpacedObjectsDetailsFull[]: A collection of orbital metrics for the event at the start and end times, and the mean values of the primary and secondary objects, as well as the deltas between the primary and secondary objects. - `id` string: Unique identifier of the record, auto-generated by the system. - `classificationMarking` string: Classification marking of the data in IC/CAPCO Portion-marked format. - `idCSO` string: Unique identifier of the parent CSO record, auto-populated by the system. - `objectEvent` string, required: The type of object event the metrics apply. Values consist of START, END, MEAN. - `objectType` string, required: The type of the object for which the metrics apply. Values include PRIMARY, SECONDARY, DELTA. - `apogee` number, double: The orbit point furthest from the center of the earth in kilometers. - `perigee` number, double: The orbit point nearest to the center of the earth in kilometers. - `inclination` number, double: The angle between the equator and the orbit when looking from the center of the Earth in degrees from 0 to 180. - `longitude` number, double: The longitude degree of the object measured in degrees from -180 to 180. - `dataMode` 'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE': 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. - `hohmannDeltaV` number, 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. - `inclinationDeltaV` number, 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. - `totalDeltaV` number, double: The Total DeltaV is the sum of the Hohmann and Inclination DeltaVs measured in kilometers per second. - `orbitPlaneTol` number, double: The tolerance value for the difference in the orbital plane measured in degrees. - `rangeTol` number, double: The tolerance value for the range in kilometers. - `deltaVTol` number, double: The tolerance value for the DeltaV, in kilometers per second. - `lonTol` number, double: The tolerance value for the longitude in degrees. - `stationLimLonTol` number, double: The tolerance value for the optimal longitude for station-keeping in degrees. - `relPosMag` number, double: Range of closest approach: relative position magnitude, in kilometers, of the difference in the physical position between the actor and target objects. - `relSpeedMag` number, 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. - `relPos` number[]: Indicates the relative position vector of the event occurrence measured in kilometers. - `relVel` number[]: Indicates the relative velocity vector of the event occurrence measured in kilometers per second. - `indicationSource` string: Identifies the source of the indication, if the latest event info was manually input, not computed. - `notes` string: Contains other descriptive information associated with an indicated event. - `compType` string: Computation type, values (e.g. PLANARALIGNMENT, LONGITUDE). - `contextKeys` string[]: 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. - `contextValues` string[]: 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. - `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 - `404`: Item Not Found - `500`: Internal Server Error ## Changes > 12 revisions in range; 1 could not be searched. - **2026-03-25** `173e4aff893f`: 2 breaking - the `relPos` response property's minItems was decreased from `3` to `0` for the response status `200` - the `relVel` response property's minItems was decreased from `3` to `0` for the response status `200` - **2025-12-15** `7b321e16ea56`: 1 info - endpoint added [Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/closelyspacedobjects/:id/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)