BLbluestaq
Aircraft

GET /udl/aircraftstatus/tuple

Changed on

Service operation to dynamically query data and only return specified columns/fields. Requested columns are specified by the 'columns' query parameter and should be a comma separated list of valid fields for the specified data type. classificationMarking is always returned. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information. An example URI: /udl/elset/tuple?columns=satNo,period&epoch=>now-5 hours would return the satNo and period of elsets with an epoch greater than 5 hours ago.

Request

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

Query parameters

columnsstring required

Comma-separated list of valid field names for this data type to be returned in the response. Only the fields specified will be returned as well as the classification marking of the data, if applicable. See the ‘queryhelp’ operation for a complete list of possible fields.

firstResultinteger
maxResultsinteger

Response

OK

idstring

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

classificationMarkingstring required

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

idAircraftstring required

Unique identifier of the aircraft.

altAircraftIdstring

Alternate Aircraft Identifier provided by source.

currentStatestring

The current readiness state of the aircraft (e.g. AIRBORNE, ALERTCOCKED, AVAILABLE, BATTLESTATION, RUNWAY ALERT, SUITUP).

idAirfieldstring

If not airborne, the unique identifier of the installation currently hosting the aircraft.

geoLocstring

US Air Force geographic location code of the airfield where the aircraft is located.

previousICAOstring

The International Civil Aviation Organization (ICAO) code at which this aircraft was previously located.

currentICAOstring

The International Civil Aviation Organization (ICAO) code at which this aircraft is currently located or has most recently departed, if airborne.

nextICAOstring

The International Civil Aviation Organization (ICAO) code of the next destination of this aircraft.

flightPhasestring

Current flight phase (e.g. AIR REFUELING, GROUND, LANDING, etc.) of the aircraft.

taStartTimestring date-time

The turnaround start time, in ISO 8601 UTC format with millisecond precision.

earliestTAEndTimestring date-time

The earliest time that turnaround of the aircraft may complete, in ISO 8601 UTC format with millisecond precision.

missionReadinessstring

The Operational Capability of the reported aircraft (ABLE, LOFUEL, UNABLE).

fuelinteger

The mass of fuel remaining on the aircraft, in kilograms.

fuelFunctionstring

Used in conjunction with the fuel field to indicate either burnable or offload fuel.

gunCapableboolean

Flag indicating that the aircraft is capable of making at least one gun pass.

gunRdsTypestring

The type of gun rounds available (e.g. 7.62 MM, 20 MM, 25 MM, etc.).

gunRdsMininteger

The lower bound of the estimated number of gun rounds available.

gunRdsMaxinteger

The upper bound of the estimated number of gun rounds available.

airToAirStatus'OPERATIONAL' | 'NON-OPERATIONAL' | 'OFF'

The status of the air-to-air weapon release system (OPERATIONAL, NON-OPERATIONAL, OFF).

airToGroundStatus'OPERATIONAL' | 'NON-OPERATIONAL' | 'OFF'

The status of the air-to-ground weapon release system (OPERATIONAL, NON-OPERATIONAL, OFF).

inventorystring[]

Array of inventory item(s) for which estimate(s) are available (e.g. AIM-9 SIDEWINDER, AIM-120 AMRAAM, AIM-92 STINGER, CHAFF DECOY, FLARE TP 400, etc.). Intended as, but not constrained to, MIL-STD-6016 environment dependent specific/store type designations. This array must be the same length as inventoryMin and inventoryMax.

inventoryMininteger[]

Array of the lower bound quantity for each of the inventory items. The values in this array must correspond to position index in the inventory array. This array must be the same length as inventory and inventoryMax.

inventoryMaxinteger[]

Array of the upper bound quantity for each of the inventory items. The values in this array must correspond to position index in the inventory array. This array must be the same length as inventory and inventoryMin.

unavailableSysstring[]

List of unavailable systems that would normally be on this aircraft.

additionalSysstring[]

List of additional operational systems on this aircraft beyond what is normally available.

notesstring

Optional notes/comments concerning this aircraft status.

mxRemarkstring

Maintenance pacing remarks assocociated with this aircraft.

maintStatusstring

The maintenance status of the aircraft.

maintStatusDriverstring

Indicates the maintenance discrepancy that drives the current maintenance status.

maintPrioritystring

Indicates the priority of the maintenance effort.

alphaStatusCodestring

Aircraft alpha status code that indicates the aircraft maintenance status estimated by the pilot.

maintStatusUpdatestring date-time

The time of the last maintenance status update, in ISO 8601 UTC format with millisecond precision.

