--- title: "GET /udl/hazard/tuple" method: GET path: "/udl/hazard/tuple" tags: ["Report and Activity"] --- # GET /udl/hazard/tuple `GET /udl/hazard/tuple` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/hazard/tuple` - Auth: none declared 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//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. ## Query parameters - `columns` string, required - `detectTime` string, date-time, required - `firstResult` integer - `maxResults` integer ## Response `200` OK - HazardFull[] - `id` string: Unique identifier of the record, auto-generated by the system. - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format. - `detectType` string, required: The type of hazard (Chemical, Biological, Radiological, Nuclear) detect associated with this record. - `detectTime` string, date-time, required: The detect time, in ISO 8601 UTC format, with millisecond precision. - `harmful` boolean: Flag indicating whether this detection is harmful to humans. - `alarms` string[], required: Array of the specific alarms associated with this detection. The alarms and alarmValues arrays must contain the same number of elements. - `alarmValues` number[], 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. - `readings` string[]: Array of the specific readings associated with this detection. The readings, readingUnits, and readingValues arrays must contain the same number of elements. - `readingUnits` string[]: Array of the units that correspond to each of the readingValues. The readings, readingUnits, and readingValues arrays must contain the same number of elements. - `readingValues` number[]: 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. - `matType` string: 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. - `matClass` string: The specific Material Class for the material associated with this detect. The material class is generally associated with chemical and biological detections. - `matName` string: The material common name associated with this detection. - `matCat` integer: 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. - `casRN` string: 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. - `ppm` integer: 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). - `density` number, double: Measure of density of the material associated with this detection, in kg/m^3. - `radCtrn` number, 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. - `gBar` number, double: Chemical Agent Monitor (CAM) G-type agent measurement, in number of display bars. In G-mode, CAMs monitor for G-series nerve agents. - `hBar` number, double: Chemical Agent Monitor (CAM) H-type agent measurement, in number of display bars. In H-mode, CAMs monitor for blister agents. - `z` integer: The Atomic Number of the material associated with this detection. - `a` integer: 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. - `bottleId` string: The specific bottle ID associated with this detection. - `channel` string: The applicable channel involved in this biological material detection (e.g. Digestive, Eyes, Respiratory, Skin, etc.) . - `duration` integer: The known or projected hazard duration, in seconds, associated with this material detection. - `activity` number, 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. - `dep` number, double: The deposition measurement of the contaminant to surface area, in kg/m^2. - `depCtrn` number, double: The deposition concentration of the contaminant to surface area, in becquerels/m^2. - `massFrac` number, double: Ratio of the chemical substance mass to the total mass of the mixture. - `dose` number, 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. - `ctrnTime` number, double: The concentration time, in (kg/sec)/m^3, associated with this material detection. - `doseRate` number, 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. - `idPOI` string: ID of the Point of Interest (POI) record related to this hazard record. - `idTrack` string: ID of the Track record related to this hazard record. - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system. - `createdBy` string: Application user who created the row in the database, auto-populated by the system. - `source` string, required: Source of the data. - `origin` string: 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. - `origNetwork` string: 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. ## Other responses - `400`: Bad Request - `401`: Invalid/Missing User Credentials - `403`: User Is Not Authorized - `405`: Method Not Allowed - `406`: MediaType Not Accepted by Request Headers - `429`: Rate of Requests Exceeds Allowed Limit - `500`: Internal Server Error ## Changes > 12 revisions in range; 1 could not be searched. - **2025-05-29** `4e1cbc17e814`: 2 info - added the new optional `query` request parameter `firstResult` - added the new optional `query` request parameter `maxResults` - **2025-04-16** `75f764c843a9`: 2 info - api operation id `findAllTuples_56` removed and replaced with `` - the endpoint scheme security `BasicAuth` was removed from the API [Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/hazard/tuple/get.md) --- [API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)