BLbluestaq
AirOperations

POST /udl/aircraftsortie

Changed on

Service operation to take a single AircraftSortie as a POST body and ingest into the database. 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/aircraftsortie
  • Auth
    none declared

Request body

idstring

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

classificationMarkingstring required

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

origSortieIdstring

The sortie identifier provided by the originating source.

idAircraftstring

Unique identifier of the aircraft.

aircraftAltIdstring

Alternate Aircraft Identifier provided by source.

tailNumberstring

The tail number of the aircraft assigned to this sortie.

aircraftMDSstring

The aircraft Model Design Series designation assigned to this sortie.

aircraftADSBstring

The Automatic Dependent Surveillance-Broadcast (ADS-B) device identifier.

sortieDatestring date

The scheduled UTC date for this sortie, in ISO 8601 date-only format (ex. YYYY-MM-DD).

lineNumberinteger

The external system line number of this sortie.

idMissionstring

The unique identifier of the mission to which this sortie is assigned.

missionIdstring

The mission ID according to the source system.

amcMsnNumstring

The Air Mobility Command (AMC) mission number of the sortie.

amcMsnTypestring

The type of mission (e.g. SAAM, CHNL, etc.).

callSignstring

The call sign assigned to the aircraft on this sortie.

jcsPrioritystring

Joint Chiefs of Staff priority of this sortie.

primarySCLstring

The planned primary Standard Conventional Load of the aircraft for this sortie.

secondarySCLstring

The planned secondary Standard Conventional Load of the aircraft for this sortie.

reqConfigstring

Aircraft configuration required for the mission.

cargoConfigstring

Description of the cargo configuration (e.g. C-1, C-2, C-3, DV-1, DV-2, AE-1, etc.) currently on board the aircraft. Configuration meanings are determined by the data source.

fuelReqnumber double

Mass of fuel required for this leg of the sortie, in kilograms.

oxyReqCrewnumber double

Liquid oxygen required on the aircraft for the crew compartment, in liters.

oxyOnCrewnumber double

Liquid oxygen onboard the aircraft for the crew compartment, in liters.

oxyReqPaxnumber double

Liquid oxygen required on the aircraft for the troop compartment, in liters.

oxyOnPaxnumber double

Liquid oxygen onboard the aircraft for the troop compartment, in liters.

alertStatusCodestring

The Alert Status code.

alertStatusinteger

The amount of time allowed between launch order and takeoff, in seconds.

currentStatestring

The current state of this sortie.

depItineraryinteger

The itinerary identifier of the departure location.

depICAOstring

The departure International Civil Aviation Organization (ICAO) of this sortie.

depIATAstring

The departure International Aviation Transport Association (IATA) code of this sortie.

depFAAstring

The departure Federal Aviation Administration (FAA) code of this sortie.

plannedDepTimestring date-time required

The scheduled time that the Aircraft sortie is planned to depart, in ISO 8601 UTC format with millisecond precision.

estDepTimestring date-time

The current estimated time that the Aircraft is planned to depart, in ISO 8601 UTC format with millisecond precision.

actualDepTimestring date-time

The actual departure time, in ISO 8601 UTC format.

estBlockOutTimestring date-time

The estimated time the Aircraft will begin to taxi from its parking position, in ISO 8601 UTC format with millisecond precision.

actualBlockOutTimestring date-time

The actual time the Aircraft begins to taxi from its parking position, in ISO 8601 UTC format with millisecond precision.

depPurposeCodestring

Purpose code at the departure location of this sortie.

arrItineraryinteger

The itinerary identifier of the arrival location.

arrICAOstring

The arrival International Civil Aviation Organization (ICAO) of this sortie.

arrIATAstring

The arrival International Aviation Transport Association (IATA) code of this sortie.

arrFAAstring

The arrival Federal Aviation Administration (FAA) code of this sortie.

plannedArrTimestring date-time

The scheduled time that the Aircraft sortie is planned to arrive, in ISO 8601 UTC format with millisecond precision.

estArrTimestring date-time

The current estimated time that the Aircraft is planned to arrive, in ISO 8601 UTC format with millisecond precision.

actualArrTimestring date-time

The actual arrival time, in ISO 8601 UTC format with millisecond precision.

estBlockInTimestring date-time

The estimated time the Aircraft will come to a complete stop in its parking position, in ISO 8601 UTC format with millisecond precision.

actualBlockInTimestring date-time

The actual time the Aircraft comes to a complete stop in its parking position, in ISO 8601 UTC format with millisecond precision.

arrPurposeCodestring

Purpose code at the arrival location of this sortie.

dhdstring date-time

Due home date by which the aircraft must return to its home station, in ISO 8601 UTC format with millisecond precision.

dhdReasonstring

Reason the aircraft must return to home station by its due home date.

aircraftEventstring

Aircraft event text.

soestring

Indicates the group responsible for recording the completion time of the next event in the sequence of events assigned to this sortie (e.g. OPS - Operations, MX - Maintenance, TR - Transportation, etc.).

legNuminteger

The leg number of this sortie.

flightTimenumber double

The planned flight time for this sortie, in minutes.

gndTimenumber double

Scheduled ground time, in minutes.

rawFileURIstring

