BLbluestaq
Link Status

POST /udl/datalink

Changed on

Service operation to take a single DataLink 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/datalink
  • Auth
    none declared

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.

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 data link message, in ISO 8601 UTC format with millisecond precision.

stopTimestring date-time

The end of the effective time period of this data link message, in ISO 8601 UTC format with millisecond precision. This may be a relative stop time if used with stopTimeMod.

stopTimeModstring

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

planOrigNumstring

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

opExInfostring

Provides an additional caveat further identifying the exercise or modifies the exercise nickname.

opExInfoAltstring

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

serialNumstring

The unique message identifier assigned by the originator.

monthstring

The month in which this message originated.

qualifierstring

The qualifier which caveats the message status such as AMP (Amplification), CHG (Change), etc.

qualSNinteger

The serial number associated with the message qualifier.

canxIdstring

The identifier for this data link message cancellation.

canxOriginatorstring

The originator of this data link message cancellation.

canxTsstring date-time

Timestamp of the data link message cancellation, in ISO 8601 UTC format with millisecond precision.

canxSerialNumstring

Serial number assigned to this data link message cancellation.

canxSpecialNotationstring

Indicates any special actions, restrictions, guidance, or information relating to this data link message cancellation.

canxSICsstring[]

Array of NATO Subject Indicator Codes (SIC) or filing numbers of this data link message or document being cancelled.

pocNamestring

The name of the point of contact for this data link message.

pocRankstring

The rank or position of the point of contact for this data link message in a military or civilian organization.

pocCallSignstring

The unit identifier or call sign of the point of contact for this data link message.

pocLocNamestring

The location name of the point of contact for this data link message.

pocLatnumber double

WGS84 latitude of the point of contact for this data link message, in degrees. -90 to 90 degrees (negative values south of equator).

pocLonnumber double

WGS84 longitude of the point of contact for this data link message, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

pocNumsstring[]

Array of telephone numbers, radio frequency values, or email addresses of the point of contact for this data link message.

geoDatumstring

The code for the point of reference from which the coordinates and networks are computed.

sysDefaultCodestring

Indicates the data terminal settings the system defaults to, either automatic correlation/decorrelation (AUTO) or manual (MAN).

winSizeMultnumber double

The correlation window size multiplier to stretch or reduce the window size. Required if sysDefaultCode field is "MAN". Allowable entries are 0.5 to 3.0 in increments of 0.1.

winSizeMinnumber double

Number added to the basic window calculated from track qualities to ensure that windows still allow valid correlations. Required if sysDefaultCode field is "MAN". Allowable entries are 0.0 to 2.0 in increments of 0.25.

minTrackQualinteger

Track quality to prevent correlation windows from being unrealistically large. Required if sysDefaultCode field is "MAN". Allowable entries are integers from 3 to 7.

maxTrackQualinteger

Track quality to prevent correlation windows from being unrealistically small. Required if sysDefaultCode field is "MAN". Allowable entries are integers from 8 to 15.

resTrackQualinteger

Track quality to enter if too many duals involving low track quality tracks are occurring. Required if sysDefaultCode field is "MAN". Allowable entries are integers from 2 to 6.

courseDiffinteger

Maximum difference between the reported course of the remote track and the calculated course of the local track. Required if sysDefaultCode field is "MAN". Allowable entries are 15 to 90 in increments of 15 degrees.

speedDiffinteger

Maximum percentage the faster track speed may differ from the slower track speed. Required if sysDefaultCode field is "MAN". Allowable entries are 10 to 100 in increments of 10.

altDiffinteger

Maximum altitude difference between two air tracks, in thousands of feet. Required if sysDefaultCode field is "MAN". Allowable entires are 5 to 50 in increments of 5000 feet.

minGeoPosQualinteger

Number used for minimum geodetic position quality. Required if sysDefaultCode field is "MAN". Allowable entries are integers from 1 to 5.

maxGeoPosQualinteger

Number used for maximum geodetic position quality. Required if sysDefaultCode field is "MAN". Allowable entires are integers from 1 to 15.

decorrWinMultnumber double

Distance between the common and remote track is to exceed the applicable correlation window for the two tracks in order to be decorrelated. Required if sysDefaultCode field is "MAN". Allowable entries are 1.0 to 2.0 in increments of 0.1.

consecDecorrinteger

Number of consecutive remote track reports that must meet the decorrelation criteria before the decorrelation is executed. Required if sysDefaultCode field is "MAN". Allowable entries are integers from 1 to 5.

jreUnitDesstring

Designator of the unit for Joint Range Extension (JRE).

jreCallSignstring

Call sign which identifies one or more communications facilities, commands, authorities, or activities for Joint Range Extension (JRE) units.

jrePriAddinteger

Link-16 octal track number assigned as the primary JTIDS unit address.

jreSecAddinteger

Link-16 octal track number assigned as the secondary JTIDS unit address.

jreDetailsstring

Joint Range Extension (JRE) unit details.

nonLinkUnitDesstring[]

Array of non-link specific data unit designators.

trackNumBlockLLsinteger[]

Array of Link-16 octal track numbers used as the lower limit of a track block.

trackNumBlocksstring[]

Array of defined ranges of Link-11/11B track numbers assigned to a participating unit or reporting unit.

mgmtCodestring

Data link management code word.

mgmtCodeMeaningstring

Data link management code word meaning.

ackReqboolean

Flag Indicating if formal acknowledgement is required for the particular data link message being sent.

ackInstUnitsstring[]

Array of instructions for acknowledging and the force or units required to acknowledge the data link message being sent.