lastInspectionDatestring date-time

Date when the military aircraft inspection was last performed, in ISO 8601 UTC format with millisecond precision.

maintPocstring

Military aircraft maintenance point of contact for this aircraft.

groundStatusstring

The ground status of the aircraft (e.g. ALERT, CREW READY, ENGINE START, HANGAR, etc.).

contaminationStatusstring

The contamination status of the aircraft (e.g. CLEAR, CONTAMINATED, DECONTAMINATED, UNKNOWN, etc.).

fuelStatusstring

The state of the aircraft fuel status (e.g. DELIVERED, DUMPED, EMPTY, FULL, OTHER, REQUESTED, etc.).

lastUpdatedBystring

The name or ID of the external user that updated this status.

troubleshootEticstring date-time

Estimated Time for Completion (ETIC) of an aircraft issue, in ISO 8601 UTC format with millisecond precision. This is the estimated time when the course of action to resolve the issue will be determined.

eticstring date-time

The Expected Time in Commission (ETIC) for this aircraft, in ISO 8601 UTC format with millisecond precision. This is the estimated time when the issue will be resolved.

parkLocationstring

The parking location of this aircraft.

parkLocationSystemstring

The system that designated the parking location (e.g. EMOC, GDSS, PEX, etc.).

idPOIstring

Unique identifier of the Point of Interest (POI) record related to this aircraft status. This will generally represent the location of an aircraft on the ground.

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.

updatedAtstring date-time

Time the row was updated in the database, auto-populated by the system.

updatedBystring

Application user who updated the row in the database, auto-populated by the system.

sourceDLstring

The source data library from which this record was received. This could be a remote or tactical UDL or another data library. If null, the record should be assumed to have originated from the primary Enterprise UDL.

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": "0167f577-e06c-358e-85aa-0a07a730bdd0",
    "classificationMarking": "U",
    "idAircraft": "29232269-e4c2-45c9-aa21-039a33209340",
    "altAircraftId": "ORIG-AIRCRAFT-ID",
    "currentState": "AVAILABLE",
    "idAirfield": "b89430e3-97d9-408c-9c89-fd3840c4b84d",
    "geoLoc": "AJJY",
    "previousICAO": "EGLL",
    "currentICAO": "KCHS",
    "nextICAO": "PHNL",
    "flightPhase": "Landing",
    "taStartTime": "2022-01-01T16:00:00.123Z",
    "earliestTAEndTime": "2022-01-01T16:00:00.123Z",
    "missionReadiness": "ABLE",
    "fuel": 10,
    "fuelFunction": "Burn",
    "gunCapable": true,
    "gunRdsType": "7.62 MM",
    "gunRdsMin": 150,
    "gunRdsMax": 550,
    "airToAirStatus": "OPERATIONAL",
    "airToGroundStatus": "OPERATIONAL",
    "inventory": [
      "AIM-9 SIDEWINDER",
      "AIM-120 AMRAAM"
    ],
    "inventoryMin": [
      1,
      2
    ],
    "inventoryMax": [
      2,
      2
    ],
    "unavailableSys": [
      "CMDS",
      "AOC"
    ],
    "additionalSys": [
      "ATOMS",
      "TUDL",
      "BLOS1"
    ],
    "notes": "Some notes for aircraft A",
    "mxRemark": "COM2 INOP",
    "maintStatus": "maintenance status",
    "maintStatusDriver": "SCREW STUCK IN LEFT NLG TIRE",
    "maintPriority": "1",
    "alphaStatusCode": "A2",
    "maintStatusUpdate": "2022-01-01T16:00:00.123Z",
    "lastInspectionDate": "2024-09-09T16:00:00.123Z",
    "maintPoc": "PSUP NIGHT SHIFT 800-555-4412",
    "groundStatus": "ALERT",
    "contaminationStatus": "CLEAR",
    "fuelStatus": "DELIVERED",
    "lastUpdatedBy": "some.user",
    "troubleshootEtic": "2022-01-01T16:00:00.123Z",
    "etic": "2022-01-01T16:00:00.123Z",
    "parkLocation": "B1",
    "parkLocationSystem": "GDSS",
    "idPOI": "0e52f081-a2e3-4b73-b822-88b882232691",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "updatedAt": "2018-01-01T16:00:00.123Z",
    "updatedBy": "some.user",
    "sourceDL": "AXE",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "origNetwork": "OPS1"
  }
]

Changes

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

  • 75f764c843a9Revision changes
    • breaking

      the / response property's maxLength was increased from 32 to 128 for the response status

    • info

      api operation id findAllTuples_7 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.