BLbluestaq
AirOperations

POST /udl/airspacecontrolorder

Changed on

Service operation to take a single AirspaceControlOrder record 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/airspacecontrolorder
  • 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.

opExNamestring required

Specifies the unique operation or exercise name, nickname, or codeword assigned to a joint exercise or operation plan.

originatorstring required

The identifier of the originator of this message.

startTimestring date-time required

The start of the effective time period of this airspace control order, in ISO 8601 UTC format with millisecond precision.

stopTimestring date-time

The end of the effective time period of this airspace control order, in ISO 8601 UTC format with millisecond precision.

stopQualifierstring

A qualifier for the end of the effective time period of this airspace control order, such as AFTER, ASOF, NLT, etc. Used with field stopTime to indicate a relative time.

opExInfostring

Supplementary name that can be used to further identify exercise nicknames, or to provide the primary nickname of the option or the alternative of an operational plan.

opExInfoAltstring

The secondary supplementary nickname of the option or the alternative of the operational plan or order.

planOrigNumstring

The official identifier of the military establishment responsible for the operation plan and the identification number assigned to this plan.

serialNumstring

The unique message identifier sequentially assigned by the originator.

monthstring

The month in which the message originated.

qualifierstring

The qualifier which caveats the message status.

qualSNinteger

The serial number associated with the message qualifier.

areaOfValiditystring

Name of the area of the command for which the ACO is valid.

acoSerialNumstring

The serial number of this airspace control order.

geoDatumstring

Specifies the geodetic datum by which the spatial coordinates of the controlled airspace are calculated.

acoCommentsstring

Free text information expressed in natural language.

undLnkTrksstring[]

Array of unique link 16 identifiers that will be assigned to a future airspace control means.

classSourcestring

Markings defining the source material or the original classification authority for the ACO message.

classReasonsstring[]

Mandatory if classSource uses the "IORIG" designator. Must be a REASON FOR CLASSIFICATION code.

downgradeInsDatesstring[]

Markings providing the literal guidance or date for downgrading or declassifying the airspace control order.

declassExemptionCodesstring[]

Coded entries that provide justification for exemption from automatic downgrading or declassification of the airspace control order.

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.

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",
  "opExName": "DESERT WIND",
  "originator": "USCENTCOM",
  "startTime": "2024-01-07T13:55:43.123Z",
  "stopTime": "2024-01-08T13:55:43.123Z",
  "stopQualifier": "AFTER",
  "opExInfo": "CONTROL",
  "opExInfoAlt": "ORANGE",
  "planOrigNum": "SACEUR 106",
  "serialNum": "1201003",
  "month": "OCT",
  "qualifier": "CHG",
  "qualSN": 1,
  "areaOfValidity": "FORT BRAGG",
  "acoSerialNum": "27B",
  "geoDatum": "EUR-T",
  "acoComments": "CHOKE POINTS",
  "airspaceControlOrderReferences": [
    {
      "refSId": "A",
      "refType": "NBC1",
      "refOriginator": "SHAPE",
      "refTs": "2024-01-07T13:55:43.123Z",
      "refSerialNum": "100",
      "refSpecialNotation": "NOTAL",
      "refSICs": [
        "RCA",
        "FN:4503B"
      ]
    }
  ],
  "airspaceControlMeansStatus": [
    {
      "cmStat": "ADD",
      "cmStatId": [
        "DESIGN:B35",
        "NAME:ERMA",
        "RANG:C21-C25"
      ],
      "airspaceControlMeans": [
        {
          "cmType": "ACM:ADAREA",
          "cmId": "DESIG:C34",
          "cmShape": "POLYARC",
          "usage": "USE:AIRCOR",
          "link16Id": "F3356",
          "transAltitude": "18000FT",
          "geoDatumAlt": "NAR",
          "coord0": "152345N0505657E",
          "coord1": "1523N05057E",
          "bearing0": 330,
          "bearing1": 160,
          "radMag0": 30.04,
          "radMag1": 50.12,
          "radMagUnit": "NM",
          "polyCoord": [
            "203632N0594256E",
            "155000N0594815E",
            "155000N0591343E"
          ],
          "trackLeg": 99,
          "widthLeft": 5.2,
          "widthRight": 10.4,
          "width": 15.6,
          "widthUnit": "KM",
          "corrWayPoints": [
            "POB",
            "RDU",
            "IAD"
          ],
          "orbitAlignment": "C",
          "effVDim": "BRRA:GL-100AGL",
          "airspaceTimePeriod": [
            {
              "timeMode": "DISCRETE",
              "timeStart": "141325ZFEB2002",
              "timeEnd": "141325ZFEB2002",
              "intFreq": [
                "WEEKLY"
              ],
              "intDur": [
                "65WK"
              ]
            }
          ],
          "airspaceControlPoint": [
            {
              "ctrlPtType": "CP",
              "ctrlPtName": "APPLE",
              "ctrlPtLocation": "203632N0594256E",
              "ctrlPtAltitude": "BRFL:MSL-FL230"
            }
          ],
          "cntrlAuth": "RHEIN MAIN CP",
          "cntrlAuthFreqs": [
            "125.25MHZ"
          ],
          "genTextInd": "SITUATION",
          "freeText": "1. CAPACITY: MDM TK, 50 VEHICLE CONVOY. 2. CHOKE POINTS: EXIT 5"
        }
      ]
    }
  ],
  "undLnkTrks": [
    "A2467",
    "A3466",
    "AA232"
  ],
  "classSource": "ORIG:USJFCOM",
  "classReasons": [
    "15C",
    "10C"
  ],
  "downgradeInsDates": [
    "NST:AT EXERCISE ENDEX",
    "DATE:25NOV1997"
  ],
  "declassExemptionCodes": [
    "X1",
    "X2"
  ],
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "sourceDL": "AXE",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "origNetwork": "OPS1",
  "dataMode": "TEST"
}

Response

Success

Changes

  • 45631f9bb3f0Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

  • 75f764c843a9Revision changes
    • info

      api operation id create_12 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.