Report and Activity

GET /udl/hazard/tuple

Changed on May 29, 2025

Service operation to dynamically query data and only return specified columns/fields. Requested columns are specified by the 'columns' query parameter and should be a comma separated list of valid fields for the specified data type. classificationMarking is always returned. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information. An example URI: /udl/elset/tuple?columns=satNo,period&epoch=>now-5 hours would return the satNo and period of elsets with an epoch greater than 5 hours ago.

Request

Base URL
https://unifieddatalibrary.com
URL
https://unifieddatalibrary.com/udl/hazard/tuple
Auth
none declared

Query parameters

columnsstring required

Comma-separated list of valid field names for this data type to be returned in the response. Only the fields specified will be returned as well as the classification marking of the data, if applicable. See the ‘queryhelp’ operation for a complete list of possible fields.

detectTimestring date-time required

The detect time, in ISO 8601 UTC format, with millisecond precision. (YYYY-MM-DDTHH:MM:SS.sssZ)

firstResultinteger

maxResultsinteger

Response

idstring

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

classificationMarkingstring required

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

detectTypestring required

The type of hazard (Chemical, Biological, Radiological, Nuclear) detect associated with this record.

detectTimestring date-time required

The detect time, in ISO 8601 UTC format, with millisecond precision.

harmfulboolean

Flag indicating whether this detection is harmful to humans.

alarmsstring[] required

Array of the specific alarms associated with this detection. The alarms and alarmValues arrays must contain the same number of elements.

alarmValuesnumber[] required

Array of the values that correspond to each of the alarms contained in alarms. The alarms and alarmValues arrays must contain the same number of elements.

readingsstring[]

Array of the specific readings associated with this detection. The readings, readingUnits, and readingValues arrays must contain the same number of elements.

readingUnitsstring[]

Array of the units that correspond to each of the readingValues. The readings, readingUnits, and readingValues arrays must contain the same number of elements.

readingValuesnumber[]

Array of the values that correspond to each of the readings contained in readings. The readings, readingUnits, and readingValues arrays must contain the same number of elements.

matTypestring

The specific material type (MT) or MT Code involved in this detection, when applicable. The material type is generally associated with radiological and/or nuclear detections. For further information, reference Nuclear Materials Management and Safeguards System (NMMSS) Users Guide Rev. 2.1.

matClassstring

The specific Material Class for the material associated with this detect. The material class is generally associated with chemical and biological detections.

matNamestring

The material common name associated with this detection.

matCatinteger

The Radiological Category (1 - 5) which applies to the material associated with this detection, according to the following definitions:

Category 1: If not safely or securely managed, would be likely to cause permanent injury to a person who handled them or was otherwise in contact with them for more than a few minutes. It would probably be fatal to be close to this amount of unshielded material for a period of a few minutes to an hour.

Category 2: If not safely or securely managed, could cause permanent injury to a person who handled them or was otherwise in contact with them for a short time (minutes to hours). It could possibly be fatal to be close to this amount of unshielded radioactive material for a period of hours to days.

Category 3: If not safely or securely managed, could cause permanent injury to a person who handled them or was otherwise in contact with them for hours. It could possibly - although it is unlikely to be - fatal to be close to this amount of unshielded radioactive material for a period of days to weeks.

Category 4: If not safely managed or securely protected, could possibly cause temporary injury to someone who handled them or was otherwise in contact with or close to them for a period of many weeks, though this is unlikely. It is very unlikely anyone would be permanently injured by this amount of radioactive material.

Category 5: Cannot cause permanent injury. This category applies to x-ray fluorescence devices and electron capture devices.

casRNstring

The CAS Registry Number, also referred to as CAS Number or CAS RN, associated with the this detection. The CAS Number is a unique numerical identifier assigned by the Chemical Abstracts Service (CAS), to every chemical substance described in the open scientific literature. It includes organic and inorganic compounds, minerals, isotopes, alloys, mixtures, and nonstructurable materials (UVCBs, substances of unknown or variable composition, complex reaction products, or biological origin). For further information, reference https://www.cas.org/cas-data/cas-registry.

