BLbluestaq
Site

POST /udl/siteremark

Changed on

Service operation to take a single remark record as a POST body and ingest into the database. A specific role is required to perform this service operation. Please contact the UDL team for assistance.

Request

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

Request body

idstring

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

classificationMarkingstring required

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

idSitestring required

The ID of the site to which this remark applies.

origRmkIdstring

Unique identifier of the Site Remark record from the originating system.

namestring

The name of the remark.

typestring

The remark type (e.g. Caution, Information, Misc, Restriction, etc.).

textstring required

The text of the remark.

codestring

The remark type identifier. For example, the Mobility Air Forces (MAF) remark code, defined in the Airfield Suitability and Restriction Report (ASRR).

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.

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 request

{
  "id": "5000a3ef-8e39-2551-80f1-b3cd1895fe7b",
  "classificationMarking": "U",
  "idSite": "SITE-ID",
  "origRmkId": "123456ABC",
  "name": "Remark name",
  "type": "Restriction",
  "text": "This is a remark",
  "code": "M",
  "createdAt": "2022-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "origNetwork": "OPS1",
  "dataMode": "TEST"
}

Response

Success

Changes

  • 45631f9bb3f0Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

  • 75f764c843a9Revision changes
    • breaking

      request body became required

    • info

      api operation id create_114 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.