BLbluestaq
Beam

GET /udl/beamcontour

Changed on

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.

Request

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

Query parameters

idBeamstring required

ID of the beam.

firstResultinteger
maxResultsinteger

Response

OK

idstring

Unique identifier of the record, auto-generated by the system.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

idBeamstring 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.

contourIdxinteger

The index number of this contour. The value is required if type = CONTOUR.

gainnumber 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.

regionNamestring

The region name within the service area.

geographyTextstring

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.

geographyJsonstring

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.

geographyTypestring

Type of region as projected.

geographyNdimsinteger

Number of dimensions of the geometry depicted by region.

geographySridinteger

Geographical spatial_ref_sys for region.

createdAtstring date-time

Time the row was created in the database, auto-populated by the system, example = 2018-01-01T16:00:00.123Z.

createdBystring

Application user who created the row in the database, auto-populated by the system.

sourcestring required

Source of the data.

originstring

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.

origNetworkstring

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.

Example response

[
  {
    "id": "BEAMCONTOUR-ID",
    "classificationMarking": "U",
    "idBeam": "REF-BEAM-ID",
    "type": "BORESIGHT",
    "contourIdx": 1,
    "gain": 17.1,
    "regionName": "Example region name",
    "geographyText": "POLYGON((67.3291113966927 26.156175339112,67.2580009640721 26.091022064271,67.1795862381682 26.6637992964562,67.2501237475598 26.730115808233,67.3291113966927 26.156175339112))",
    "geographyJson": "{\"type\":\"Polygon\",\"coordinates\":[ [ [ 67.3291113966927, 26.156175339112 ], [ 67.2580009640721, 26.091022064271 ], [ 67.1795862381682, 26.6637992964562 ], [ 67.2501237475598, 26.730115808233 ], [ 67.3291113966927, 26.156175339112 ] ] ] }",
    "geographyType": "ST_Polygon",
    "geographyNdims": 2,
    "geographySrid": 4326,
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "dataMode": "TEST"
  }
]

Changes

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

  • 75f764c843a9Revision changes
    • breaking

      the / response's property format changed from int32 to int16 for status

    • info

      api operation id findAllWithStream_3 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.