--- title: "GET /udl/linkstatus/tuple" method: GET path: "/udl/linkstatus/tuple" tags: ["Link Status"] --- # GET /udl/linkstatus/tuple `GET /udl/linkstatus/tuple` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/linkstatus/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 - `createdAt` string, date - `linkStartTime` string, date-time - `linkStopTime` string, date-time - `firstResult` integer - `maxResults` integer ## Response `200` OK - LinkStatusFull[] - `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. - `idOnOrbit1` string: Unique ID of the on-orbit satellite (Sat-1) forming the link. A null value for idOnOrbit1 indicates that the link is formed over a LEO/MEO constellation. - `idOnOrbit2` string: Unique ID of the on-orbit satellite (Sat-2) forming the link. A null value for idOnOrbit2 indicates either a link employing only Sat-1 or a link formed over a LEO/MEO constellation. - `linkStartTime` string, date-time, required: The link establishment time, or the time that the link becomes available for use, in ISO8601 UTC format. - `linkStopTime` string, date-time, required: The link termination time, or the time that the link becomes unavailable for use, in ISO8601 UTC format. - `constellation` string: The constellation name if the link is established over a LEO/MEO constellation. In this case, idOnOrbit1 and idOnOrbit2 will be null. - `linkName` string, required: The name or description of the link. - `linkType` string: The type of the link. - `band` string: The RF band employed by the link (e.g. MIL-KA, COM-KA, X-BAND, C-BAND, etc.). - `idBeam1` string: The ID of beam-1 forming the link. In the case of two sat link, beam-1 corresponds to Sat-1. - `endPoint1Name` string, required: The name or description of link endpoint-1, corresponding to beam-1. - `endPoint1Lat` number, double, required: Latitude of link endpoint-1, WGS-84 in degrees. -90 to 90 degrees (negative values south of equator). - `endPoint1Lon` number, double, required: Longitude of link endpoint-1, WGS-84 longitude in degrees. -180 to 180 degrees (negative values west of Prime Meridian). - `idBeam2` string: The ID of beam-2 forming the link. In the case of two sat link, beam-2 corresponds to Sat-2. - `endPoint2Name` string, required: The name or description of link endpoint-2, corresponding to beam-2. - `endPoint2Lat` number, double, required: Latitude of link endpoint-2, WGS-84 in degrees. -90 to 90 degrees (negative values south of equator). - `endPoint2Lon` number, double, required: Longitude of link endpoint-2, WGS-84 longitude in degrees. -180 to 180 degrees (negative values west of Prime Meridian). - `dataRate1To2` number, double: The endpoint-1 to endpoint-2 data rate, in kbps. - `dataRate2To1` number, double: The endpoint-2 to endpoint-1 data rate, in kbps. - `linkState` string: The state of the link (e.g. OK, DEGRADED-WEATHER, DEGRADED-EMI, etc.). - `sysCap` string: The SYSCAP mission status of the system(s) forming the link. - `opsCap` string: The OPSCAP mission status of the system(s) forming the link. - `snr` number, double: Signal to noise ratio, in dB. - `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. - `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. - `satNo1` integer: Satellite/catalog number of the target on-orbit primary object. - `satNo2` integer: Satellite/catalog number of the target on-orbit secondary object. ## 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 info - added the optional property `items/snr` to 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_66` 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/linkstatus/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)