--- title: "GET /udl/bus" method: GET path: "/udl/bus" tags: ["Bus"] --- # GET /udl/bus `GET /udl/bus` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/bus` - Auth: none declared Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (`/udl//queryhelp`) for more details on valid/required query parameter information. ## Query parameters - `firstResult` integer - `maxResults` integer ## Response `200` OK - BusAbridged[] - `id` string: Unique identifier of the record, auto-generated by the system. - `name` string, required: Name of this bus. - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format. - `idEntity` string: ID of the parent entity for this bus. - `type` string: Type of this bus. - `maxLaunchMassLower` number, double: Maximum mass at launch, lower bounds, in kilograms. - `maxLaunchMassUpper` number, double: Maximum mass at launch, upper bounds, in kilograms. - `maxBOLStationMass` number, double: Maximum mass on station at beginning of life, in kilograms. - `avgPayloadMass` number, double: Average mass available on this bus for payloads, in kilograms. - `maxPayloadMass` number, double: Maximum payload mass available, in kilograms. - `minDryMass` number, double: Minimum mass of this bus without payloads or fuel, in kilograms. - `avgDryMass` number, double: Average mass of this bus without payloads or fuel, in kilograms. - `medianDryMass` number, double: Median mass of this bus without payloads or fuel, in kilograms. - `maxDryMass` number, double: Maximum mass of this bus without payloads or fuel, in kilograms. - `minWetMass` number, double: Minimum mass of this bus with fuel, but without payloads, in kilograms. - `avgWetMass` number, double: Average mass of this bus with fuel, but without payloads, in kilograms. - `medianWetMass` number, double: Median mass of this bus with fuel, but without payloads, in kilograms. - `maxWetMass` number, double: Maximum mass of this bus with fuel, but without payloads, in kilograms. - `maxBOLPowerLower` number, double: Maximum power at beginning of life, lower bounds, in kilowatts. - `maxBOLPowerUpper` number, double: Maximum power at beginning of life, upper bounds, in kilowatts. - `maxEOLPowerLower` number, double: Maximum power at end of life, lower bounds, in kilowatts. - `maxEOLPowerUpper` number, double: Maximum power at end of life, upper bounds, in kilowatts. - `avgSpacecraftPower` number, double: Average power available on this bus, in kilowatts. - `maxSpacecraftPower` number, double: Maximum power available on this bus, in kilowatts. - `oapSpacecraftPower` number, double: Orbit averaged power (the power averaged over one orbit) available on this bus, in kilowatts. - `avgPayloadPower` number, double: Average power available on this bus for payloads, in kilowatts. - `maxPayloadPower` number, double: Maximum payload power available, in kilowatts. - `oapPayloadPower` number, double: Orbit averaged power (the power averaged over one orbit) available on this bus for payloads, in kilowatts. - `bodyDimensionX` number, double: Body dimension in X direction pertaining to length, in meters. - `bodyDimensionY` number, double: Body dimension in Y direction pertaining to height, in meters. - `bodyDimensionZ` number, double: Body dimension in Z direction pertaining to width, in meters. - `payloadDimensionX` number, double: The radial dimension available on this bus for payloads, in meters. - `payloadDimensionY` number, double: The in-track dimension available on this bus for payloads, in meters. - `payloadDimensionZ` number, double: The cross-track dimension available on this bus for payloads, in meters. - `payloadVolume` number, double: The volume available on this bus for payloads, in cubic meters. - `launchEnvelopeDimensionX` number, double: Launch envelope dimension in X direction, in meters. - `launchEnvelopeDimensionY` number, double: Launch envelope dimension in Y direction, in meters. - `launchEnvelopeDimensionZ` number, double: Launch envelope dimension in Z direction, in meters. - `numOrbitType` integer: The number of orbit types this bus can support. - `orbitTypes` string[]: 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. - `telemetryTrackingManufacturerOrgId` string: Unique identifier of the organization which manufactures the telemetry tracking and command subsystem for this bus. - `mainComputerManufacturerOrgId` string: Unique identifier of the organization which manufactures the main onboard computer for this bus. - `manufacturerOrgId` string: Unique identifier of the organization which manufactures this bus. - `busKitDesignerOrgId` string: Unique identifier of the organization which designs the bus kit. - `countryCode` string: 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. - `massCategory` string: Mass category of this bus (e.g. 1 - 10 kg: Nanosatellite, 10 - 100 kg: Microsatellite, 100 - 500 kg: Minisatellite, 1000 - 2500kg: Medium satellite, etc.). - `powerCategory` string: Power category of this bus (e.g. 0-1kW low power, etc). - `generic` boolean: Boolean indicating if this bus is generic. - `description` string: Notes/description of the bus. - `aocsNotes` string: Attitude and Orbital Control Notes/description for the bus. - `source` string, required: Source of the data. - `origin` string: 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. - `origNetwork` string: 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. - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system. - `createdBy` string: Application user who created the row in the database, auto-populated by the system. ## Other responses - `400`: Bad Request - `401`: Invalid/Missing User Credentials - `403`: User Is Not Authorized - `405`: Method Not Allowed - `406`: MediaType Not Accepted by Request Headers - `429`: Rate of Requests Exceeds Allowed Limit - `500`: Internal Server Error ## Changes > 12 revisions in range; 1 could not be searched. - **2025-09-26** `45631f9bb3f0`: 1 info - added the optional property `items/orbitTypes` to the response with the `200` status - **2025-05-29** `4e1cbc17e814`: 2 info - added the new optional `query` request parameter `firstResult` - added the new optional `query` request parameter `maxResults` - **2025-04-16** `75f764c843a9`: 2 info - api operation id `findAll_19` removed and replaced with `` - the endpoint scheme security `BasicAuth` was removed from the API [Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/bus/get.md) --- [API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)