--- title: "GET /udl/elset" method: GET path: "/udl/elset" tags: ["Elset"] --- # GET /udl/elset `GET /udl/elset` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/elset` - 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 - `epoch` string, date-time, required - `firstResult` integer - `maxResults` integer ## Response `200` OK - ElsetAbridged[] - `idElset` 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. - `satNo` integer: Satellite/catalog number of the target on-orbit object. - `epoch` string, date-time, required: Elset epoch time in ISO 8601 UTC format, with microsecond precision. - `meanMotion` number, double: Mean motion is the angular speed required for a body to complete one orbit, assuming constant speed in a circular orbit which completes in the same time as the variable speed, elliptical orbit of the actual body. Measured in revolutions per day. - `idOnOrbit` string: Unique identifier of the satellite on-orbit object, if correlated. For the public catalog, the idOnOrbit is typically the satellite number as a string, but may be a UUID for analyst or other unknown or untracked satellites. - `uct` boolean: Boolean indicating this Elset was unable to be correlated to a known object. 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. - `eccentricity` number, double: The orbital eccentricity of an astronomical object is a parameter that determines the amount by which its orbit around another body deviates from a perfect circle. A value of 0 is a circular orbit, values between 0 and 1 form an elliptic orbit, 1 is a parabolic escape orbit, and greater than 1 is a hyperbolic escape orbit. - `inclination` number, double: The angle between the equator and the orbit when looking from the center of the Earth. If the orbit went exactly around the equator from left to right, then the inclination would be 0. The inclination ranges from 0 to 180 degrees. - `raan` number, double: Right ascension of the ascending node, or RAAN is the angle as measured in degrees eastwards (or, as seen from the north, counterclockwise) from the First Point of Aries to the ascending node, which is where the orbit crosses the equator when traveling north. - `argOfPerigee` number, double: The argument of perigee is the angle in degrees formed between the perigee and the ascending node. If the perigee would occur at the ascending node, the argument of perigee would be 0. - `meanAnomaly` number, double: Where the satellite is in its orbital path. The mean anomaly ranges from 0 to 360 degrees. The mean anomaly is referenced to the perigee. If the satellite were at the perigee, the mean anomaly would be 0. - `revNo` integer: The current revolution number. The value is incremented when a satellite crosses the equator on an ascending pass. - `bStar` number, double: The drag term for SGP4 orbital model, used for calculating decay constants for altitude, eccentricity etc, measured in inverse earth radii. - `agom` number, double: AGOM, expressed in m^2/kg, is the value of the (averaged) object Area times the solar radiation pressure coefficient(Gamma) over the object Mass. Applicable only with ephemType4. - `ballisticCoeff` number, double: Ballistic coefficient, in m^2/kg. Applicable only with ephemType4. - `meanMotionDot` number, double: 1st derivative of the mean motion with respect to time. Units are revolutions per day squared. - `meanMotionDDot` number, double: 2nd derivative of the mean motion with respect to time. Units are revolutions per day cubed. - `semiMajorAxis` number, double: The sum of the periapsis and apoapsis distances divided by two. For circular orbits, the semimajor axis is the distance between the centers of the bodies, not the distance of the bodies from the center of mass. Units are kilometers. - `period` number, double: Period of the orbit equal to inverse of mean motion, in minutes. - `apogee` number, double: The orbit point furthest from the center of the earth in kilometers. If not provided, apogee will be computed from the TLE according to the following. Using mu, the standard gravitational parameter for the earth (398600.4418), semi-major axis A = (mu/(n * 2 * pi/(24*3600))^2)(1/3). Using semi-major axis A, eccentricity E, apogee = (A * (1 + E)) in km. Note that the calculations are for computing the apogee radius from the center of the earth, to compute apogee altitude the radius of the earth should be subtracted (6378.135 km). - `perigee` number, double: The orbit point nearest to the center of the earth in kilometers. If not provided, perigee will be computed from the TLE according to the following. Using mu, the standard gravitational parameter for the earth (398600.4418), semi-major axis A = (mu/(n * 2 * pi/(24*3600))^2)(1/3). Using semi-major axis A, eccentricity E, perigee = (A * (1 - E)) in km. Note that the calculations are for computing the perigee radius from the center of the earth, to compute perigee altitude the radius of the earth should be subtracted (6378.135 km). - `origObjectId` string: Optional identifier provided by elset source to indicate the target onorbit object of this elset. This may be an internal identifier and not necessarily map to a valid satellite number. - `idOrbitDetermination` string: Unique identifier of the OD solution record that produced this elset. This ID can be used to obtain additional information on an OrbitDetermination object using the 'get by ID' operation (e.g. /udl/orbitdetermination/{id}). For example, the OrbitDetermination with idOrbitDetermination = abc would be queried as /udl/orbitdetermination/abc. - `line1` string: Read only derived/generated line1 of a legacy TLE (two line element set) format, ignored on create/edit operations. - `line2` string: Read only derived/generated line2 of a legacy TLE (two line element set) format, ignored on create/edit operations. - `descriptor` string: Optional source-provided and searchable metadata or descriptor of the 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. - `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. - `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. - `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. - `algorithm` string: Optional algorithm used to produce this record. - `transactionId` string: Optional identifier to track a commercial or marketplace transaction executed to produce this data. - `ephemType` integer: The ephemeris type associated with this TLE: 0: SGP (or SGP4 with Kozai mean motion) 1: SGP (Kozai mean motion) 2: SGP4 (Brouver mean motion) 3: SDP4 4: SGP4-XP 5: SDP8 6: SP (osculating mean motion) - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system. ## 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-05-29** `4e1cbc17e814`: 2 info - added the new optional `query` request parameter `firstResult` - added the new optional `query` request parameter `maxResults` - **2025-04-16** `75f764c843a9`: 1 breaking, 2 info - the `items/ephemType` response's property format changed from `int32` to `int16` for status `200` - api operation id `findAllWithStream_8` removed and replaced with `` - the endpoint scheme security `BasicAuth` was removed from the API [Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/elset/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)