BLbluestaq
AirOperations

PUT /udl/flightplan/{id}

Changed on

Service operation to update a single flightplan record. 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/flightplan/{id}
  • Auth
    none declared

Path parameters

idstring required

The ID of the flightplan record to update.

Request body

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.

amcMissionIdstring

Air Mobility Command (AMC) mission identifier according to Mobility Air Forces (MAF) encode/decode procedures.

idSortiestring

The UDL unique identifier of the aircraft sortie associated with this flight plan.

idAircraftstring

The UDL unique identifier of the aircraft associated with this flight plan.

legNuminteger

The leg number of this flight plan.

idDepAirfieldstring

The UDL unique identifier of the departure airfield associated with this flight plan.

depAirfieldstring required

The airfield identifier of the departure location, International Civil Aviation Organization (ICAO) code preferred.

idArrAirfieldstring

The UDL unique identifier of the arrival airfield associated with this flight plan.

arrAirfieldstring required

The airfield identifier of the arrival location, International Civil Aviation Organization (ICAO) code preferred.

externalIdstring

The source ID of the flight plan from the generating system.

genTSstring date-time required

The generation time of this flight plan in ISO 8601 UTC format, with millisecond precision.

aircraftMDSstring

The aircraft Model Design Series (MDS) designation (e.g. E-2C HAWKEYE, F-15 EAGLE, KC-130 HERCULES, etc.) of the aircraft associated with this flight plan. Intended as, but not constrained to, MIL-STD-6016 environment dependent specific type designations.

tailNumberstring

The tail number of the aircraft associated with this flight plan.

callSignstring

The call sign assigned to the aircraft for this flight plan.

statusstring

Status of this flight plan (e.g., ACTIVE, APPROVED, PLANNED, etc.).

wxValidStartstring date-time

The date and time the weather valid period begins in ISO 8601 UTC format, with millisecond precision.

wxValidEndstring date-time

The date and time the weather valid period ends in ISO 8601 UTC format, with millisecond precision.

estDepTimestring date-time

The estimated time of departure for the aircraft, in ISO 8601 UTC format, with millisecond precision.

dragIndexnumber double

The percent degrade due to drag for this aircraft.

fuelDegradenumber double

The fuel degrade percentage used for this mission.

opWeightnumber double

Operating weight of the aircraft in pounds.

msnIndexnumber double

The mission index value for this mission. The mission index is the ratio of time-related cost of aircraft operation to the cost of fuel.

rampFuelnumber double

Total of all fuel required to complete the flight in pounds, including fuel to be dispensed on a refueling mission.

taxiFuelnumber double

Fuel required to start engines and taxi to the end of the runway in pounds.

takeoffFuelnumber double

Fuel at takeoff, which is calculated as the ramp fuel minus the taxi fuel in pounds.

climbFuelnumber double

Fuel required from brake release to Top of Climb in pounds.

climbTimestring

Time required from brake release to Top of Climb expressed as HH:MM.

holdDownFuelnumber double

Additional fuel burned at Top of Climb in pounds.

tocIceFuelnumber double

Additional fuel burned at Top of Climb for icing in pounds.

tocFuelnumber double

Fuel remaining at Top of Climb in pounds.

enrouteFuelnumber double

Fuel required to fly from Top of Climb to Top of Descent in pounds.

enrouteTimestring

Time required to fly from Top of Climb to Top of Descent expressed as HH:MM.

thunderAvoidFuelnumber double

Additional fuel burned at Top of Descent for thunderstorm avoidance in pounds.

todIceFuelnumber double

Additional fuel burned at Top of Descent for icing in pounds.

opConditionFuelnumber double

Additional fuel burned at Top of Descent for the operational condition in pounds.

todFuelnumber double

Fuel remaining at Top of Descent in pounds.

earlyDescentFuelnumber double

Additional fuel burned at landing/missed approach for an early descent in pounds.

arrIceFuelnumber double

Additional fuel burned at landing/missed approach for icing during arrival in pounds.

holdFuelnumber double

Additional fuel burned at the destination for holding in pounds.

holdTimestring

Additional time for holding at the destination expressed as HH:MM.

appLandingFuelnumber double

Fuel burned from the initial approach point to landing in pounds.

burnedFuelnumber double

Fuel planned to be burned during the flight in pounds.

landingFuelnumber double

Fuel planned to be remaining on the airplane at landing in pounds.

minDivertFuelnumber double

The minimum fuel on board required to divert in pounds.

arrAlternate1Fuelnumber double

Fuel required to fly to alternate landing site 1 and land in pounds.

