--- title: "GET /udl/h3geo/tuple" method: GET path: "/udl/h3geo/tuple" tags: ["Report and Activity"] --- # GET /udl/h3geo/tuple `GET /udl/h3geo/tuple` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/h3geo/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 - H3GeoFull[] - `id` string: Unique identifier of the record, auto-generated by the system. - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format. - `resolution` integer: H3 resolution (0 – 15) for the data set. At this time, UDL supports a resolution of 3 or less. - `startTime` string, date-time, required: Start time for this H3 Geo data set in ISO 8601 UTC with millisecond precision. - `endTime` string, date-time: End time for this H3 Geo data set in ISO 8601 UTC with millisecond precision. - `centerFreq` number, double: The center frequency of this H3 Geo data set measured in megahertz. - `cells` H3GeoHexCellFull[], required: The collection of hex cells contained in this H3 data set. The number of cells is a function of the specified resolution. - `id` string: Unique identifier of the record, auto-generated by the system. - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format. - `cellId` string, required: The H3 index represented as a 16 character hexadecimal string. - `idH3Geo` string: Unique identifier of the parent H3 Geo record containing this hex cell. - `coverage` integer: The total number of available observations in the H3 cell during the start/end times. - `anomScoreInterference` number, double: The anomaly score for probable manufactured interference or RF interference; calculated as a ratio of #anomalous obs / #total obs or coverage. - `anomScoreSpoofing` number, double: The anomaly score for probable spoofing; calculated as a ratio of #anomalous obs / #total obs or coverage. - `changeScore` number, double: The percentage degree of change in the aggregated observables for a particular H3 bin. - `rpmMedian` number, double: The median received power monitor (RPM) output value for the set of data contained within this cell. - `rpmMean` number, double: The mean received power monitor (RPM) output value for the set of data contained within this cell. - `rpmMax` number, double: The max received power monitor (RPM) output value for the set of data contained within this cell. - `rpmMin` number, double: The min received power monitor (RPM) output value for the set of data contained within this cell. - `rpmSigma` number, double: The standard deviation of the received power monitor (RPM) output value for the set of data contained within this cell. - `altMean` number, double: The mean altitude of the set of observations within this cell, measured in kilometers. - `altSigma` number, double: The standard deviation of alttitude in the set of observations within this cell, measured in kilometers. - `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. - `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. - `numCells` integer, required: The number of cells associated with this H3 Geo data set. At this time, UDL supports up to 50,000 cells. - `type` string: An optional field containing the type of data that is represented by this H3 Geo data set. - `tags` string[]: Optional array of provider/source specific tags for this data, where each element is no longer than 32 characters, used for implementing data owner conditional access controls to restrict access to the data. Should be left null by data providers unless conditional access controls are coordinated with the UDL team. - `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. - `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`: 3 info - api operation id `findAllTuples_54` removed and replaced with `` - the endpoint scheme security `BasicAuth` was removed from the API - added the optional property `items/cells/items/changeScore` to the response with the `200` status [Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/h3geo/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)