BLbluestaq
Onorbit

PUT /udl/onorbitevent/{id}

Changed on

Service operation to update a single OnorbitEvent. An OnorbitEvent is an event associated with a particular on-orbit spacecraft including insurance related losses, anomalies and incidents. 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/onorbitevent/{id}
  • Auth
    none declared

Path parameters

idstring required

The ID of the OnorbitEvent 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.

derivedFromstring

The sources or SCG references from which the classification of this data is derived.

declassificationDatestring date-time

The declassification date of this data, in ISO 8601 UTC format.

declassificationStringstring

Declassification string of this data.

idOnOrbitstring

Unique identifier of the on-orbit object for this event.

satNointeger

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

origObjectIdstring

Original object ID or Catalog Number provided by source (may not map to an existing idOnOrbit in UDL).

eventTimestring date-time required

Date/Time of the event. See eventTimeNotes for remarks on the accuracy of the date time.

eventTimeNotesstring

Notes/remarks on the validity/accuracy of the eventTime.

operatorOrgIdstring

Organization ID of the operator of the on-orbit spacecraft at the time of the event.

ownerOrgIdstring

Organization ID of the owner of the on-orbit spacecraft at the time of the event.

lesseeOrgIdstring

Unique identifier of the organization which leases this on-orbit spacecraft.

operatedOnBehalfOfOrgIdstring

Unique identifier of the organization on whose behalf the on-orbit spacecraft is operated.

geoPositionnumber double

GEO position longitude at event time if applicable. Negative values are west.

planeSlotstring

GEO plane slot of the spacecraft at event time.

planeNumberstring

GEO slot plane number/designator of the spacecraft at event time.

positionStatusstring

Position status of the spacecraft at event time (e.g. Stable, Drifting/Tumbling, etc).

untilTimestring date-time

Maximum validity time of the event.

officialLossDatestring date-time

Date time of official loss of the spacecraft.

netAmountnumber double

Net amount of the insurance claim for the event, in USD.

underlyingCausestring

Underlying cause of the event.

capabilityLossnumber double

Spacecraft capability loss incurred, as a fraction of 1.

capacityLossnumber double

Spacecraft capacity loss incurred, as a fraction of 1.

insuranceLossnumber double

Insurance loss incurred, as a fraction of 1.

thirdPartyInsuranceLossnumber double

Insurance loss incurred by 3rd party insurance, in USD.

injuredinteger

Number of humans injured in the event.

killedinteger

Number of humans killed in the event.

lifeLostnumber double

Spacecraft life lost due to the event as a percent/fraction of 1.

ageAtEventnumber double

Spacecraft age at the event in years.

achievedFlightPhasestring

Achieved phase of flight prior to the event.

occurrenceFlightPhasestring

Phase of flight during which the event occurred.

stageAtFaultstring

Faulty stage of flight for the event.

equipmentAtFaultstring

Equipment on the spacecraft which caused the event.

equipmentTypeAtFaultstring

Type of the equipment on the spacecraft which caused the event.

equipmentPartAtFaultstring

Specific part of the equipment on the spacecraft which caused the event.

consequentialEquipmentFailurestring

Additional equipment which failed as a result of faulty equipment on the spacecraft during the event.

inclinedboolean

Boolean indicating if the spacecraft is inclined.

descriptionstring

Notes/description of the event.

remarksstring

Additional remarks on the event description.

insuranceLossNotesstring

Additional insurance notes if the event is an official loss.

capabilityLossNotesstring

Notes on capability loss at the time of event.

insuranceCarriedNotesstring

Additional insurance notes on coverages at the time of event.

equipmentCausingLossNotesstring

Additional notes on the equipment causing the event/loss.

eventTypestring

The type of on-orbit event being reported.

eventResultstring

The result of the reported event.

objectStatusstring

The status of the on-orbit object.

satellitePositionstring

Description of the satellite orbital position or regime.

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.

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": "ONORBITEVENT-ID",
  "classificationMarking": "U",
  "derivedFrom": "DERIVED_SOURCE",
  "declassificationDate": "2021-01-01T01:02:02.123Z",
  "declassificationString": "DECLASS_STRING",
  "idOnOrbit": "ONORBIT-ID",
  "satNo": 1,
  "origObjectId": "ORIGOBJECT-ID",
  "eventTime": "2018-01-01T16:00:00.123Z",
  "eventTimeNotes": "Notes on validity",
  "operatorOrgId": "OPERATORORG-ID",
  "ownerOrgId": "OWNERORG-ID",
  "lesseeOrgId": "LESSEEORG-ID",
  "operatedOnBehalfOfOrgId": "OPERATEDONBEHALFOFORG-ID",
  "geoPosition": 45.23,
  "planeSlot": "example_slot",
  "planeNumber": "PL_1",
  "positionStatus": "Stable",
  "untilTime": "2021-01-01T01:01:01.123Z",
  "officialLossDate": "2021-01-01T01:01:01.123Z",
  "netAmount": 10000.23,
  "underlyingCause": "CAUSE_EXAMPLE",
  "capabilityLoss": 0.5,
  "capacityLoss": 0.5,
  "insuranceLoss": 0.5,
  "thirdPartyInsuranceLoss": 10000.23,
  "injured": 1,
  "killed": 23,
  "lifeLost": 0.5,
  "ageAtEvent": 5.23,
  "achievedFlightPhase": "Phase 2",
  "occurrenceFlightPhase": "Phase 2",
  "stageAtFault": "Phase 2",
  "equipmentAtFault": "Example Equipment",
  "equipmentTypeAtFault": "Example Equipment",
  "equipmentPartAtFault": "Example Equipment",
  "consequentialEquipmentFailure": "Example Equipment",
  "description": "Example notes",
  "remarks": "Example remarks",
  "insuranceLossNotes": "Insurance notes",
  "capabilityLossNotes": "Example notes",
  "insuranceCarriedNotes": "Insurance notes",
  "equipmentCausingLossNotes": "Example notes",
  "eventType": "Type1",
  "eventResult": "Example results",
  "objectStatus": "Status1",
  "satellitePosition": "Example description",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "dataMode": "TEST",
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "origNetwork": "OPS1"
}

Response

Success

Changes

  • 75f764c843a9Revision changes
    • info

      api operation id edit_48 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.