BLbluestaq
Elset

GET /udl/elset

Changed on

Service operation to dynamically query 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/elset
  • Auth
    none declared

Query parameters

epochstring date-time required

Elset epoch time in ISO 8601 UTC format, with microsecond precision. (YYYY-MM-DDTHH:MM:SS.ssssssZ)

firstResultinteger
maxResultsinteger

Response

OK

idElsetstring

Unique identifier of the record, auto-generated by the system.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

satNointeger

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

epochstring date-time required

Elset epoch time in ISO 8601 UTC format, with microsecond precision.

meanMotionnumber 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.

idOnOrbitstring

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.

uctboolean

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.

eccentricitynumber 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.

inclinationnumber 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.

raannumber 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.

argOfPerigeenumber 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.

meanAnomalynumber 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.

revNointeger

The current revolution number. The value is incremented when a satellite crosses the equator on an ascending pass.

bStarnumber double

The drag term for SGP4 orbital model, used for calculating decay constants for altitude, eccentricity etc, measured in inverse earth radii.

agomnumber 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.

ballisticCoeffnumber double

Ballistic coefficient, in m^2/kg. Applicable only with ephemType4.

meanMotionDotnumber double

1st derivative of the mean motion with respect to time. Units are revolutions per day squared.

meanMotionDDotnumber double

2nd derivative of the mean motion with respect to time. Units are revolutions per day cubed.

semiMajorAxisnumber 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.

periodnumber double

Period of the orbit equal to inverse of mean motion, in minutes.

apogeenumber 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).

perigeenumber 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).

origObjectIdstring

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.

idOrbitDeterminationstring

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.

line1string

Read only derived/generated line1 of a legacy TLE (two line element set) format, ignored on create/edit operations.

line2string

Read only derived/generated line2 of a legacy TLE (two line element set) format, ignored on create/edit operations.

descriptorstring

Optional source-provided and searchable metadata or descriptor of the 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.

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.

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.

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.

algorithmstring

Optional algorithm used to produce this record.

transactionIdstring

Optional identifier to track a commercial or marketplace transaction executed to produce this data.

ephemTypeinteger

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)

origNetworkstring

The originating source network on which this record was created, auto-populated by the system.

Example response

[
  {
    "idElset": "ELSET-ID",
    "classificationMarking": "U",
    "satNo": 12,
    "epoch": "2018-01-01T16:00:00.123456Z",
    "meanMotion": 1.1,
    "idOnOrbit": "ONORBIT-ID",
    "eccentricity": 0.333,
    "inclination": 45.1,
    "raan": 1.1,
    "argOfPerigee": 1.1,
    "meanAnomaly": 179.1,
    "revNo": 111,
    "bStar": 1.1,
    "agom": 0.0126,
    "ballisticCoeff": 0.00815,
    "meanMotionDot": 1.1,
    "meanMotionDDot": 1.1,
    "semiMajorAxis": 1.1,
    "period": 1.1,
    "apogee": 1.1,
    "perigee": 1.1,
    "origObjectId": "ORIGOBJECT-ID",
    "idOrbitDetermination": "026dd511-8ba5-47d3-9909-836149f87686",
    "line1": "Example line1",
    "line2": "Example line2",
    "descriptor": "Example description",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "origin": "THIRD_PARTY_DATASOURCE",
    "sourceDL": "AXE",
    "source": "Bluestaq",
    "dataMode": "TEST",
    "algorithm": "Example algorithm",
    "transactionId": "TRANSACTION-ID",
    "ephemType": 1,
    "origNetwork": "OPS1"
  }
]

Changes

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

  • 75f764c843a9Revision changes
    • breaking

      the / response's property format changed from int32 to int16 for status

    • info

      api operation id findAllWithStream_8 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.