arrAlternate2Fuelnumber double

Fuel required to fly to alternate landing site 2 and land in pounds.

contingencyFuelnumber double

The amount of contingency fuel in pounds.

reserveFuelnumber double

The amount of reserve fuel in pounds.

depressFuelnumber double

The depressurization fuel required to fly from the Equal Time Point to the Last Suitable/First Suitable airfield at depressurization altitude in pounds.

unusableFuelnumber double

The amount of unusable fuel in pounds.

unidentExtraFuelnumber double

The amount of unidentified extra fuel required to get to min landing in pounds.

identExtraFuelnumber double

The amount of identified extra fuel carried and not available in the burn plan in pounds.

remAlternate1Fuelnumber double

Total fuel remaining at alternate landing site 1 in pounds.

remAlternate2Fuelnumber double

Total fuel remaining at alternate landing site 2 in pounds.

enduranceTimestring

Total endurance time based on the fuel on board expressed as HH:MM.

sidstring

Name of the planned Standard Instrument Departure (SID) procedure.

starstring

Name of the planned Standard Terminal Arrival (STAR) procedure.

gpsRAIMstring

The GPS Receiver Autonomous Integrity Monitoring (RAIM) message. A RAIM system assesses the integrity of the GPS signals. This system predicts outages for a specified geographical area. These predictions are based on the location, path, and scheduled GPS satellite outages.

depRunwaystring

The departure runway for this flight.

arrRunwaystring

The arrival runway for this flight.

routeStringstring

The 1801 fileable route of flight string for this flight. The route of flight string contains route designators, significant points, change of speed/altitude, change of flight rules, and cruise climbs.

countryCodesstring[]

Array of country codes for the countries overflown during this flight in ISO 3166-1 Alpha-2 format.

etopsRatingstring

The Extended Operations (ETOPS) rating used to calculate this flight plan.

etopsAirfieldsstring[]

Array of Extended Operations (ETOPS) adequate landing airfields that are within the mission region.

etopsAltAirfieldsstring[]

Array of Extended Operations (ETOPS) alternate suitable landing airfields that are within the mission region.

etopsValWindowstring

The Extended Operations (ETOPS) validity window for the alternate airfield.

plannerRemarkstring

Remarks from the planners concerning this flight plan.

cargoRemarkstring

Remarks about the planned cargo associated with this flight plan.

windFac1number double

Wind factor for the first half of the route. This is the average wind factor from first Top of Climb to the mid-time of the entire route in knots. A positive value indicates a headwind, while a negative value indicates a tailwind.

windFac2number double

Wind factor for the second half of the route. This is the average wind factor from the mid-time of the entire route to last Top of Descent in knots. A positive value indicates a headwind, while a negative value indicates a tailwind.

windFacAvgnumber double

Average wind factor from Top of Climb to Top of Descent in knots. A positive value indicates a headwind, while a negative value indicates a tailwind.

avgTempDevnumber double

Average temperature deviation of the primary, divert, and alternate path for the route between first Top of Climb and last Top of Descent in degrees Celsius.

atcAddressesstring[]

Array of Air Traffic Control (ATC) addresses.

originatorstring

Air Traffic Control address filing the flight plan.

numAircraftinteger

The number of aircraft flying this flight plan.

flightRulesstring

The flight rules this flight plan is being filed under.

flightTypestring

The type of flight (MILITARY, CIVILIAN, etc).

initialCruiseSpeedstring

A character string representation of the initial filed cruise speed for this flight (prepended values of K, N, and M represent kilometers per hour, knots, and Mach, respectively).

initialFlightLevelstring

A character string representation of the initial filed altitude level for this flight (prepended values of F, S, A, and M represent flight level in hundreds of feet, standard metric level in tens of meters, altitude in hundreds of feet, and altitude in tens of meters, respectively).

arrAlternate1string

The first designated alternate arrival airfield, International Civil Aviation Organization (ICAO) code preferred.

arrAlternate2string

The second designated alternate arrival airfield, International Civil Aviation Organization (ICAO) code preferred.

depAlternatestring

The designated alternate departure airfield, International Civil Aviation Organization (ICAO) code preferred.

wakeTurbCatstring

The wake turbulence category for this flight. The categories are assigned by the International Civil Aviation Organization (ICAO) and are based on maximum certified takeoff mass for the purpose of separating aircraft in flight due to wake turbulence. Valid values include LIGHT, MEDIUM, LARGE, HEAVY, and SUPER.

equipmentstring