classSourcestring

Markings that define the source material or the original classification authority for this data link message.

classReasonsstring[]

Array of codes that indicate the reasons material is classified.

decInstDatesstring[]

Array of markings that provide the literal guidance or dates for the downgrading or declassification of this data link message.

decExemptCodesstring[]

Array of codes that provide justification for exemption from automatic downgrading or declassification.

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 request

{
  "id": "026dd511-8ba5-47d3-9909-836149f87686",
  "classificationMarking": "U",
  "opExName": "DESERT WIND",
  "originator": "USCENTCOM",
  "startTime": "2024-01-07T13:55:43.123Z",
  "stopTime": "2024-01-08T13:55:43.123Z",
  "stopTimeMod": "AFTER",
  "planOrigNum": "SACEUR 106",
  "opExInfo": "CONTROL",
  "opExInfoAlt": "ORANGE",
  "serialNum": "1201003",
  "month": "OCT",
  "qualifier": "CHG",
  "qualSN": 1,
  "references": [
    {
      "refSerialId": "A",
      "refType": "ABSTAT",
      "refOriginator": "CENTCOM",
      "refTs": "2024-01-07T13:55:43.123Z",
      "refSerialNum": "1402001",
      "refSpecialNotation": "NOTAL",
      "refSICs": [
        "RDU",
        "C-123-92"
      ]
    }
  ],
  "canxId": "ABSTAT",
  "canxOriginator": "505 AOC",
  "canxTs": "2024-01-07T13:55:43.123Z",
  "canxSerialNum": "ABC1234567",
  "canxSpecialNotation": "PASEP",
  "canxSICs": [
    "RDU",
    "X234BS"
  ],
  "pocName": "F. BURNS",
  "pocRank": "MAJ",
  "pocCallSign": "4077 MASH",
  "pocLocName": "CAMP SWAMPY",
  "pocLat": 45.23,
  "pocLon": 179.1,
  "pocNums": [
    "TEL:804-555-4142",
    "TEL:804-867-5309"
  ],
  "geoDatum": "EUR-T",
  "refPoints": [
    {
      "refPointType": "DLRP",
      "refDes": "L5",
      "refLocName": "FORT BRAGG",
      "refLat": 45.23,
      "refLon": 179.1,
      "effEventTime": "2024-01-08T13:55:43.123Z"
    }
  ],
  "voiceCoord": [
    {
      "voiceNetDes": "VPN",
      "freqDes": "ST300A",
      "commPri": "P",
      "teleFreqNums": [
        "TEL:804-555-4142",
        "TEL:804-867-5309"
      ]
    }
  ],
  "sysDefaultCode": "MAN",
  "winSizeMult": 2.1,
  "winSizeMin": 1.25,
  "minTrackQual": 6,
  "maxTrackQual": 12,
  "resTrackQual": 3,
  "courseDiff": 60,
  "speedDiff": 50,
  "altDiff": 20,
  "minGeoPosQual": 3,
  "maxGeoPosQual": 12,
  "decorrWinMult": 1.7,
  "consecDecorr": 3,
  "multiDuty": [
    {
      "unitDes": "SHIP:STENNIS",
      "name": "POPOVICH",
      "rank": "LCDR",
      "duty": "SICO",
      "dutyTeleFreqNums": [
        "TEL:804-555-4142",
        "TEL:804-867-5309"
      ],
      "multiDutyVoiceCoord": [
        {
          "multiVoiceNetDes": "VPN",
          "multiFreqDes": "ST300A",
          "multiCommPri": "P",
          "multiTeleFreqNums": [
            "TEL:804-555-4142",
            "TEL:804-867-5309"
          ]
        }
      ]
    }
  ],
  "ops": [
    {
      "linkName": "Link-16",
      "linkStartTime": "2024-01-07T13:55:43.123Z",
      "linkStopTime": "2024-01-08T13:55:43.123Z",
      "linkStopTimeMod": "AFTER",
      "linkDetails": "Link details"
    }
  ],
  "jreUnitDes": "CVN-72",
  "jreCallSign": "CHARLIE ONE",
  "jrePriAdd": 71777,
  "jreSecAdd": 77771,
  "jreDetails": "JRE details",
  "specTracks": [
    {
      "specTrackNum": "12345",
      "specTrackNumDesc": "SAM SITE CHARLIE"
    }
  ],
  "nonLinkUnitDes": [
    "CS:GRAY GHOST",
    "CS:WHITE WHALE"
  ],
  "trackNumBlockLLs": [
    1234,
    2345
  ],
  "trackNumBlocks": [
    "0200-0300",
    "0400-4412"
  ],
  "mgmtCode": "VICTOR",
  "mgmtCodeMeaning": "ORBIT AT POINT BRAVO",
  "ackReq": true,
  "ackInstUnits": [
    "AOC EXT 2345",
    "317 AW"
  ],
  "classSource": "USJFCOM EXORD SOLID WASTE 98",
  "classReasons": [
    "15C",
    "15D"
  ],
  "decInstDates": [
    "AT EXERCISE ENDEX",
    "DATE:25NOV1997"
  ],
  "decExemptCodes": [
    "X1",
    "X2"
  ],
  "remarks": [
    {
      "type": "CONTINGENCY PROCEDURES",
      "text": "Example data link remarks"
    }
  ],
  "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"
}

Response

Success

Changes

  • 45631f9bb3f0Revision changes
    • breaking

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

  • 75f764c843a9Revision changes
    • info

      api operation id create_31 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.