BLbluestaq
Bus

POST /udl/bus

Changed on

Service operation to take a single Bus as a POST body and ingest into the database. 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/bus
  • Auth
    none declared

Request body

idstring

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

namestring required

Name of this bus.

classificationMarkingstring required

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

idEntitystring

ID of the parent entity for this bus.

typestring

Type of this bus.

maxLaunchMassLowernumber double

Maximum mass at launch, lower bounds, in kilograms.

maxLaunchMassUppernumber double

Maximum mass at launch, upper bounds, in kilograms.

maxBOLStationMassnumber double

Maximum mass on station at beginning of life, in kilograms.

avgPayloadMassnumber double

Average mass available on this bus for payloads, in kilograms.

maxPayloadMassnumber double

Maximum payload mass available, in kilograms.

minDryMassnumber double

Minimum mass of this bus without payloads or fuel, in kilograms.

avgDryMassnumber double

Average mass of this bus without payloads or fuel, in kilograms.

medianDryMassnumber double

Median mass of this bus without payloads or fuel, in kilograms.

maxDryMassnumber double

Maximum mass of this bus without payloads or fuel, in kilograms.

minWetMassnumber double

Minimum mass of this bus with fuel, but without payloads, in kilograms.

avgWetMassnumber double

Average mass of this bus with fuel, but without payloads, in kilograms.

medianWetMassnumber double

Median mass of this bus with fuel, but without payloads, in kilograms.

maxWetMassnumber double

Maximum mass of this bus with fuel, but without payloads, in kilograms.

maxBOLPowerLowernumber double

Maximum power at beginning of life, lower bounds, in kilowatts.

maxBOLPowerUppernumber double

Maximum power at beginning of life, upper bounds, in kilowatts.

maxEOLPowerLowernumber double

Maximum power at end of life, lower bounds, in kilowatts.

maxEOLPowerUppernumber double

Maximum power at end of life, upper bounds, in kilowatts.

avgSpacecraftPowernumber double

Average power available on this bus, in kilowatts.

maxSpacecraftPowernumber double

Maximum power available on this bus, in kilowatts.

oapSpacecraftPowernumber double

Orbit averaged power (the power averaged over one orbit) available on this bus, in kilowatts.

avgPayloadPowernumber double

Average power available on this bus for payloads, in kilowatts.

maxPayloadPowernumber double

Maximum payload power available, in kilowatts.

oapPayloadPowernumber double

Orbit averaged power (the power averaged over one orbit) available on this bus for payloads, in kilowatts.

bodyDimensionXnumber double

Body dimension in X direction pertaining to length, in meters.

bodyDimensionYnumber double

Body dimension in Y direction pertaining to height, in meters.

bodyDimensionZnumber double

Body dimension in Z direction pertaining to width, in meters.

payloadDimensionXnumber double

The radial dimension available on this bus for payloads, in meters.

payloadDimensionYnumber double

The in-track dimension available on this bus for payloads, in meters.

payloadDimensionZnumber double

The cross-track dimension available on this bus for payloads, in meters.

payloadVolumenumber double

The volume available on this bus for payloads, in cubic meters.

launchEnvelopeDimensionXnumber double

Launch envelope dimension in X direction, in meters.

launchEnvelopeDimensionYnumber double

Launch envelope dimension in Y direction, in meters.

launchEnvelopeDimensionZnumber double

Launch envelope dimension in Z direction, in meters.

numOrbitTypeinteger

The number of orbit types this bus can support.

orbitTypesstring[]

Array of orbit types this bus can support (e.g. GEO, LEO, etc.). Must contain the same number of elements as the value of numOrbitType.

telemetryTrackingManufacturerOrgIdstring

Unique identifier of the organization which manufactures the telemetry tracking and command subsystem for this bus.

mainComputerManufacturerOrgIdstring

Unique identifier of the organization which manufactures the main onboard computer for this bus.

manufacturerOrgIdstring

Unique identifier of the organization which manufactures this bus.

busKitDesignerOrgIdstring

Unique identifier of the organization which designs the bus kit.

countryCodestring

Country where this bus was manufactured. This value is typically the ISO 3166 Alpha-2 two-character country code, however it can also represent various consortiums that do not appear in the ISO document. The code must correspond to an existing country in the UDL’s country API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code, or alternate code values that exist for the specified country code.

massCategorystring

Mass category of this bus (e.g. 1 - 10 kg: Nanosatellite, 10 - 100 kg: Microsatellite, 100 - 500 kg: Minisatellite, 1000 - 2500kg: Medium satellite, etc.).

powerCategorystring

Power category of this bus (e.g. 0-1kW low power, etc).

genericboolean

