BLbluestaq
Onorbit

GET /udl/onorbitbattery

Changed on

Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/onorbitbattery
  • Auth
    none declared

Query parameters

firstResultinteger
maxResultsinteger

Response

OK

idstring

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

idOnOrbitstring required

ID of the on-orbit object.

idBatterystring required

ID of the battery.

classificationMarkingstring required

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

quantityinteger

The number of batteries on the spacecraft of the type identified by idBattery.

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.

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.

origNetworkstring

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

Example response

[
  {
    "id": "ONORBITBATTERY-ID",
    "idOnOrbit": "ONORBIT-ID",
    "idBattery": "BATTERY-ID",
    "classificationMarking": "U",
    "quantity": 5,
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "origNetwork": "OPS1",
    "battery": {
      "id": "BATTERY-ID",
      "name": "JAK-BATTERY-1479",
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "source": "Bluestaq",
      "origin": "THIRD_PARTY_DATASOURCE",
      "origNetwork": "OPS1",
      "dataMode": "TEST"
    }
  }
]

Changes

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

  • 75f764c843a9Revision changes
    • info

      api operation id findAll_74 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

    • info

      the response optional property / became not read-only for the status

Some revisions have not been checked yet.