ppminteger

Measure of the concentration of the material associated with this detection, in parts per million (units of contaminant mass per million parts of total mass).

densitynumber double

Measure of density of the material associated with this detection, in kg/m^3.

radCtrnnumber double

Measure of radioactive concentration of the material associated with this detection, in becquerels/m^3. One becquerel (Bq) is equal to one nuclear decay per second.

gBarnumber double

Chemical Agent Monitor (CAM) G-type agent measurement, in number of display bars. In G-mode, CAMs monitor for G-series nerve agents.

hBarnumber double

Chemical Agent Monitor (CAM) H-type agent measurement, in number of display bars. In H-mode, CAMs monitor for blister agents.

zinteger

The Atomic Number of the material associated with this detection.

ainteger

The (rounded) Mass Number of the material associated with this detection. The rounded value is the mass number of the most abundant isotope of the element.

bottleIdstring

The specific bottle ID associated with this detection.

channelstring

The applicable channel involved in this biological material detection (e.g. Digestive, Eyes, Respiratory, Skin, etc.) .

durationinteger

The known or projected hazard duration, in seconds, associated with this material detection.

activitynumber double

The radioactivity measurement of the material associated with this detection, in becquerels (Bq). One becquerel (Bq) is equal to one nuclear decay per second.

depnumber double

The deposition measurement of the contaminant to surface area, in kg/m^2.

depCtrnnumber double

The deposition concentration of the contaminant to surface area, in becquerels/m^2.

massFracnumber double

Ratio of the chemical substance mass to the total mass of the mixture.

dosenumber double

The dose associated with this detection, in gray. Dose is the measure of the energy deposited in matter by ionizing radiation per unit mass. One gray is defined as one Joule of energy absorbed per kilogram of matter.

ctrnTimenumber double

The concentration time, in (kg/sec)/m^3, associated with this material detection.

doseRatenumber double

The dose rate associated with this detection, in gray/sec. One gray is defined as one Joule of energy absorbed per kilogram of matter.

idPOIstring

ID of the Point of Interest (POI) record related to this hazard record.

idTrackstring

ID of the Track record related to this hazard record.

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 response

[
  {
    "id": "HAZARD-ID",
    "classificationMarking": "U",
    "detectType": "Chemical",
    "detectTime": "2022-03-07T14:51:39.653Z",
    "alarms": [
      "Alarm1",
      "Alarm2"
    ],
    "alarmValues": [
      2.7,
      2.9
    ],
    "readings": [
      "Rad1",
      "Rad2"
    ],
    "readingUnits": [
      "Gray",
      "Gray"
    ],
    "readingValues": [
      107.2,
      124.1
    ],
    "matType": "21",
    "matClass": "Nerve Agent",
    "matName": "VX",
    "matCat": 3,
    "casRN": "64-17-5",
    "ppm": 27129,
    "density": 18900.2,
    "radCtrn": 1.31,
    "gBar": 2.5,
    "hBar": 3.1,
    "z": 92,
    "a": 238,
    "bottleId": "6264",
    "channel": "Skin",
    "duration": 14400,
    "activity": 120.1,
    "dep": 1.084,
    "depCtrn": 86.1,
    "massFrac": 0.029,
    "dose": 1.12,
    "ctrnTime": 1.077,
    "doseRate": 1.0000001865,
    "idPOI": "POI-ID",
    "idTrack": "TRACK-ID",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "dataMode": "TEST"
  }
]

Changes

May 29, 20254e1cbc17e814 Revision changes
- info
  added the new optional query request parameter firstResult
- info
  added the new optional query request parameter maxResults
Apr 16, 202575f764c843a9 Revision changes
- info
  api operation id findAllTuples_56 removed and replaced with
- info
  the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.

Operation history