--- title: "GET /udl/diplomaticclearance/tuple" method: GET path: "/udl/diplomaticclearance/tuple" tags: ["AirOperations"] --- # GET /udl/diplomaticclearance/tuple `GET /udl/diplomaticclearance/tuple` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/diplomaticclearance/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 - `firstDepDate` string, date-time, required - `firstResult` integer - `maxResults` integer ## Response `200` OK - DiplomaticClearanceFull[] - `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. - `idMission` string, required: Unique identifier of the Mission associated with this diplomatic clearance record. - `externalWorksheetId` string: Optional diplomatic clearance worksheet ID from external systems. This field has no meaning within UDL and is provided as a convenience for systems that require tracking of an internal system generated ID. - `dipWorksheetName` string: Identifier of the Diplomatic Clearance Worksheet used to coordinate aircraft clearance requests. - `firstDepDate` string, date-time, required: The First Departure Date (FDD) the mission is scheduled for departure, in ISO 8601 UTC format with millisecond precision. - `docDeadline` string, date-time: Suspense date for the diplomatic clearance worksheet to be worked, in ISO 8601 UTC format with millisecond precision. - `apacsId` string: The Aircraft and Personnel Automated Clearance System (APACS) system identifier used to process and approve this clearance request. - `diplomaticClearanceDetails` DiplomaticClearanceDetailsFull[]: Collection of diplomatic clearance details. - `idSortie` string: Unique identifier of the Aircraft Sortie associated with this diplomatic clearance record. - `legNum` integer: Identifies the Itinerary point of a sortie where an air event occurs. - `routeString` string: The 1801 fileable route of flight string associated with this diplomatic clearance. The route of flight string contains route designators, significant points, change of speed/altitude, change of flight rules, and cruise climbs. - `validStartTime` string, date-time: The start time of the validity of this diplomatic clearance, in ISO 8601 UTC format with millisecond precision. - `validEndTime` string, date-time: The end time of the validity of this diplomatic clearance, in ISO 8601 UTC format with millisecond precision. - `clearanceId` string: Identifier of this diplomatic clearance issued by the host country. - `externalClearanceId` string: Optional clearance ID from external systems. This field has no meaning within UDL and is provided as a convenience for systems that require tracking of an internal system generated ID. - `clearedCallSign` string: The call sign of the sortie cleared with this diplomatic clearance. - `sequenceNum` integer: The placement of this diplomatic clearance within a sequence of clearances used on a sortie. For example, a sequence value of 3 means that it is the third diplomatic clearance the aircraft will use. - `countryCode` string: The DoD Standard Country Code designator for the country issuing the diplomatic clearance. This field will be set to "OTHR" if the source value does not match a UDL Country code value (ISO-3166-ALPHA-2). - `altCountryCode` string: Specifies an alternate country code if the data provider code does not match a UDL Country code value (ISO-3166-ALPHA-2). This field will be set to the value provided by the source and should be used for all Queries specifying a Country Code. - `countryName` string: Name of the country issuing this diplomatic clearance. - `validDesc` string: Description of when this diplomatic clearance is valid. - `windowRemark` string: Remarks concerning the valid diplomatic clearance window. - `entryPoint` string: The navigation point name where the aircraft must enter the country. - `entryNET` string, date-time: Earliest time the aircraft may enter the country, in ISO 8601 UTC format with millisecond precision. - `exitPoint` string: The navigation point name where the aircraft must exit the country. - `exitNLT` string, date-time: Latest time the aircraft may exit the country, in ISO 8601 UTC format with millisecond precision. - `reqICAO` boolean: Flag indicating whether the clearance request requires ICAO specific information. - `action` string: The type of action the aircraft can take with this diplomatic clearance (e.g. O for Overfly, L for Land, etc.). - `status` string: Indicates the current status of the diplomatic clearance request. - `profile` string: The diplomatic clearance profile name used within clearance management systems. - `reqPoint` boolean: Flag indicating whether entry/exit points are required for clearances. - `clearanceRemark` string: Remarks concerning this diplomatic clearance. - `diplomaticClearanceRemarks` DiplomaticClearanceRemarksFull[]: Collection of diplomatic clearance remarks. - `gdssRemarkId` string: Global Decision Support System (GDSS) remark identifier. - `text` string: Text of the remark. - `date` string, date-time: Date the remark was published, in ISO 8601 UTC format, with millisecond precision. - `user` string: User who published 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-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_33` 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/diplomaticclearance/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)