Onorbit

PUT /udl/objectofinterest/{id}

Changed on Apr 16, 2025

Service operation to update a single ObjectOfInterest. A specific role is required to perform this service operation. Please contact the UDL team for assistance.

Request

Base URL
https://unifieddatalibrary.com
URL
https://unifieddatalibrary.com/udl/objectofinterest/{id}
Auth
none declared

Path parameters

idstring required

The ID of the ObjectOfInterest to update.

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 required

UUID of the parent Onorbit record.

satNointeger

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

namestring

Unique name of the object of interest event.

sensorTaskingStartTimestring date-time required

Sensor tasking start time for object of interest.

sensorTaskingStopTimestring date-time

Sensor tasking stop time for object of interest.

priorityinteger

Priority of the object of interest as an integer (1=highest priority).

statusstring

Status of the object of interest event (e.g. OPEN, CLOSED, CANCELLED).

statusDatestring date-time required

Time of last status change of the object of interest event.

descriptionstring

Description of the object of interest event.

lastObTimestring date-time

Last reported observation time in ISO 8601 UTC time, with microsecond precision.

missedObTimestring date-time

The time at which an attempted observation of the object of interest noticed it was missing, in ISO 8601 UTC time, with microsecond precision.

deltaVsnumber[]

Possible delta V applications for the object of interest, in km/sec.

deltaTsnumber[]

Possible delta time applications for the object of interest, in seconds.

svEpochstring date-time

Last reported state vector epoch time in ISO 8601 UTC time, with microsecond precision.

xnumber double

Last reported x position of the object in km, in J2000 coordinates.

ynumber double

Last reported y position of the object in km, in J2000 coordinates.

znumber double

Last reported z position of the object in km, in J2000 coordinates.

xvelnumber double

Last reported x velocity of the object in km/sec, in J2000 coordinates.

yvelnumber double

Last reported y velocity of the object in km/sec, in J2000 coordinates.

zvelnumber double

Last reported z velocity of the object in km/sec, in J2000 coordinates.

elsetEpochstring date-time

Last reported elset epoch time in ISO 8601 UTC time, with microsecond precision.

meanMotionnumber double

Last reported mean motion of the object. 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.

eccentricitynumber double

Last reported eccentricity of the object. 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

Last reported inclination of the object. Inclination is 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

Last reported raan. 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

Last reported argument of perigee. 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

Last reported meanAnomaly. Mean anomoly is 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 last reported revolution number. The value is incremented when a satellite crosses the equator on an ascending pass.

bStarnumber double

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

meanMotionDotnumber double

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

meanMotionDDotnumber double

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

semiMajorAxisnumber double

Last reported semi major axis, which is 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.

periodnumber double

Last reported orbit period. Period of the orbit is equal to inverse of mean motion.

apogeenumber double

Last reported apogee. The Orbit point furthest from the center of the earth in kilometers.

perigeenumber double

Last reported perigee. The orbit point nearest to the center of the earth in kilometers.

affectedObjectsstring[]

Optional array of Onorbit IDs (idOnOrbit) representing satellites potentially affected by this object of interest.

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.

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 request

{
  "id": "OBJECTOFINTEREST-ID",
  "classificationMarking": "U",
  "idOnOrbit": "REF-ONORBIT-ID",
  "satNo": 12,
  "name": "Example_name",
  "sensorTaskingStartTime": "2021-01-01T01:01:01.123Z",
  "sensorTaskingStopTime": "2021-01-01T01:01:01.123Z",
  "priority": 7,
  "status": "OPEN",
  "statusDate": "2021-01-01T01:01:01.123Z",
  "description": "Example description",
  "lastObTime": "2021-01-01T01:01:01.123456Z",
  "missedObTime": "2021-01-01T01:01:01.123456Z",
  "deltaVs": [
    1.1,
    2.2,
    3.3
  ],
  "deltaTs": [
    1.1,
    2.2,
    3.3
  ],
  "svEpoch": "2021-01-01T01:01:01.123456Z",
  "x": 123.4,
  "y": 123.4,
  "z": 123.4,
  "xvel": 123.4,
  "yvel": 123.4,
  "zvel": 123.4,
  "elsetEpoch": "2021-01-01T01:01:01.123456Z",
  "meanMotion": 123.4,
  "eccentricity": 123.4,
  "inclination": 123.4,
  "raan": 123.4,
  "argOfPerigee": 123.4,
  "meanAnomaly": 123.4,
  "revNo": 123,
  "bStar": 123.4,
  "meanMotionDot": 123.4,
  "meanMotionDDot": 123.4,
  "semiMajorAxis": 123.4,
  "period": 123.4,
  "apogee": 123.4,
  "perigee": 123.4,
  "affectedObjects": [
    "AFFECTEDOBJECT1-ID",
    "AFFECTEDOBJECT2-ID"
  ],
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "origNetwork": "OPS1",
  "dataMode": "TEST"
}

Response

Success

Changes

Apr 16, 202575f764c843a9 Revision changes
- info
  api operation id edit_44 removed and replaced with
- info
  the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.

Operation history