--- title: "GET /udl/antenna/tuple" method: GET path: "/udl/antenna/tuple" tags: ["Onorbit"] --- # GET /udl/antenna/tuple `GET /udl/antenna/tuple` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/antenna/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 - `firstResult` integer - `maxResults` integer ## Response `200` OK - AntennaFull[] - `id` string: Unique identifier of the record, auto-generated by the system. - `name` string, required: Antenna name. - `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 last 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. - `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. - `antennaDetails` AntennaDetailsFull[]: Read-only collection of additional AntennaDetails by various sources for this organization, ignored on create/update. These details must be created separately via the /udl/antennadetails operations. - `id` string: Unique identifier of the record, auto-generated by the system. - `idAntenna` string, required: Unique identifier of the parent Antenna. - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format. - `type` string: Type of antenna (e.g. Reflector, Double Reflector, Shaped Reflector, Horn, Parabolic, etc.). - `position` string: Antenna position (e.g. Top, Nadir, Side). - `mode` 'TX' | 'RX': Antenna mode (e.g. TX,RX). - `steerable` boolean: Boolean indicating if this antenna is steerable. - `beamForming` boolean: Boolean indicating if this is a beam forming antenna. - `manufacturerOrgId` string: ID of the organization that manufactures the antenna. - `diameter` number, double: Antenna diameter in meters. - `size` number[]: Array with 1-2 values specifying the length and width (for rectangular) and just length for dipole antennas in meters. - `startFrequency` number, double: Antenna start of frequency range in Mhz. - `endFrequency` number, double: Antenna end of frequency range in Mhz. - `beamwidth` number, double: Array of angles between the half-power (-3 dB) points of the main lobe of the antenna, in degrees. - `gain` number, double: Antenna maximum gain in dBi. - `gainTolerance` number, double: Antenna gain tolerance in dB. - `polarization` number, double: Antenna polarization in degrees. - `description` string: Antenna description. - `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 last 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. - `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. - `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. - `manufacturerOrg` OrganizationFull: An organization such as a corporation, manufacturer, consortium, government, etc. An organization may have parent and child organizations as well as link to a former organization if this org previously existed as another organization. - `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. - `name` string, required: Organization name. - `type` string, required: Type of organization (e.g. GOVERNMENT, CORPORATION, CONSORTIUM, ACADEMIC). - `category` string: Subtype or category of the organization (e.g. Private company, stock market quoted company, subsidiary, goverment department/agency, etc). - `externalId` string: Optional externally provided identifier for this row. - `description` string: Organization description. - `countryCode` string: Country of the physical location of the organization. This value is typically the ISO 3166 Alpha-2 two-character country code. However, it can also represent various consortiums that do not appear in the ISO document. The code must correspond to an existing country in the UDL’s country API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code, or alternate code values that exist for the specified country code. - `nationality` string: Country of registration or ownership of the organization. This value is typically the ISO 3166 Alpha-2 two-character country code, however it can also represent various consortiums that do not appear in the ISO document. The code must correspond to an existing country in the UDL’s country API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code, or alternate code values that exist for the specified country code. - `active` boolean: Boolean indicating if this organization is currently active. - `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. - `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. - `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 last 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. - `organizationDetails` OrganizationDetailsFull[]: Read-only collection of additional OrganizationDetails by various sources for this organization, ignored on create/update. These details must be created separately via the /udl/organizationdetails operations. - `id` string: Unique identifier of the record, auto-generated by the system. - `idOrganization` string, required: Unique identifier of the parent organization. - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format. - `name` string, required: Organization details name. - `email` string: Listed contact email address for the organization. - `address1` string: Street number of the organization. - `address2` string: Field for additional organization address information such as PO Box and unit number. - `address3` string: Contains the third line of address information for an organization. - `geoAdminLevel1` string: Administrative boundaries of the first sub-national level. Level 1 is simply the largest demarcation under whatever demarcation criteria has been determined by the governing body. For example, this may be a state or province. - `geoAdminLevel2` string: Administrative boundaries of the second sub-national level. Level 2 is simply the second largest demarcation under whatever demarcation criteria has been determined by the governing body. For example, this may be a county or district. - `geoAdminLevel3` string: Administrative boundaries of the third sub-national level. Level 3 is simply the third largest demarcation under whatever demarcation criteria has been determined by the governing body. For example, this may be a city or township. - `postalCode` string: A postal code, such as PIN or ZIP Code, is a series of letters or digits or both included in the postal address of the organization. - `description` string: Organization description. - `formerOrgId` string: Former organization ID (if this organization previously existed as another organization). - `parentOrgId` string: Parent organization ID of this organization if it is a child organization. - `financialYearEndDate` string, date-time: For organizations of type CORPORATION, the effective financial year end date for revenue, EBITDA, and profit values. - `revenue` number, double: For organizations of type CORPORATION, total annual revenue as of financialYearEndDate in US Dollars. - `profit` number, double: For organizations of type CORPORATION, total annual profit as of financialYearEndDate in US Dollars. - `ebitda` number, double: For organizations of type CORPORATION, the company EBITDA value as of financialYearEndDate in US Dollars. - `ftes` integer: Total number of FTEs in this organization. - `broker` string: Designated broker for this organization. - `ceo` string: For organizations of type CORPORATION, the name of the Chief Executive Officer. - `cfo` string: For organizations of type CORPORATION, the name of the Chief Financial Officer. - `cto` string: For organizations of type CORPORATION, the name of the Chief Technology Officer. - `riskManager` string: The name of the risk manager for the organization. - `massRanking` integer: Mass ranking for this organization. - `revenueRanking` integer: Revenue ranking for this organization. - `financialNotes` string: For organizations of type CORPORATION, notes on company financials. - `servicesNotes` string: Notes on the services provided by the organization. - `fleetPlanNotes` string: Satellite fleet planning notes for this organization. - `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. - `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. - `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. - `updatedAt` string, date-time: Time the row was last 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. - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system. - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system. ## 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_15` removed and replaced with `` - the endpoint scheme security `BasicAuth` was removed from the API - the response optional property `items/antennaDetails/items/manufacturerOrg` became not read-only for the status `200` [Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/antenna/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)