BLbluestaq
AirOperations

GET /udl/airevent/{id}

Changed on

Service operation to get a single airevent record by its unique ID passed as a path parameter.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/airevent/{id}
  • Auth
    none declared

Path parameters

idstring required

The ID of the airevent record to retrieve.

Query parameters

firstResultinteger
maxResultsinteger

Response

OK

idstring

Unique identifier of the record, auto-generated by the system if not provided on create operations.

classificationMarkingstring required

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

typestring required

Type of air event (e.g. FUEL TRANSFER, AIR DROP, etc).

idSortiestring

The UDL unique identifier of the sortie associated with this air event.

idMissionstring

The UDL unique identifier of the mission associated with this air event.

externalAirEventIdstring

Optional air event ID from external systems. This field has no meaning within UDL and is provided as a convenience for systems that require tracking of an internal system generated ID.

legNuminteger

Identifies the Itinerary point of a sortie where an air event occurs.

locationstring

The location representing this air event specified as a feature Id. Locations specified include air refueling track Ids and air drop event locations.

arrPurposestring

The purpose of the air event at the arrival location. Can be either descriptive text such as 'fuel onload' or a purpose code specified by the provider, such as 'A'.

plannedArrTimestring date-time

The scheduled arrival time of the aircraft at the air event, in ISO 8601 UTC format with millisecond precision.

estArrTimestring date-time

The current estimated arrival time of the aircraft at the air event, in ISO 8601 UTC format with millisecond precision.

actualArrTimestring date-time

The actual arrival time of the aircraft at the air event, in ISO 8601 UTC format with millisecond precision.

depPurposestring

The purpose of the air event at the departure location. Can be either descriptive text such as 'fuel onload' or a purpose code specified by the provider, such as 'A'.

plannedDepTimestring date-time

The scheduled departure time of the aircraft from the air event, in ISO 8601 UTC format with millisecond precision.

estDepTimestring date-time

The current estimated departure time of the aircraft from the air event, in ISO 8601 UTC format with millisecond precision.

actualDepTimestring date-time

The actual departure time of the aircraft from the air event, in ISO 8601 UTC format with millisecond precision.

externalARTrackIdstring

Optional air refueling track ID from external systems. This field has no meaning within UDL and is provided as a convenience for systems that require tracking of an internal system generated ID.

arTrackIdstring

Identifier of the air refueling track, if applicable.

arTrackNamestring

Name of the air refueling track, if applicable.

rzctstring date-time

The Rendezvous Control Time is the planned time the tanker and receiver aircraft will rendezvous for an en route type air refueling event, in ISO 8601 UTC format, with millisecond precision.

arctstring date-time

The Air Refueling Control Time is the planned time the tanker aircraft will transfer fuel to the receiver aircraft, in ISO 8601 UTC format, with millisecond precision.

baseAltnumber double

Altitude of this air event, in feet.

prioritystring

Priority of this air event.

trackTimenumber double

Length of time the receiver unit has requested for an air event, in hours.

statusCodestring

Status of this air refueling event track reservation. Receivers are responsible for scheduling or reserving air refueling tracks. Possible values are A (Altitude Reservation), R (Reserved), or Q (Questionable).

rzPointstring

Rendezvous point for the tanker and receiver during this air refueling event. Possible values are AN (Anchor Nav Point), AP (Anchor Pattern), CP (Control Point), ET (Entry Point), EX (Exit Point), IP (Initial Point), NC (Nav Check Point).

rzTypestring

Type of rendezvous used for this air refueling event. Possible values are BUD (Buddy), EN (Enroute), GCI (Ground Control), PP (Point Parallel).

arEventTypestring

Type of process used by AMC to schedule this air refueling event. Possible values are A (Matched Long Range), F (Matched AMC Short Notice), N (Unmatched Theater Operation Short Notice (Theater Assets)), R, Unmatched Long Range, S (Soft Air Refueling), T (Matched Theater Operation Short Notice (Theater Assets)), V (Unmatched AMC Short Notice), X (Unmatched Theater Operation Short Notice (AMC Assets)), Y (Matched Theater Operation Short Notice (AMC Assets)), Z (Other Air Refueling).

numTankersinteger

The number of tankers requested for an air refueling event.

revTrackboolean

