BLbluestaq
Site

GET /udl/airfieldslotconsumption/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/airfieldslotconsumption/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.

startTimestring date-time required

The start of the slot window, in ISO 8601 UTC format. (YYYY-MM-DDTHH:MM:SS.sssZ)

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.

idAirfieldSlotstring required

Unique identifier of the airfield slot for which this slot consumption record is referencing.

status'REQUESTED' | 'APPROVED' | 'DENIED' | 'BLOCKED' | 'OTHER'

Current status of this slot (REQUESTED / APPROVED / DENIED / BLOCKED / OTHER).

occupiedboolean

Flag indicating if the slot is occupied.

consumerstring

Identifying name of the aircraft using this slot. Names are often Prior Permission Required (PPR) numbers or other similar human-readable identifiers.

occAircraftMDSstring

The aircraft Model Design Series designation of the aircraft occupying this slot.

occTailNumberstring

The tail number of the aircraft occupying this slot.

callSignsstring[]

Array of call signs of the aircraft using this slot.

missionIdstring

Mission identifier using this slot according to Mobility Air Forces (MAF) Encode/Decode procedures.

numAircraftinteger required

Number of aircraft using this slot for this time.

occStartTimestring date-time

Time the aircraft began occupying this slot, in ISO 8601 UTC format with millisecond precision.

resAircraftMDSstring

The aircraft Model Design Series designation of the aircraft this slot is reserved for.

resTailNumberstring

The tail number of the aircraft this slot is reserved for.

resTypestring

Indicates the type of reservation (e.g. M for Mission, A for Aircraft, O for Other).

resReasonstring

The reason the slot reservation was made.

resMissionIdstring

Mission identifier reserving this slot according to Mobility Air Forces (MAF) Encode/Decode procedures.

startTimestring date-time required

The start of the slot window, in ISO 8601 UTC format.

endTimestring date-time

The end of the slot window, in ISO 8601 UTC format.

targetTimestring date-time

The desired time for aircraft action such as landing, take off, parking, etc., in ISO 8601 UTC format.

idArrSortiestring

Unique identifier of the sortie arriving at the slot start time.

idDepSortiestring

Unique identifier of the sortie departing at the slot end time.

altArrSortieIdstring

Alternate identifier of the sortie arriving at the slot start time provided by the source.

altDepSortieIdstring

Alternate identifier of the sortie departing at the slot end time provided by the source.

reqCommentstring

Comments from the requester.

appCommentstring

Comments from the approver.

reqOrgstring

Short name of the organization requesting use of this slot.

reqInitialsstring

Initials of the person requesting the use of this slot. Use SYSTEM if this request is auto-generated by an auto-planning system.

appOrgstring

Short name of the organization approving the use of this slot.

appInitialsstring

Initials of the person approving the use of this slot. Use SYSTEM if auto-approved without human involvement.

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 response

[
  {
    "id": "be831d39-1822-da9f-7ace-6cc5643397dc",
    "classificationMarking": "U",
    "idAirfieldSlot": "3136498f-2969-3535-1432-e984b2e2e686",
    "status": "APPROVED",
    "occupied": true,
    "consumer": "APRON1-230401001",
    "occAircraftMDS": "C017A",
    "occTailNumber": "N702JG",
    "callSigns": [
      "RCH123",
      "ABC123",
      "LLS442"
    ],
    "missionId": "AJM123456123",
    "numAircraft": 1,
    "occStartTime": "2023-01-01T01:01:03.123Z",
    "resAircraftMDS": "C017A",
    "resTailNumber": "N702JG",
    "resType": "M",
    "resReason": "Maintenance needed",
    "resMissionId": "AJM123456123",
    "startTime": "2023-01-01T01:01:01.123Z",
    "endTime": "2023-01-01T01:01:01.123Z",
    "targetTime": "2023-01-01T01:01:01.123Z",
    "idArrSortie": "be831d39-1822-da9f-7ace-6cc5643397dc",
    "idDepSortie": "1e6edeec-72e9-aaec-d33c-51147cb5ffdd",
    "altArrSortieId": "ALT-SORTIE-ID",
    "altDepSortieId": "ALT-SORTIE-ID",
    "reqComment": "Sorry for the late notice.",
    "appComment": "The request was denied due to inoperable fuel pumps.",
    "reqOrg": "TACC",
    "reqInitials": "CB",
    "appOrg": "KCHS/BOPS",
    "appInitials": "CB",
    "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
    • breaking

      added the new required query request parameter startTime

    • breaking

      the response property / became optional for the status

    • info

      api operation id findAllTuples_10 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.