--- title: "GET /udl/datalink/tuple" method: GET path: "/udl/datalink/tuple" tags: ["Link Status"] --- # GET /udl/datalink/tuple `GET /udl/datalink/tuple` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/datalink/tuple` - Auth: none declared 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//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. ## Query parameters - `columns` string, required - `startTime` string, date-time, required - `firstResult` integer - `maxResults` integer ## Response `200` OK - DataLinkFull[] - `id` string: Unique identifier of the record, auto-generated by the system if not provided on create operations. - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format. - `opExName` string, required: Specifies the unique operation or exercise name, nickname, or codeword assigned to a joint exercise or operation plan. - `originator` string, required: The identifier of the originator of this message. - `startTime` string, date-time, required: The start of the effective time period of this data link message, in ISO 8601 UTC format with millisecond precision. - `stopTime` string, 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. - `stopTimeMod` string: 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. - `planOrigNum` string: The official identifier of the military establishment responsible for the operation plan and the identification number assigned to this plan. - `opExInfo` string: Provides an additional caveat further identifying the exercise or modifies the exercise nickname. - `opExInfoAlt` string: The secondary nickname of the option or the alternative of the operational plan or order. - `serialNum` string: The unique message identifier assigned by the originator. - `month` string: The month in which this message originated. - `qualifier` string: The qualifier which caveats the message status such as AMP (Amplification), CHG (Change), etc. - `qualSN` integer: The serial number associated with the message qualifier. - `references` DataLinkReferencesFull[]: Collection of reference information. There can be 0 to many DataLinkReferences collections within the datalink service. - `refSerialId` string: Specifies an alphabetic serial identifier a reference pertaining to the data link message. - `refType` string: Specifies the type of document referenced. - `refOriginator` string: The originator of this reference. - `refTs` string, date-time: Timestamp of the referenced message, in ISO 8601 UTC format with millisecond precision. - `refSerialNum` string: Serial number assigned to this reference. - `refSpecialNotation` string: Indicates any special actions, restrictions, guidance, or information relating to this reference. - `refSICs` string[]: Array of NATO Subject Indicator Codes (SIC) or filing numbers of the document being referenced. - `canxId` string: The identifier for this data link message cancellation. - `canxOriginator` string: The originator of this data link message cancellation. - `canxTs` string, date-time: Timestamp of the data link message cancellation, in ISO 8601 UTC format with millisecond precision. - `canxSerialNum` string: Serial number assigned to this data link message cancellation. - `canxSpecialNotation` string: Indicates any special actions, restrictions, guidance, or information relating to this data link message cancellation. - `canxSICs` string[]: Array of NATO Subject Indicator Codes (SIC) or filing numbers of this data link message or document being cancelled. - `pocName` string: The name of the point of contact for this data link message. - `pocRank` string: The rank or position of the point of contact for this data link message in a military or civilian organization. - `pocCallSign` string: The unit identifier or call sign of the point of contact for this data link message. - `pocLocName` string: The location name of the point of contact for this data link message. - `pocLat` number, double: WGS84 latitude of the point of contact for this data link message, in degrees. -90 to 90 degrees (negative values south of equator). - `pocLon` number, 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). - `pocNums` string[]: Array of telephone numbers, radio frequency values, or email addresses of the point of contact for this data link message. - `geoDatum` string: The code for the point of reference from which the coordinates and networks are computed. - `refPoints` DataLinkRefPointsFull[]: Collection that identifies points of reference used in the establishment of the data links. There can be 1 to many DataLinkRefPoints collections within the datalink service. - `refPointType` string: Type of data link reference point or grid origin. - `refDes` string: Identifier to designate a reference point. - `refLocName` string: The location name of the point of reference for this data link message. - `refLat` number, double: WGS84 latitude of the reference point for this data link message, in degrees. -90 to 90 degrees (negative values south of equator). - `refLon` number, double: WGS84 longitude of the reference point for this data link message, in degrees. -90 to 90 degrees (negative values south of equator). - `effEventTime` string, date-time: Indicates when a particular event or nickname becomes effective or the old event or nickname is deleted, in ISO 8601 UTC format with millisecond precision. - `voiceCoord` DataLinkVoiceCoordFull[]: Collection of information regarding the function, frequency, and priority of interface control and coordination nets for this data link message. There can be 1 to many DataLinkVoiceCoord collections within the datalink service. - `voiceNetDes` string: Designator assigned to a voice interface control and coordination net for this data link message (e.g. ADCCN, DCN, VPN, etc.). - `freqDes` string: Designator used in nonsecure communications to refer to a radio frequency for this data link message. - `commPri` string: Priority of a communication circuit, channel or frequency for this data link message such as P (Primary), M (Monitor), etc. - `teleFreqNums` string[]: Array of telephone numbers or contact frequencies used for interface control for this data link message. - `sysDefaultCode` string: Indicates the data terminal settings the system defaults to, either automatic correlation/decorrelation (AUTO) or manual (MAN). - `winSizeMult` number, 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. - `winSizeMin` number, 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. - `minTrackQual` integer: Track quality to prevent correlation windows from being unrealistically large. Required if sysDefaultCode field is "MAN". Allowable entries are integers from 3 to 7. - `maxTrackQual` integer: Track quality to prevent correlation windows from being unrealistically small. Required if sysDefaultCode field is "MAN". Allowable entries are integers from 8 to 15. - `resTrackQual` integer: 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. - `courseDiff` integer: 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. - `speedDiff` integer: 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. - `altDiff` integer: 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. - `minGeoPosQual` integer: Number used for minimum geodetic position quality. Required if sysDefaultCode field is "MAN". Allowable entries are integers from 1 to 5. - `maxGeoPosQual` integer: Number used for maximum geodetic position quality. Required if sysDefaultCode field is "MAN". Allowable entires are integers from 1 to 15. - `decorrWinMult` number, 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. - `consecDecorr` integer: 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. - `multiDuty` DataLinkMultiDutyFull[]: Collection of contact and identification information for designated multilink coordinator duty assignments. There can be 0 to many DataLinkMultiDuty collections within the datalink service. - `unitDes` string: Designated force of unit specified by ship name, unit call sign, or unit designator. - `name` string: The name of the person to be contacted for multilink coordination. - `rank` string: The rank or position of the person to be contacted for multilink coordination. - `duty` string: Specific duties assigned for multilink coordination (e.g. ICO, RICO, SICO). - `dutyTeleFreqNums` string[]: Array of telephone numbers or the frequency values for radio transmission of the person to be contacted for multilink coordination. - `multiDutyVoiceCoord` DataLinkMultiDutyVoiceCoordFull[]: Collection of information regarding the function, frequency, and priority of interface control and coordination nets for multilink coordination. There can be 0 to many DataLinkMultiVoiceCoord collections within a DataLinkMultiDuty collection. - `multiVoiceNetDes` string: Designator assigned to a voice interface control and coordination net for multilink coordination (e.g. ADCCN, DCN, VPN, etc.). - `multiFreqDes` string: Designator used in nonsecure communications to refer to a radio frequency for multilink coordination. - `multiCommPri` string: Priority of a communication circuit, channel or frequency for multilink coordination (e.g. P - Primary, M - Monitor). - `multiTeleFreqNums` string[]: Array of telephone numbers or contact frequencies used for interface control for multilink coordination. - `ops` DataLinkOpsFull[]: Collection of information describing the establishment and detailed operation of tactical data links. There can be 0 to many DataLinkOps collections within the datalink service. - `linkName` string: Name of the data link. - `linkStartTime` string, date-time: The start of the effective time period of the data link, in ISO 8601 UTC format with millisecond precision. - `linkStopTime` string, date-time: The end of the effective time period of the data link, in ISO 8601 UTC format with millisecond precision. - `linkStopTimeMod` string: A qualifier for the end of the effective time period of this data link, such as AFTER, ASOF, NLT, etc. Used with field linkStopTimeMod to indicate a relative time. - `linkDetails` string: Detailed characteristics of the data link. - `jreUnitDes` string: Designator of the unit for Joint Range Extension (JRE). - `jreCallSign` string: Call sign which identifies one or more communications facilities, commands, authorities, or activities for Joint Range Extension (JRE) units. - `jrePriAdd` integer: Link-16 octal track number assigned as the primary JTIDS unit address. - `jreSecAdd` integer: Link-16 octal track number assigned as the secondary JTIDS unit address. - `jreDetails` string: Joint Range Extension (JRE) unit details. - `specTracks` DataLinkSpecTracksFull[]: Collection of special track numbers used on the data links. There can be 0 to many DataLinkSpecTracks collections within the datalink service. - `specTrackNum` string: The special track number used on the data link entered as an octal reference number. Used to identify a particular type of platform (e.g. MPA, KRESTA) or platform name (e.g. TROMP, MOUNT WHITNEY) which is not included in assigned track blocks. - `specTrackNumDesc` string: Description of the special track number. - `nonLinkUnitDes` string[]: Array of non-link specific data unit designators. - `trackNumBlockLLs` integer[]: Array of Link-16 octal track numbers used as the lower limit of a track block. - `trackNumBlocks` string[]: Array of defined ranges of Link-11/11B track numbers assigned to a participating unit or reporting unit. - `mgmtCode` string: Data link management code word. - `mgmtCodeMeaning` string: Data link management code word meaning. - `ackReq` boolean: Flag Indicating if formal acknowledgement is required for the particular data link message being sent. - `ackInstUnits` string[]: Array of instructions for acknowledging and the force or units required to acknowledge the data link message being sent. - `classSource` string: Markings that define the source material or the original classification authority for this data link message. - `classReasons` string[]: Array of codes that indicate the reasons material is classified. - `decInstDates` string[]: Array of markings that provide the literal guidance or dates for the downgrading or declassification of this data link message. - `decExemptCodes` string[]: Array of codes that provide justification for exemption from automatic downgrading or declassification. - `remarks` DataLinkRemarksFull[]: Collection of remarks associated with this data link message. - `type` string: Indicates the subject matter of the remark. - `text` string: Text of the remark. - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system. - `createdBy` string: Application user who created the row in the database, auto-populated by the system. - `updatedAt` string, date-time: Time the row was updated in the database, auto-populated by the system. - `updatedBy` string: Application user who updated the row in the database, auto-populated by the system. - `sourceDL` string: 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. - `source` string, required: Source of the data. - `origin` string: 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. - `origNetwork` string: 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. ## Other responses - `400`: Bad Request - `401`: Invalid/Missing User Credentials - `403`: User Is Not Authorized - `405`: Method Not Allowed - `406`: MediaType Not Accepted by Request Headers - `429`: Rate of Requests Exceeds Allowed Limit - `500`: Internal Server Error ## Changes > 12 revisions in range; 1 could not be searched. - **2025-09-26** `45631f9bb3f0`: 1 warning - removed the optional property `items/rawFileURI` from the response with the `200` status - **2025-05-29** `4e1cbc17e814`: 2 info - added the new optional `query` request parameter `firstResult` - added the new optional `query` request parameter `maxResults` - **2025-04-16** `75f764c843a9`: 2 info - api operation id `findAllTuples_31` removed and replaced with `` - the endpoint scheme security `BasicAuth` was removed from the API [Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/datalink/tuple/get.md) --- [API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)