Flag indicating if the receiver unit has requested flying an air refueling track in both directions.

shortTrackboolean

Flag indicating that the receiver unit has requested flying a short portion of an air refueling track.

cancelledboolean

Flag indicating that this air refueling event has been cancelled.

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.

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.

Example response

{
  "id": "026dd511-8ba5-47d3-9909-836149f87686",
  "classificationMarking": "U",
  "type": "FUEL TRANSFER",
  "idSortie": "b9866c03-2397-4506-8153-852e72d9b54f",
  "idMission": "190dea6d-2a90-45a2-a276-be9047d9b96c",
  "externalAirEventId": "MB014313032022407540",
  "legNum": 825,
  "location": "901EW",
  "arrPurpose": "A",
  "plannedArrTime": "2024-01-07T13:55:43.123Z",
  "estArrTime": "2024-01-07T13:59:48.123Z",
  "actualArrTime": "2024-01-07T14:00:03.123Z",
  "depPurpose": "Q",
  "plannedDepTime": "2024-01-07T14:15:43.123Z",
  "estDepTime": "2024-01-07T14:19:48.123Z",
  "actualDepTime": "2024-01-07T14:17:03.123Z",
  "externalARTrackId": "6418a4b68e5c3896bf024cc79aa4174c",
  "arTrackId": "CH61",
  "arTrackName": "CH61 POST",
  "rzct": "2024-01-07T13:55:43.123Z",
  "arct": "2024-01-07T15:11:27.123Z",
  "baseAlt": 28000.1,
  "priority": "1A2",
  "trackTime": 1.5,
  "statusCode": "R",
  "rzPoint": "AN",
  "rzType": "PP",
  "arEventType": "V",
  "numTankers": 1,
  "revTrack": true,
  "shortTrack": true,
  "tankers": [
    {
      "idTankerSortie": "d833a4bc-756b-41d5-8845-f146fe563387",
      "idTankerMission": "edef700c-9917-4dbf-a153-89ffd4446fe9",
      "idTankerAirfield": "b33955d2-67d3-42be-8316-263e284ce6cc",
      "externalTankerId": "ca673c580fb949a5b733f0e0b67ffab2",
      "tankerCoord": "TTC601",
      "tankerMDS": "KC135R",
      "amcTankerMissionId": "8PH000B1S052",
      "altTankerMissionId": "1UN05201L121",
      "tankerCallSign": "BAKER",
      "tankerOwner": "117ARW",
      "tankerPOC": "JOHN SMITH (555)555-5555",
      "tankerLegNum": 825,
      "tankerDeployedICAO": "KOFF",
      "tankerDeliveryMethod": "DROGUE",
      "fuelOff": 15000000.1,
      "tankerCellPosition": 2,
      "tankerFuelType": "JP8",
      "dualRole": true
    }
  ],
  "receivers": [
    {
      "idReceiverSortie": "1d03e85a-1fb9-4f6e-86a0-593306b6e3f0",
      "idReceiverMission": "ce99757d-f733-461f-8939-3939d4f05946",
      "idReceiverAirfield": "96c4c2ba-a031-4e58-9b8e-3c6fb90a7534",
      "externalReceiverId": "3fb8169f-adc1-4667-acab-8415a012d766",
      "receiverCoord": "TTC601",
      "receiverMDS": "KC135R",
      "amcReceiverMissionId": "8PH000B1S052",
      "altReceiverMissionId": "1UN05201L121",
      "receiverCallSign": "BAKER",
      "receiverOwner": "117ARW",
      "receiverPOC": "JOHN SMITH (555)555-5555",
      "receiverLegNum": 825,
      "receiverDeployedICAO": "KOFF",
      "receiverDeliveryMethod": "DROGUE",
      "fuelOn": 15000000.1,
      "receiverCellPosition": 2,
      "sequenceNum": "1018",
      "recOrg": "AMC",
      "numRecAircraft": 3,
      "receiverFuelType": "JP8",
      "receiverExercise": "NATO19",
      "packageId": "135"
    }
  ],
  "remarks": [
    {
      "externalRemarkId": "23ea2877a6f74d7d8f309567a5896441",
      "text": "Example air event remarks.",
      "date": "2024-01-01T01:01:01.123Z",
      "user": "John Doe"
    }
  ],
  "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",
  "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 find removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.