Onorbit

PUT /udl/onorbitdetails/{id}

Changed on

Service operation to update a single OnorbitDetails. An OnorbitDetails is a collection of additional characteristics on an on-orbit object. 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/onorbitdetails/{id}
  • Auth
    none declared

Path parameters

idstring required

The ID of the OnorbitDetails to update.

Request body

idstring

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

idOnOrbitstring required

UUID of the parent Onorbit record.

classificationMarkingstring required

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

lastObTimestring date-time

Time of last reported observation for this object in ISO 8601 UTC with microsecond precision.

vismagnumber double

Current/latest visual magnitude in M.

vismagMinnumber double

Minimum visual magnitude in M.

vismagMaxnumber double

Maximum visual magnitude in M.

vismagMeannumber double

Mean visual magnitude in M.

rcsnumber double

Current/latest radar cross section in meters squared.

rcsMinnumber double

Minimum radar cross section in meters squared.

rcsMaxnumber double

Maximum radar cross section in meters squared.

rcsMeannumber double

Mean radar cross section in meters squared.

bolDeltaVnumber double

The total beginning of life delta V of the spacecraft, in meters per second.

maxDeltaVnumber double

Maximum delta V available for this on-orbit spacecraft, in meters per second.

deltaVUncnumber double

The 1-sigma uncertainty of the total spacecraft delta V, in meters per second.

estDeltaVDurationnumber double

Estimated maximum burn duration for the object, in seconds.

numMissioninteger

The number of distinct missions the spacecraft performs.

missionTypesstring[]

Array of the type of missions the spacecraft performs. Must contain the same number of elements as the value of numMission.

busTypestring

Type of the bus on the spacecraft.

geoSlotnumber double

GEO slot if applicable, in degrees. -180 (West of Prime Meridian) to 180 degrees (East of Prime Meridian). Prime Meridian is 0.

driftRatenumber double

GEO drift rate, if applicable in degrees per day.

dryMassnumber double

Spacecraft dry mass (without fuel or disposables) in kilograms.

additionalMassnumber double

Mass of fuel and disposables at launch time in kilograms.

launchMassMinnumber double

Minimum (estimated) mass of spacecraft and fuel at launch time, in kilograms.

launchMassnumber double

Nominal mass of spacecraft and fuel at launch time, in kilograms.

launchMassMaxnumber double

Maximum (estimated) mass of spacecraft and fuel at launch time, in kilograms.

bolFuelMassnumber double

Spacecraft beginning of life fuel mass, in orbit, in kilograms.

currentMassnumber double

The estimated total current mass of the spacecraft, in kilograms.

totalMassUncnumber double

The 1-sigma uncertainty of the total spacecraft mass, in kilograms.

solarArrayAreanumber double

Spacecraft deployed area of solar array in meters squared.

maneuverableboolean

Boolean indicating whether a spacecraft is maneuverable. Note that a spacecraft may have propulsion capability but may not be maneuverable due to lack of fuel, anomalous condition, or other operational constraints.

fuelRemainingnumber double

Estimated remaining fuel for the object in kilograms.

crossSectionnumber double

Average cross sectional area in meters squared.

busCrossSectionnumber double

Average cross sectional area of the bus in meters squared.

maxRadiusnumber double

Maximum dimension across the spacecraft (e.g., tip-to-tip across the solar panel arrays) in meters.

colaRadiusnumber double

Maximum dimension of the box circumscribing the spacecraft (d = sqrt(aa + bb + c*c) where a is the tip-to-tip dimension, b and c are perpendicular to that.) in meters.

adeptRadiusnumber double

The radius used for long-term debris environment projection analyses that is not as conservative as COLA Radius, in meters.

numDeployableinteger

The number of sub-satellites or deployable objects on the spacecraft.

depNamesstring[]

Array of satellite deployable objects. Must contain the same number of elements as the value of numDeployable.

depEstMassesnumber[]

Array of the estimated mass of each deployable object, in kilograms. Must contain the same number of elements as the value of numDeployable.

depMassUncsnumber[]

Array of the 1-sigma uncertainty of the mass for each deployable object, in kilograms. Must contain the same number of elements as the value of numDeployable.

refSourcestring

The reference source, sources, or URL from which the data in this record was obtained.

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.

lastObSourcestring

The name of the source who last provided an observation for this idOnOrbit.

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.

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.

origNetworkstring

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

Example request

{
  "id": "ONORBITDETAILS-ID",
  "idOnOrbit": "REF-ONORBIT-ID",
  "classificationMarking": "U",
  "lastObTime": "2021-01-01T01:01:01.123456Z",
  "vismag": 10.23,
  "vismagMin": 5.23,
  "vismagMax": 15.23,
  "vismagMean": 10.23,
  "rcs": 10.23,
  "rcsMin": 5.23,
  "rcsMax": 15.23,
  "rcsMean": 10.23,
  "bolDeltaV": 1000.1,
  "maxDeltaV": 10.23,
  "deltaVUnc": 50.1,
  "estDeltaVDuration": 10.23,
  "numMission": 2,
  "missionTypes": [
    "Weather",
    "Space Weather"
  ],
  "busType": "A2100",
  "geoSlot": 90.23,
  "driftRate": 1.23,
  "dryMass": 10.23,
  "additionalMass": 10.23,
  "launchMassMin": 5.23,
  "launchMass": 10.23,
  "launchMassMax": 15.23,
  "bolFuelMass": 10.23,
  "currentMass": 500,
  "totalMassUnc": 50.1,
  "solarArrayArea": 10.23,
  "fuelRemaining": 10.23,
  "crossSection": 10.23,
  "busCrossSection": 10.23,
  "maxRadius": 10.23,
  "colaRadius": 10.23,
  "adeptRadius": 10.23,
  "numDeployable": 2,
  "depNames": [
    "GOES-18A",
    "GOES-18B"
  ],
  "depEstMasses": [
    20,
    21
  ],
  "depMassUncs": [
    10,
    5
  ],
  "refSource": "Wikipedia",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "lastObSource": "THIRD_PARTY_DATASOURCE",
  "dataMode": "TEST",
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "origNetwork": "OPS1"
}

Response

Success

Changes

    • info

      api operation id edit_47 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.