BLbluestaq
Site

GET /udl/surfaceobstruction

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/surfaceobstruction
  • Auth
    none declared

Query parameters

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.

idSurfacestring required

The unique identifier of the associated surface record. This field is required when posting, updating, or deleting a SurfaceObstruction record.

idNavigationalObstructionstring

The unique identifier of the associated NavigationalObstruction record.

obstructionSideCodestring

A code that indicates which side of the surface end is affected by this obstruction.

obstructionDescstring

Description of this surface obstruction.

obstructionHeightnumber double

The height above ground level of the surface obstruction, in feet.

distanceFromEdgenumber double

The distance from the surface edge to this obstruction, in feet.

distanceFromCenterLinenumber double

The distance from the surface center line to this obstruction, in feet.

distanceFromThresholdnumber double

The distance from the surface threshold to this obstruction, in feet.

advisoryRequiredstring[]

Array of all vehicles that are affected by this obstruction at the surface end-point, and require an advisory for usage.

approvalRequiredstring[]

Array of all vehicles that are affected by this obstruction at the surface end-point, and require an approval for usage.

createdAtstring date-time

Time the row was created in the database, auto-populated by the system.

createdBystring

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

sourcestring required

Source of the data.

sourceDLstring

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.

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' | 'EXERCISE' | 'SIMULATED' 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": "be831d39-1822-da9f-7ace-6cc5643397dc",
    "classificationMarking": "U",
    "idSurface": "be831d39-1822-da9f-7ace-6cc5643397dc",
    "idNavigationalObstruction": "a2831d39-1822-da9f-7ace-6cc5643397da",
    "obstructionSideCode": "F",
    "obstructionDesc": "PYLON",
    "obstructionHeight": 35.25,
    "distanceFromEdge": 15.8,
    "distanceFromCenterLine": 17.8,
    "distanceFromThreshold": 19.5,
    "advisoryRequired": [
      "C20",
      "C17"
    ],
    "approvalRequired": [
      "C20",
      "C17"
    ],
    "createdAt": "2022-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "sourceDL": "AXE",
    "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
    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      api operation id findAll_126 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.