---
title: "GET /udl/beamcontour"
method: GET
path: "/udl/beamcontour"
tags: ["Beam"]
---

# GET /udl/beamcontour

`GET /udl/beamcontour`

## Request

- Base URL: `https://unifieddatalibrary.com`
- URL: `https://unifieddatalibrary.com/udl/beamcontour`
- Auth: none declared

Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (`/udl/<datatype>/queryhelp`) for more details on valid/required query parameter information.

## Query parameters

- `idBeam` string, required
- `firstResult` integer
- `maxResults` integer

## Response `200`

OK

- BeamContourAbridged[]
  - `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.
  - `idBeam` string, required: ID of the beam.
  - `type` 'BORESIGHT' | 'CONTOUR' | 'SVC AREA', required: The type of object represented in this record (BORESIGHT, CONTOUR, SVC AREA). Boresight refers to the point of maximum/peak gain, and should not be confused with the 'aim point' of the related beam. Gain contours are regions of coverage referenced to the relative gain of the related beam. Service Areas are composed of one or more service regions, with each region being either discrete point(s) or a continuous contour.
  - `contourIdx` integer: The index number of this contour. The value is required if type = CONTOUR.
  - `gain` number, double: The relative gain level in dB associated with this boresight or contour. Gain does not apply to service area records. The value is required if type = BORESIGHT or CONTOUR.
  - `regionName` string: The region name within the service area.
  - `geographyText` string: Geographical region or polygon (lon/lat pairs), as depicted by the Well-Known Text representation of the geometry/geography, of the image as projected on the ground. WKT reference: https://www.opengeospatial.org/standards/wkt-crs. Ignored if included with a POST or PUT request that also specifies a valid 'area' field.
  - `geographyJson` string: Geographical region or polygon (lat/lon pairs), as depicted by the GeoJSON representation of the geometry/geography, of the image as projected on the ground. GeoJSON Reference: https://geojson.org/. Ignored if included with a POST or PUT request that also specifies a valid 'area' or 'atext' field.
  - `geographyType` string: Type of region as projected.
  - `geographyNdims` integer: Number of dimensions of the geometry depicted by region.
  - `geographySrid` integer: Geographical spatial_ref_sys for region.
  - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system, example = 2018-01-01T16:00:00.123Z.
  - `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.

## 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`: 1 breaking, 2 info
  - the `items/contourIdx` response's property format changed from `int32` to `int16` for status `200`
  - api operation id `findAllWithStream_3` 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/beamcontour/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)