When crew papers are associated to this sortie, the system updates this value. This field is the URI location in the document repository of that raw file. To download the raw file, prepend https://udl-hostname/scs/download?id= to this field's value.

papersVersionstring

The version number of the crew paper.

filenamestring

Name of the uploaded PDF.

filesizeinteger

Size of the supporting PDF, in bytes.

paperStatus'PUBLISHED' | 'DELETED' | 'UPDATED' | 'READ'

The status of the supporting document.

pprStatus'NOT REQUIRED' | 'REQUIRED NOT REQUESTED' | 'GRANTED' | 'PENDING'

The prior permission required (PPR) status.

missionUpdatestring date-time

Time the associated mission data was last updated in relation to the aircraft assignment, in ISO 8601 UTC format with millisecond precision. If this time is coming from an external system, it may not sync with the latest mission time associated to this record.

delayCodestring

The primary delay code.

commanderNamestring

The last name of the aircraft commander.

fmDeskNumstring

Desk phone number of the flight manager assigned to the sortie. Null when no flight manager is assigned.

fmNamestring

Last name of the flight manager assigned to the sortie. Null when no flight manager is assigned.

rvnReq'N' | 'R' | 'C6' | 'R6'

Type of Ravens required for this sortie (N - None, R - Raven (Security Team) required, C6 - Consider ravens (Ground time over 6 hours), R6 - Ravens required (Ground time over 6 hours)).

passengersinteger

The number of passengers tasked for this sortie.

parkingLocstring

The POI parking location.

objectiveRemarksstring

Remarks concerning the sortie objective.

aircraftRemarksstring

Remarks concerning the aircraft.

scheduleRemarksstring

Remarks concerning the schedule.

resultRemarksstring

Remarks concerning the results of this sortie.

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.

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 request

{
  "id": "AIRCRAFTSORTIE-ID",
  "classificationMarking": "U",
  "origSortieId": "A0640",
  "idAircraft": "REF-AIRCRAFT-ID",
  "aircraftAltId": "ALT-AIRCRAFT-ID",
  "tailNumber": "Tail_1",
  "aircraftMDS": "C017A",
  "aircraftADSB": "AE123C",
  "sortieDate": "2021-01-01",
  "lineNumber": 99,
  "idMission": "fa18d96e-91ea-60da-a7a8-1af6500066c8",
  "missionId": "ABLE",
  "amcMsnNum": "AJM512571333",
  "amcMsnType": "SAAM",
  "callSign": "BAKER",
  "jcsPriority": "1A3",
  "primarySCL": "ABC",
  "secondarySCL": "ABC",
  "reqConfig": "C-1",
  "cargoConfig": "C-1",
  "fuelReq": 20000.1,
  "oxyReqCrew": 12.3,
  "oxyOnCrew": 12.3,
  "oxyReqPax": 12.3,
  "oxyOnPax": 12.3,
  "alertStatusCode": "C1",
  "alertStatus": 22,
  "currentState": "Park",
  "depItinerary": 100,
  "depICAO": "KCOS",
  "depIATA": "AAA",
  "depFAA": "FAA1",
  "plannedDepTime": "2021-01-01T01:01:01.123Z",
  "estDepTime": "2021-01-01T01:01:01.123Z",
  "actualDepTime": "2021-01-01T01:01:01.123Z",
  "estBlockOutTime": "2021-01-01T00:55:01.123Z",
  "actualBlockOutTime": "2021-01-01T00:55:01.123Z",
  "depPurposeCode": "P",
  "arrItinerary": 101,
  "arrICAO": "KCOS",
  "arrIATA": "AAA",
  "arrFAA": "FAA1",
  "plannedArrTime": "2021-01-01T01:01:01.123Z",
  "estArrTime": "2021-01-01T01:01:01.123Z",
  "actualArrTime": "2021-01-01T01:01:01.123Z",
  "estBlockInTime": "2021-01-01T01:06:01.123Z",
  "actualBlockInTime": "2021-01-01T01:06:01.123Z",
  "arrPurposeCode": "O",
  "dhd": "2021-01-03T01:01:01.123Z",
  "dhdReason": "Due for maintenance",
  "aircraftEvent": "Example event",
  "soe": "OPS",
  "legNum": 14,
  "flightTime": 104.5,
  "gndTime": 387.8,
  "rawFileURI": "Example URI",
  "papersVersion": "1.1",
  "filename": "ExampleFileName",
  "filesize": 12,
  "paperStatus": "PUBLISHED",
  "pprStatus": "PENDING",
  "missionUpdate": "2024-09-09T01:01:01.123Z",
  "delayCode": "500",
  "commanderName": "Smith",
  "fmDeskNum": "7198675309",
  "fmName": "Smith",
  "rvnReq": "R",
  "passengers": 17,
  "parkingLoc": "KCOS",
  "objectiveRemarks": "Some objective remark about aircraft A",
  "aircraftRemarks": "Some remark about aircraft A",
  "scheduleRemarks": "Some schedule remark about aircraft A",
  "resultRemarks": "Some remark about aircraft A",
  "createdAt": "2022-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "sourceDL": "AXE",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "dataMode": "TEST",
  "origNetwork": "OPS1"
}

Response

Success

Changes

  • 75f764c843a9Revision changes
    • info

      api operation id create_5 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.