Notifications

POST /udl/notification/createRaw

Changed on

Service operation to push a Notification/Alert message into the UDL. This operation uses query parameters to pass UDL-required fields such as classificationMarking, msgType, etc and takes a raw string payload which can be XML, JSON, or plain text. The preferred mechanism for posting notifications is to use the standard POST which takes the proper UDL JSON Notification schema as this service may convert the message in an undesirable manner. The service will wrap the passed payload with the appropriate UDL JSON schema, using escape characters as necessary for the payload to produce a valid JSON document. XML payloads (not recommended) are automatically converted to JSON. Messages pushed through this service may be pulled via Secure Messaging and historical REST services. 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/notification/createRaw
  • Auth
    none declared

Query parameters

classificationMarkingstring required

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

dataModestring required

Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:

EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data.

REAL: Data collected or produced that pertains to real-world objects, events, and analysis.

SIMULATED: Synthetic data generated by a model to mimic real-world datasets.

TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics.

msgIdstring

Optional message identifier...if not provided an id will be automatically created.

msgTypestring required

Source provided message type.

originstring required

Origin of the data.

sourcestring required

Source of the data.

tagsstring[]

Optional list of provider/source specific tags for this data.

Request body text/plain

string required

Response

Success

Changes

    • info

      api operation id createFromParams removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.