BLbluestaq
Ephemeris

POST /udl/ephemerisset

Changed on

Service operation intended for initial integration only. Takes a single EphemerisSet as a POST body and ingest into the database. This operation does not persist any Ephemeris Points that may be present in the body of the request. This operation is not intended to be used for automated feeds into UDL.A specific role is required to perform this service operation. Please contact the UDL team for assistance. </br> The following rules apply to this operation:

<h3> * Ephemeris Set numPoints value must correspond exactly to the number of Ephemeris states associated with that Ephemeris Set. The numPoints value is checked against the actual posted number of states and mismatch will result in the post being rejected. * Ephemeris Set pointStartTime and pointEndTime must correspond to the earliest and latest state times, respectively, of the associated Ephemeris states. * Either satNo, idOnOrbit, or origObjectId must be provided. The preferred option is to post with satNo for a cataloged object, and with (only) origObjectId for an unknown, uncataloged, or internal/test object. There are several cases for the logic associated with these fields: + If satNo is provided and correlates to a known UDL sat number then the idOnOrbit will be populated appropriately in addition to the satNo. + If satNo is provided and does not correlate to a known UDL sat number then the provided satNo value will be moved to the origObjectId field and satNo left null. + If origObjectId and a valid satNo or idOnOrbit are provided then both the satNo/idOnOrbit and origObjectId will maintain the provided values. + If only origObjectId is provided then origObjectId will be populated with the posted value. In this case, no checks are made against existing UDL sat numbers. </h3>

Request

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

Request body

idstring

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

classificationMarkingstring required

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

idOnOrbitstring

Unique identifier of the primary satellite on-orbit object.

origObjectIdstring

Optional identifier provided by ephemeris source to indicate the target object of this ephemeris. This may be an internal identifier and not necessarily map to a valid satellite number.

pointStartTimestring date-time required

Start time/first time point of the ephemeris, in ISO 8601 UTC format.

usableStartTimestring date-time

Optional start time of the usable time span for the ephemeris data, in ISO 8601 UTC format with microsecond precision.

pointEndTimestring date-time required

End time/last time point of the ephemeris, in ISO 8601 UTC format.

usableEndTimestring date-time

Optional end time of the usable time span for the ephemeris data, in ISO 8601 UTC format with microsecond precision.

stepSizeinteger

Ephemeris step size, in seconds.

numPointsinteger required

Number of points contained in the ephemeris.

typestring required

The type/purpose of the ephemeris (e.g., CALIBRATION, LAUNCH, MNVR_PLAN, ROUTINE, SCREENING).

pedigreestring

The pedigree of the ephemeris or source data used for ephemeris generation (e.g. DOPPLER, GPS, HYBRID, PROPAGATED, RANGING, SLR).

categorystring required

The source category of the ephemeris (e.g. OWNER_OPERATOR, ANALYST, EXTERNAL).

idStateVectorstring

ID of the State Vector used to generate the ephemeris.

hasMnvrboolean

Boolean indicating whether maneuver(s) are incorporated into the ephemeris.

idManeuversstring[]

Array of the maneuver IDs of all maneuvers incorporated in the ephemeris.

hasCovboolean

Boolean indicating whether covariance data is provided with the ephemeris.

hasAccelboolean

Boolean indicating whether acceleration data is provided with the ephemeris.

centBodystring

The Central Body of the ephemeris. Assumed to be Earth, unless otherwise indicated.

integratorstring

Integrator used in ephemeris generation (e.g. RK7(8), RK8(9), COWELL, TWO-BODY).

geopotentialModelstring

Geopotential model used in ephemeris generation (e.g. EGM-96, WGS-84, WGS-72, JGM-2, GEM-T3), including mm degree zonals, nn degree/order tesserals (e.g. EGM-96 24Z,24T).

dragModelstring

Drag model used in ephemeris generation (e.g. JAC70, MSIS90, NONE, etc.).

lunarSolarboolean

Boolean indicating use of lunar/solar data in ephemeris generation.

solidEarthTidesboolean

Boolean indicating use of solid earth tide data in ephemeris generation.

bDotnumber double

First derivative of ballistic coefficient (m^2/kg-s).

edrnumber double

Model parameter value for energy dissipation rate (EDR), expressed in w/kg.

interpolationstring