The list of equipment on the aircraft as defined in the Flight Information Publications (FLIP) General Planning (GP) manual.

notesstring

Additional remarks for air traffic control for this flight.

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 last 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 request

{
  "id": "c44b0a80-9fef-63d9-6267-79037fb93e4c",
  "classificationMarking": "U",
  "amcMissionId": "AJM7939B1123",
  "idSortie": "9d60c1b1-10b1-b2a7-e403-84c5d7eeb170",
  "idAircraft": "4f4a67c6-40fd-11ee-be56-0242ac120002",
  "legNum": 100,
  "idDepAirfield": "2a9020f6-40fd-11ee-be56-0242ac120002",
  "depAirfield": "KSLV",
  "idArrAirfield": "363080c2-40fd-11ee-be56-0242ac120002",
  "arrAirfield": "KCHS",
  "externalId": "AFMAPP20322347140001",
  "genTS": "2023-05-01T01:01:01.123Z",
  "aircraftMDS": "KC-130 HERCULES",
  "tailNumber": "77187",
  "callSign": "HKY629",
  "status": "APPROVED",
  "wxValidStart": "2023-05-01T01:01:01.123Z",
  "wxValidEnd": "2023-05-01T01:01:01.123Z",
  "estDepTime": "2023-05-01T01:01:01.123Z",
  "dragIndex": 16.9,
  "fuelDegrade": 10.3,
  "opWeight": 251830.5,
  "msnIndex": 44.1,
  "rampFuel": 180000.1,
  "taxiFuel": 1500.1,
  "takeoffFuel": 178500.1,
  "climbFuel": 7000.1,
  "climbTime": "00:13",
  "holdDownFuel": 500.1,
  "tocIceFuel": 1000.1,
  "tocFuel": 160000.1,
  "enrouteFuel": 155000.1,
  "enrouteTime": "06:30",
  "thunderAvoidFuel": 1000.1,
  "todIceFuel": 2000.1,
  "opConditionFuel": 5000.1,
  "todFuel": 32000.1,
  "earlyDescentFuel": 500.1,
  "arrIceFuel": 1000.1,
  "holdFuel": 6000.1,
  "holdTime": "01:00",
  "appLandingFuel": 3000.1,
  "burnedFuel": 145000.1,
  "landingFuel": 19000.1,
  "minDivertFuel": 25000.1,
  "arrAlternate1Fuel": 6000.1,
  "arrAlternate2Fuel": 6000.1,
  "contingencyFuel": 3000.1,
  "reserveFuel": 10000.1,
  "depressFuel": 20000.1,
  "unusableFuel": 2300.1,
  "unidentExtraFuel": 5000.1,
  "identExtraFuel": 5000.1,
  "remAlternate1Fuel": 18000.1,
  "remAlternate2Fuel": 18000.1,
  "enduranceTime": "08:45",
  "sid": "RENV3B",
  "star": "ADANA",
  "gpsRAIM": "Failed by FAA SAPT 184022AUG2022",
  "depRunway": "05L",
  "arrRunway": "05L",
  "routeString": "RENV3B RENVI Y86 GOSVA/N0317F260 DCT EVLIT DCT UMUGI DCT NISIX DCT GIGOD DCT DIPEB DCT\nGORPI Z80 TILAV L87 RAKIT Z717 PODUS Z130 MAG/N0298F220 Z20 KENIG/N0319F220 Z20 ORTAG T177\nESEGU Z20 BEBLA DCT MASEK/N0300F200 DCT GISEM/N0319F200 DCT BOMBI/N0276F060 DCT RIDSU DCT",
  "countryCodes": [
    "US",
    "CA",
    "UK"
  ],
  "etopsRating": "85 MINUTES",
  "etopsAirfields": [
    "KHSV",
    "KISP",
    "KBG",
    "LTBS"
  ],
  "etopsAltAirfields": [
    "KHSV",
    "KISP",
    "KBG",
    "LTBS"
  ],
  "etopsValWindow": "LPLA: 0317Z-0722Z",
  "plannerRemark": "Flight plan is good for 2 days before airspace closes over the UK.",
  "cargoRemark": "Expecting 55,000 lbs. If different, call us.",
  "windFac1": -1.1,
  "windFac2": 10.1,
  "windFacAvg": 5.1,
  "avgTempDev": 16.1,
  "atcAddresses": [
    "EYCBZMFO",
    "EUCHZMFP",
    "ETARYXYX",
    "EDUUZVZI"
  ],
  "originator": "ETARYXYX",
  "numAircraft": 1,
  "flightRules": "l",
  "flightType": "MILITARY",
  "initialCruiseSpeed": "N0305",
  "initialFlightLevel": "F270",
  "arrAlternate1": "EDDS",
  "arrAlternate2": "EDDM",
  "depAlternate": "LFPO",
  "wakeTurbCat": "MEDIUM",
  "equipment": "SDFGHIRTUWXYZ/H",
  "notes": "STS/STATE PBN/A1B2B5C2C4D2D4 EUR/PROTECTED",
  "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",
  "airRefuelEvents": [
    {
      "arDegrade": 3.1,
      "arNum": 2,
      "arExchangedFuel": 1500.1,
      "divertFuel": 143000.1,
      "exitFuel": 160000.1
    }
  ],
  "flightPlanMessages": [
    {
      "severity": "SEVERE",
      "wpNum": "20",
      "routePath": "PRIMARY",
      "msgText": "Message text"
    }
  ],
  "flightPlanWaypoints": [
    {
      "type": "COMMENT",
      "waypointName": "KCHS",
      "waypointNum": 20,
      "airway": "W15",
      "arpt": "ARIP",
      "lat": 45.23,
      "lon": 179.1,
      "arId": "AR202",
      "navaid": "HTO",
      "tacanChannel": "83X",
      "vorFreq": 113.6,
      "turbCat": "EXTREME",
      "iceCat": "MODERATE",
      "thunderCat": "MODERATE",
      "alt": 27000.1,
      "tempDev": 12.1,
      "legFuelDegrade": 10.1,
      "legMach": 0.74,
      "legMsnIndex": 65,
      "legDragIndex": 1.2,
      "avgCalAirspeed": 200.1,
      "avgTrueAirspeed": 210.1,
      "avgGroundSpeed": 300.1,
      "priFreq": 357.5,
      "pointWindDir": 165.5,
      "pointWindSpeed": 14.4,
      "avgWindDir": 165.5,
      "avgWindSpeed": 14.4,
      "legWindFac": -32.1,
      "avgDriftAng": -3.2,
      "secFreq": 357.5,
      "magCourse": 338.1,
      "trueCourse": 328.1,
      "magHeading": 212.1,
      "aaTacanChannel": "31/94",
      "zoneDistance": 212.1,
      "totalFlownDistance": 688.1,
      "totalRemDistance": 1288.1,
      "zoneTime": 36.1,
      "totalTime": "08:45",
      "totalTimeRem": "01:43",
      "zoneFuel": 1120.1,
      "totalUsedFuel": 70431.1,
      "totalRemFuel": 30453.1,
      "exchangedFuel": -30400.1,
      "airDistance": 321.1,
      "totalAirDistance": 3251.1,
      "totalWeight": 207123.1,
      "eta": "2023-09-09T01:00:00.123Z",
      "ata": "2023-09-09T01:00:00.123Z",
      "fuelFlow": 17654.1,
      "legAlternate": "KCHS",
      "magVar": -13.2,
      "dayLowAlt": 1500.1,
      "nightLowAlt": 2300.1,
      "nvgLowAlt": 2450.1
    }
  ],
  "flightPlanPointGroups": [
    {
      "pointGroupName": "ETOPS_CF_POINT_1",
      "worstFuelCase": "DEPRESSURIZED ENGINE OUT ETP",
      "lsafName": "LPPD",
      "lsafDistance": 684.1,
      "fsafDistance": 684.1,
      "etopsDistance": 684.1,
      "lsafTime": "01:23",
      "fsafTime": "01:23",
      "etopsTime": "01:23",
      "lsafAvgWindFactor": 13.1,
      "fsafAvgWindFactor": 10.1,
      "etopsAvgWindFactor": 10.1,
      "lsafTempDev": 9.1,
      "fsafTempDev": 9.1,
      "etopsTempDev": 9.1,
      "lsafReqFuel": 50787.1,
      "fsafReqFuel": 50380.1,
      "etopsReqFuel": 4412.1,
      "fromTakeoffTime": "07:29",
      "plannedFuel": 190319.1,
      "fuelCalcAlt": 100.1,
      "fuelCalcSpd": 365.1,
      "avgFuelFlow": 19693.1,
      "flightPlanPoints": [
        {
          "pointName": "CRUISE ALTITUDE ETP",
          "fppLat": 45.23,
          "fppLon": 179.1,
          "fppEta": "2023-09-09T01:00:00.123Z",
          "fppReqFuel": 4250.1
        }
      ]
    }
  ]
}

Response

Success

Changes

Some revisions have not been checked yet.