Boolean indicating if this bus is generic.

descriptionstring

Notes/description of the bus.

aocsNotesstring

Attitude and Orbital Control Notes/description for the bus.

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.

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.

Example request

{
  "id": "BUS-ID",
  "name": "Example name",
  "classificationMarking": "U",
  "idEntity": "0167f577-e06c-358e-85aa-0a07a730bdd0",
  "type": "Example type",
  "maxLaunchMassLower": 10.1,
  "maxLaunchMassUpper": 10.1,
  "maxBOLStationMass": 10.1,
  "avgPayloadMass": 10.1,
  "maxPayloadMass": 10.1,
  "minDryMass": 2858.1,
  "avgDryMass": 2879.1,
  "medianDryMass": 2950.1,
  "maxDryMass": 2900.1,
  "minWetMass": 5192.1,
  "avgWetMass": 5246.1,
  "medianWetMass": 5260.1,
  "maxWetMass": 5300,
  "maxBOLPowerLower": 10.1,
  "maxBOLPowerUpper": 10.1,
  "maxEOLPowerLower": 10.1,
  "maxEOLPowerUpper": 10.1,
  "avgSpacecraftPower": 10.1,
  "maxSpacecraftPower": 10.1,
  "oapSpacecraftPower": 10.1,
  "avgPayloadPower": 10.1,
  "maxPayloadPower": 10.1,
  "oapPayloadPower": 10.1,
  "bodyDimensionX": 10.1,
  "bodyDimensionY": 10.1,
  "bodyDimensionZ": 10.1,
  "payloadDimensionX": 1.1,
  "payloadDimensionY": 1.1,
  "payloadDimensionZ": 1.1,
  "payloadVolume": 1.1,
  "launchEnvelopeDimensionX": 10.1,
  "launchEnvelopeDimensionY": 10.1,
  "launchEnvelopeDimensionZ": 10.1,
  "numOrbitType": 3,
  "orbitTypes": [
    "LEO",
    "HEO",
    "GEO"
  ],
  "telemetryTrackingManufacturerOrgId": "TELEMETRYTRACKINGMANUFACTURERORG-ID",
  "mainComputerManufacturerOrgId": "MAINCOMPUTERMANUFACTURERORG-ID",
  "manufacturerOrgId": "MANUFACTURERORG-ID",
  "busKitDesignerOrgId": "BUSKITDESIGNERORG-ID",
  "countryCode": "US",
  "massCategory": "Nanosatellite",
  "powerCategory": "low power",
  "description": "Dedicated small spacecraft bus.",
  "aocsNotes": "Example notes",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "origNetwork": "OPS1",
  "dataMode": "TEST",
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "entity": {
    "idEntity": "ENTITY-ID",
    "name": "Example name",
    "classificationMarking": "U",
    "type": "ONORBIT",
    "idLocation": "LOCATION-ID",
    "countryCode": "US",
    "ownerType": "Commercial",
    "urls": [
      "URL1",
      "URL2"
    ],
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "location": {
      "idLocation": "LOCATION-ID",
      "classificationMarking": "U",
      "name": "Example location",
      "countryCode": "US",
      "lat": 45.23,
      "lon": 179.1,
      "altitude": 10.23,
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "source": "Bluestaq",
      "origin": "THIRD_PARTY_DATASOURCE",
      "dataMode": "TEST",
      "origNetwork": "OPS1"
    },
    "onOrbit": {
      "idOnOrbit": "ONORBIT-ID",
      "classificationMarking": "U",
      "satNo": 1,
      "commonName": "Example common name",
      "constellation": "Big Dipper",
      "intlDes": "2021123ABC",
      "launchDate": "2018-01-01",
      "decayDate": "2018-01-01T16:00:00.123Z",
      "objectType": "PAYLOAD",
      "origin": "THIRD_PARTY_DATASOURCE",
      "missionNumber": "Expedition 1",
      "category": "Lunar",
      "lifetimeYears": 10,
      "altName": "Alternate Name",
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "source": "Bluestaq",
      "dataMode": "TEST",
      "launchSiteId": "LAUNCHSITE-ID",
      "countryCode": "US",
      "origNetwork": "OPS1"
    },
    "idOnOrbit": "ONORBIT-ID",
    "idOperatingUnit": "OPERATINGUNIT-ID",
    "origNetwork": "OPS1"
  }
}

Response

Success

Changes

  • 4e1cbc17e814Revision changes
    • info

      added the new LASEREMITTER enum value to the request property /

  • 75f764c843a9Revision changes
    • warning

      the // request property's maxLength was set to 4

    • warning

      the // request property's min was set to 0.00

    • info

      api operation id create_21 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.