The recommended interpolation method for the ephemeris data.

interpolationDegreeinteger

The recommended interpolation degree for the ephemeris data.

filenamestring

Filename of the raw file used to provide the ephemeris data including filetype extension, if applicable. This file may be retrieved using the 'getFile' operation as specified in the 'EphemerisSet' OpenAPI docs.

commentsstring

Additional source provided comments associated with the ephemeris.

descriptionstring

Notes/description of the provided ephemeris. A value of DSTOP signifies the ephemeris were generated using the last observation available.

descriptorstring

Optional source-provided and searchable metadata or descriptor of the data.

referenceFrame'J2000' | 'EFG/TDR' | 'ECR/ECEF' | 'TEME' | 'ITRF' | 'GCRF'

The reference frame of the cartesian orbital states. If the referenceFrame is null it is assumed to be J2000.

covReferenceFrame'J2000' | 'UVW' | 'EFG/TDR' | 'ECR/ECEF' | 'TEME' | 'GCRF'

The reference frame of the covariance matrix elements. If the covReferenceFrame is null it is assumed to be J2000.

createdAtstring date-time

Time the row was created in the database, in UTC.

createdBystring

Application user who created the row in the database.

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.

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.

satNointeger

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

tagsstring[]

Optional array of provider/source specific tags for this data, where each element is no longer than 32 characters, used for implementing data owner conditional access controls to restrict access to the data. Should be left null by data providers unless conditional access controls are coordinated with the UDL team.

transactionIdstring

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

origNetworkstring

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

Example request

{
  "id": "EPHEMERISSET-ID",
  "classificationMarking": "U",
  "idOnOrbit": "ONORBIT-ID",
  "origObjectId": "ORIGOBJECT-ID",
  "pointStartTime": "2018-01-01T16:00:00.123456Z",
  "usableStartTime": "2018-01-01T16:10:00.123456Z",
  "pointEndTime": "2018-01-01T16:00:00.123456Z",
  "usableEndTime": "2018-01-01T20:50:00.123456Z",
  "stepSize": 1,
  "numPoints": 1,
  "type": "LAUNCH",
  "pedigree": "PROPAGATED",
  "category": "ANALYST",
  "idStateVector": "STATEVECTOR-ID",
  "idManeuvers": [
    "EXAMPLE_ID1",
    "EXAMPLE_ID2"
  ],
  "centBody": "Earth",
  "integrator": "COWELL",
  "geopotentialModel": "GEM-T3",
  "dragModel": "JAC70",
  "bDot": 1.1,
  "edr": 1.1,
  "interpolation": "LINEAR",
  "interpolationDegree": 5,
  "filename": "Example file name",
  "comments": "Example notes",
  "description": "Example notes",
  "descriptor": "Example descriptor",
  "referenceFrame": "J2000",
  "covReferenceFrame": "J2000",
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "dataMode": "TEST",
  "satNo": 2,
  "ephemerisList": [
    {
      "id": "EPHEMERIS-ID",
      "classificationMarking": "U",
      "esId": "ES-ID",
      "ts": "2018-01-01T16:00:00.123456Z",
      "xpos": 1.1,
      "ypos": 1.1,
      "zpos": 1.1,
      "xvel": 1.1,
      "yvel": 1.1,
      "zvel": 1.1,
      "xaccel": 1.1,
      "yaccel": 1.1,
      "zaccel": 1.1,
      "cov": [
        1.1,
        2.4,
        3.8,
        4.2,
        5.5,
        6
      ],
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "source": "Bluestaq",
      "dataMode": "TEST",
      "idOnOrbit": "ONORBIT-ID",
      "origObjectId": "ORIGOBJECT-ID",
      "origin": "THIRD_PARTY_DATASOURCE"
    }
  ],
  "tags": [
    "PROVIDER_TAG1",
    "PROVIDER_TAG2"
  ],
  "transactionId": "TRANSACTION-ID",
  "origNetwork": "OPS1"
}

Response

Success

Changes

  • 09bd422d5ac1Revision changes
    • info

      added the new ECR/ECEF enum value to the request property

  • 4e1cbc17e814Revision changes
    • info

      added the new EFG/TDR enum value to the request property

    • info

      added the new GCRF enum value to the request property

    • info

      added the new TEME enum value to the request property

Some revisions have not been checked yet.