Climate

Get events for environmental gateway

Get list of events for environmental gateway

POST/api/climate/getEventsForEnvironmentalGateway

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request to retrieve events for an environmental gateway.

createdAfterMsinteger<int64> | nullbody

Timestamp in milliseconds after which events should be retrieved

Example: 1640991600000

createdBeforeMsinteger<int64> | nullbody

Timestamp in milliseconds before which events should be retrieved

Example: 1640995200000

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastEvaluatedKeystring | nullbody

maxPageSizeinteger<int32> | nullbody

Maximum number of results to return per page

Example: 50

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/climate/getEventsForEnvironmentalGateway' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "createdAfterMs": 1640991600000,
    "createdBeforeMs": 1640995200000,
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "lastEvaluatedKey": "<string>",
    "maxPageSize": 50
  }'

import requests

url = "https://api2.rhombussystems.com/api/climate/getEventsForEnvironmentalGateway"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "createdAfterMs": 1640991600000,
    "createdBeforeMs": 1640995200000,
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "lastEvaluatedKey": "<string>",
    "maxPageSize": 50
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/climate/getEventsForEnvironmentalGateway', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "createdAfterMs": 1640991600000,
    "createdBeforeMs": 1640995200000,
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "lastEvaluatedKey": "<string>",
    "maxPageSize": 50
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "createdAfterMs": 1640991600000,
              "createdBeforeMs": 1640995200000,
              "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "lastEvaluatedKey": "<string>",
              "maxPageSize": 50
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/climate/getEventsForEnvironmentalGateway"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "events": [
    {
      "activities": [
        "SOUND_LOUD"
      ],
      "alertTriggerThresholds": [
        0
      ],
      "alertTriggers": [
        "SOUND_LOUD"
      ],
      "carbonMonoSense": {
        "adcRaw": 0,
        "adcVoltage": 0,
        "coConcentration": 0,
        "timestampSec": 0
      },
      "clipMetaData": {
        "activitySeekPoints": {
          "<key>": []
        },
        "activitySeekPointsV2": [
          {}
        ],
        "activitySeekPointsV3": [
          {}
        ],
        "boundingBoxes": [
          {}
        ],
        "clipLocation": {
          "region": "<string>"
        },
        "durationSec": 0,
        "mGrids": [
          "<string>"
        ],
        "soundSignificantLufs": [
          0
        ],
        "startTime": 0,
        "thumbnailLocation": {
          "region": "<string>"
        },
        "thumbnailLocationV2": "<string>"
      },
      "co2Sense": {
        "co2Ppm": 0,
        "relHumid": 0,
        "tempC": 0,
        "timestampSec": 0
      },
      "derivedValues": {
        "airQualityIndex": 0,
        "airQualityIndexPollutant": "OZONE",
        "calibrating": true,
        "deviceOrientation": "CEILING",
        "falsePositiveConfidencePercent": 0,
        "heatIndexDegF": 0,
        "heatIndexRangeWarning": "HEAT_INDEX_OK",
        "indoorAirQuality": 0,
        "malfunctioningModules": [
          "<string>"
        ],
        "smokeConfidencePercent": 0,
        "smokeThcConfidencePercent": 0,
        "smokeTobaccoConfidencePercent": 0,
        "timestampSec": 0,
        "tvoc": 0,
        "vapeConfidencePercent": 0,
        "vapeDetected": true,
        "vapeThcConfidencePercent": 0
      },
      "deviceType": "BLE_TRACKER",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "firmwareVersion": "<string>",
      "formaSense": {
        "ch2oPpb": 0,
        "relHumid": 0,
        "tempC": 0,
        "timestampSec": 0
      },
      "hwVariation": "RASPBERRY_PI_3",
      "leakProbe": {
        "adcMv": 0,
        "adcRaw": 0,
        "leakDetected": true,
        "moistDetected": true,
        "present": true,
        "timestampSec": 0
      },
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "pmSense": {
        "nc0p5": 0,
        "nc10p0": 0,
        "nc1p0": 0,
        "nc2p5": 0,
        "nc4p0": 0,
        "noxIdx": 0,
        "pm10p0": 0,
        "pm1p0": 0,
        "pm2p5": 0,
        "pm4p0": 0,
        "relHumid": 0,
        "tempC": 0,
        "timestampSec": 0,
        "typPartSize": 0,
        "vocIdx": 0
      },
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "pressSense": {
        "pressure": 0,
        "tempC": 0,
        "timestampSec": 0
      },
      "tempProbe": {
        "adcMv": 0,
        "adcRaw": 0,
        "present": true,
        "tempC": 0,
        "timestampSec": 0
      },
      "timestampMs": 0,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "lastEvaluatedKey": "<string>"
}

Response

200 OK

application/json · object

Response containing events for an environmental gateway.

eventsobject[] | null

List of climate events for the environmental gateway

Show child attributes

activitiesenum<string>[] | null

alertTriggerThresholdsnumber<double>[] | null

alertTriggersenum<string>[] | null

carbonMonoSenseobject

Show child attributes

adcRawinteger<int32> | null

adcVoltagenumber<double> | null

coConcentrationnumber<double> | null

timestampSecinteger<int64> | null

clipMetaDataobject

Show child attributes

activitySeekPointsobject | null

activitySeekPointsV2object[] | null

Show child attributes

activityenum<string>

Available options: SOUND_LOUD, SOUND_GUN_SHOT, TAMPER, VISUAL_TAMPER, MOTION_TAMPER, MOTION, MOTION_HUMAN, MOTION_CAR, MOTION_ANIMAL, MOTION_PACKAGE, PACKAGE_ARRIVED, PACKAGE_DEPARTED, FACE, FACE_IDENTIFIED, FACE_UNIDENTIFIED, FACE_BLACKLISTED, FACE_ALERT, POSE_ANOMALOUS, POSE_FALL, LICENSEPLATE, LICENSEPLATE_IDENTIFIED, LICENSEPLATE_UNIDENTIFIED, LICENSEPLATE_ALERT, LICENSEPLATE_BLACKLISTED, LICENSEPLATE_TRUSTED, PEOPLECOUNT_HIGH, PEOPLECOUNT_HIGH_RESET, PEOPLECOUNT_LOW, PEOPLECOUNT_LOW_RESET, HUMAN_ENTER, HUMAN_EXIT, CAR_ENTER, CAR_EXIT, TEMPERATURE_EXCEEDED_HIGH, TEMPERATURE_EXCEEDED_LOW, HUMIDITY_EXCEEDED_HIGH, HUMIDITY_EXCEEDED_LOW, PM25_EXCEEDED_HIGH, TVOC_EXCEEDED_HIGH, ETOH_EXCEEDED_HIGH, IAQ_EXCEEDED_HIGH, CO2_EXCEEDED_HIGH, CO2_EXCEEDED_LOW, PROBE_TEMPERATURE_EXCEEDED_HIGH, PROBE_TEMPERATURE_EXCEEDED_LOW, PROBE_DISCONNECTED, PROBE_CONNECTED, HEAT_INDEX_EXCEEDED_HIGH, PRESSURE_EXCEEDED_HIGH, PRESSURE_EXCEEDED_LOW, PM10_EXCEEDED_HIGH, PM40_EXCEEDED_HIGH, PM100_EXCEEDED_HIGH, VOC_IDX_EXCEEDED_HIGH, NOX_IDX_EXCEEDED_HIGH, FORMALDEHYDE_EXCEEDED_HIGH, CARBON_MONOXIDE_EXCEEDED_HIGH, AQI_EXCEEDED_HIGH, DOOR_AJAR, DOOR_OPENED, DOOR_CLOSED, BUTTON_SINGLE_PRESSED, BUTTON_DOUBLE_PRESSED, BUTTON_LONG_PRESSED, TAG_ARRIVED, TAG_DEPARTED, TAG_MOVED, TAG_POSITIONING_CHANGED, TAG_BOUNDARY_INGRESS, TAG_BOUNDARY_EGRESS, TAG_PANIC, BADGE_AUTHORIZED, BADGE_UNAUTHORIZED, BADGE_UNAUTHORIZED_V2, BADGE_AJAR, BADGE_MANUAL, BADGE_FORCED_OPEN, BADGE_LOCKDOWN, BADGE_REQUEST_TO_EXIT, BADGE_DURESS, BADGE_SECURITY_BREACH, BADGE_TAMPER, BADGE_FACE_MISMATCH, POS_ORDER, GUN_DETECT_EVENT, IOT_SOUND_AGGRESSION, IOT_SOUND_HELP, IOT_AIR_CO, IOT_AIR_CO2, IOT_AIR_MASKING, IOT_AIR_THC, IOT_AIR_VAPE, IOT_AIR_VOC, IOT_AIR_TEMP, IOT_TAMPER, IOT_GUNSHOT, IOT_BUTTON_SINGLE_CLICK, IOT_BUTTON_DOUBLE_CLICK, IOT_BUTTON_HOLD, IOT_PANIC_BUTTON_TRIGGERED, AUDIO_SOUND_SIGNIFICANT, AUDIO_SOUND_LOUD, AUDIO_SOUND_ABUSIVE, AUDIO_SOUND_GREETING, AUDIO_SOUND_HELP, AUDIO_SOUND_GUN, AUDIO_SOUND_GLASS_BREAK, AUDIO_SOUND_ALARM_SMOKE_FIRE, AUDIO_SOUND_ALARM_CARBON_MONOXIDE, AUDIO_SOUND_SIREN, CLIMATE_VOC, CLIMATE_VAPE, CLIMATE_SMOKE, CLIMATE_THC, CLIMATE_CO2, CLIMATE_ETOH, CLIMATE_PM25, CLIMATE_IAQ, CLIMATE_LEAK, SOUND_AGGRESSION, SOUND_HELP, AIR_CO, AIR_CO2, AIR_MASKING, AIR_THC, AIR_VAPE, AIR_VOC, MASK_MISSING, HELMET_MISSING, GLOVES_MISSING, PIR_OCCUPIED, PIR_MOVEMENT, PIR_VACANT, CUSTOM, VISITOR_ARRIVED, VISITOR_DEPARTED, AC_DR_CONNECTED, AC_DR_DISCONNECTED, AC_DPI_DOOR_OPEN, AC_DPI_DOOR_CLOSED, AC_DPI_DOOR_AJAR, AC_DPI_DOOR_FORCED_OPEN, AC_DSR_UNLOCKED, AC_DSR_LOCKED, AC_DB_TRIGGERED, AC_PANIC_BUTTON_TRIGGERED, AC_REMOTE_UNLOCK, AC_BADGE_AUTHORIZED, AC_BADGE_UNAUTHORIZED, AC_BADGE_FACE_MISMATCH, AC_LOCKDOWN_ACTIVATED, AC_LOCKDOWN_DEACTIVATED, AC_LOCKDOWN_PLAN_SWITCHED, AC_TAMPER_PROX, AC_TAMPER_ACCEL, AC_TAMPER_SWITCH, AC_GR_ACTIVE, AC_GR_INACTIVE, AC_GI_ACTIVE, AC_GI_INACTIVE, AC_REX_ACTIVE, AC_REX_INACTIVE, AC_APERIO_DEVICE_DISCONNECTED, AC_APERIO_DEVICE_CONNECTED, AC_APERIO_DEVICE_REBOOT, AC_APERIO_DEVICE_TAMPER, AC_APERIO_LOW_BATTERY, AC_APERIO_FLAT_BATTERY, AC_APERIO_OK_BATTERY, AC_SCHLAGE_GW_DISCONNECTED, AC_SCHLAGE_GW_CONNECTED, AC_SCHLAGE_APM_DISCONNECTED, AC_SCHLAGE_APM_CONNECTED, AC_SCHLAGE_LOW_BATTERY, AC_SCHLAGE_CRITICAL_BATTERY, AC_SCHLAGE_OK_BATTERY, POWER_SWITCH_BATTERY, POWER_SWITCH_PRIMARY, AI_SEARCH_MATCH, AI_SEARCH_MATCH_PERSON_SMOKING, AI_SEARCH_MATCH_PERSON_ON_PHONE, AI_SEARCH_MATCH_PERSON_FALLING, CUSTOM_LLM_BOOLEAN_TRUE, CUSTOM_LLM_BOOLEAN_FALSE, CUSTOM_LLM_THRESHOLD_EXCEEDED_LOW, CUSTOM_LLM_THRESHOLD_EXCEEDED_HIGH, ALM_AUTHORITIES_CONTACTED, ALM_MONITORING_ENABLED, ALM_MONITORING_DISABLED, ALM_MONITORING_SETTINGS_CHANGE, ALM_THREAT_CASE_CLOSED, ALM_THREAT_DETECTED, ALM_MONITORING_EVENT_DETECTED, ROBOT_DOG_DETECTED, ROBOT_ARRIVED_AT_WAYPOINT, ROBOT_ARRIVED_AT_POSE, ROBOT_WAITING_AT_POSE, ROBOT_MANUAL_CMD_VEL, ROBOT_MANUAL_ACTION, ROBOT_MANUAL_POSTURE, ROBOT_NAVIGATE_TO_POSE_START, ROBOT_NAVIGATE_TO_POSE_END, ROBOT_NAVIGATE_TO_HOME_START, ROBOT_NAVIGATE_TO_HOME_END, ROBOT_NAVIGATE_TO_WAYPOINT_START, ROBOT_NAVIGATE_TO_WAYPOINT_END, ROBOT_ROUTE_RUN_START, ROBOT_ROUTE_RUN_END, ROBOT_LOW_BATTERY_DOCKING, ROBOT_IDLE_DOCKING, ROBOT_EMERGENCY, LOITER_HUMAN, INACTIVITY_HUMAN, INACTIVITY_CAR, GROUP_ENTRY, ONGUARD_BADGE_AUTHORIZED, ONGUARD_BADGE_ANOMALY, ONGUARD_NO_ENTRY_MADE, ELEMENTS_BADGE_AUTHORIZED, ELEMENTS_BADGE_ANOMALY, ELEMENTS_NO_ENTRY_MADE, NETBOX_BADGE_AUTHORIZED, NETBOX_BADGE_ANOMALY, NETBOX_NO_ENTRY_MADE, THERMAL_TEMPERATURE_ALARM, THERMAL_TEMPERATURE_WARNING, THERMAL_FIRE_DETECTED, THERMAL_SMOKING_DETECTED, THERMAL_FIRE_VERIFIED, THERMAL_HEAT_NO_THREAT, THERMAL_VISUAL_HOTSPOT, THERMAL_VISUAL_HEAT_RISE, THERMAL_VISUAL_WARM_BODY, UNKNOWN

alertboolean | null

bottomnumber<float> | null

faceNamestring | null

keypointsV2object | null

Show child attributes

xinteger<int32> | null

yinteger<int32> | null

leftnumber<float> | null

licensePlatestring | null

posestring | null

relativeSecondnumber<float> | null

rightnumber<float> | null

topnumber<float> | null

unidentifiedFaceIdstring | null

vehicleNamestring | null

activitySeekPointsV3object[] | null

Show child attributes

activityenum<string>

alertboolean | null

customActivityColorenum<string>

Available options: BLUE, RED, PURPLE, TAN, ORANGE, TEAL, GRAY, BLACK

customActivityDescriptionstring | null

customActivityDisplayNamestring | null

dcaoboolean | null

dwellingboolean | null

faceNamestring | null

idinteger<int32> | null

inMotionboolean | null

licensePlatestring | null

loudnessinteger<int32> | null

posestring | null

relativeSecondnumber<float> | null

sensorValTypeobject

Show child attributes

sensorBooleanboolean | null

sensorDoublenumber<double> | null

sensorLonginteger<int64> | null

stableTrackIdinteger<int32> | null

toastOrderIdInfoobject

Show child attributes

employeeNamestring | null

guidstring | null

locationNamestring | null

restaurantNamestring | null

toastCheckInfoobject

Show child attributes

totalAmountnumber<double> | null

tustring | null

unidentifiedFaceIdstring | null

vehicleNamestring | null

boundingBoxesobject[] | null

Show child attributes

activityenum<string>

alertboolean | null

bottominteger<int32> | null

confidencenumber<float> | null

croppedImageLocatorstring | null

customActivityColorenum<string>

Available options: BLUE, RED, PURPLE, TAN, ORANGE, TEAL, GRAY, BLACK

customActivityDescriptionstring | null

customActivityDisplayNamestring | null

dwellingboolean | null

faceNamestring | null

inMotionboolean | null

keypointsV2object | null

Show child attributes

xinteger<int32> | null

yinteger<int32> | null

leftinteger<int32> | null

licensePlatestring | null

loudnessinteger<int32> | null

objectIdinteger<int32> | null

posestring | null

relativeSecondnumber<float> | null

rightinteger<int32> | null

sensorValTypeobject

Show child attributes

sensorBooleanboolean | null

sensorDoublenumber<double> | null

sensorLonginteger<int64> | null

stableTrackIdinteger<int32> | null

toastOrderIdInfoobject

Show child attributes

employeeNamestring | null

guidstring | null

locationNamestring | null

restaurantNamestring | null

toastCheckInfoobject

Show child attributes

totalAmountnumber<double> | null

topinteger<int32> | null

unidentifiedFaceIdstring | null

vehicleNamestring | null

clipLocationobject

Show child attributes

regionstring | null

durationSecinteger<int32> | null

mGridsstring[] | null

soundSignificantLufsinteger<int32>[] | null

startTimeinteger<int64> | null

thumbnailLocationobject

Show child attributes

regionstring | null

thumbnailLocationV2string | null

co2Senseobject

Show child attributes

co2Ppminteger<int32> | null

relHumidnumber<float> | null

tempCnumber<float> | null

timestampSecinteger<int64> | null

derivedValuesobject

Show child attributes

airQualityIndexinteger<int32> | null

airQualityIndexPollutantenum<string>

Primary pollutant affecting air quality index

Available options: OZONE, PM2P5, PM10P0, CO, NO2, SO2, UNKNOWN

calibratingboolean | null

deviceOrientationenum<string>

Available options: CEILING, FLOOR, WALL, WALL_CROOKED, INDETERMINATE

falsePositiveConfidencePercentnumber<float> | null

heatIndexDegFnumber<double> | null

heatIndexRangeWarningenum<string>

Heat index range warning status

Available options: HEAT_INDEX_OK, HEAT_INDEX_WARNING, HEAT_INDEX_UNSUPPORTED

indoorAirQualitynumber<float> | null

malfunctioningModulesstring[] | null

smokeConfidencePercentnumber<float> | null

smokeThcConfidencePercentnumber<float> | null

smokeTobaccoConfidencePercentnumber<float> | null

timestampSecinteger<int64> | null

tvocnumber<float> | null

vapeConfidencePercentnumber<float> | null

vapeDetectedboolean | null

vapeThcConfidencePercentnumber<float> | null

deviceTypeenum<string>

Available options: BLE_TRACKER, CAMERA, DOOR_SENSOR, ENVIRONMENTAL_SENSOR, OCCUPANCY_SENSOR, AUDIO_GATEWAY, EXECUTABLE, BADGE_READER, DOOR_CONTROLLER, BLE_BUTTON, IO_BOARD, ENVIRONMENTAL_GATEWAY, NVR, ROBOT, UNKNOWN

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

firmwareVersionstring | null

formaSenseobject

Show child attributes

ch2oPpbnumber<float> | null

relHumidnumber<float> | null

tempCnumber<float> | null

timestampSecinteger<int64> | null

hwVariationenum<string>

Available options: RASPBERRY_PI_3, CAMERA_R1, CAMERA_R2, CAMERA_R2_LONG_RANGE, CAMERA_R2_180, CAMERA_R3, CAMERA_R4, CAMERA_R100, CAMERA_R120, CAMERA_R170, CAMERA_R200, CAMERA_R500, CAMERA_R510, CAMERA_R520, CAMERA_R600, SENSOR_ASSET_TAG_T1, SENSOR_DOOR_D1, SENSOR_DOOR_D20, SENSOR_ENVIRONMENTAL_E1, SENSOR_ENVIRONMENTAL_E15, SENSOR_ENVIRONMENTAL_E2, SENSOR_MOTION_M1, SENSOR_MOTION_M15, GATEWAY_A1, GATEWAY_A100, GATEWAY_ENVIRONMENTAL_E50, CAMERA_R220, CAMERA_R230, CAMERA_R36S, CAMERA_R410, CAMERA_R540, CAMERA_R545, BADGE_READER_DR1, BADGE_READER_DR40, BADGE_READER_DR20, DOOR_CONTROLLER_DC1, DOOR_CONTROLLER_DC20, DOOR_CONTROLLER_DC10, ETHERNET_TESTER_ET1, IO_BOARD_TB1, BLE_BUTTON_B10, BLE_BUTTON_B15, CAMERA_THIRD_PARTY_RELAY, CAMERA_THIRD_PARTY_NVR, CAMERA_THIRD_PARTY_NVR_MULTISENSOR, NVR_N100, CAMERA_R130, NVR_N500, CAMERA_R150, ROBOT_RC1, CAMERA_R210, CAMERA_R650, NVR_N550, NVR_N551, ROBOT_RC2, UNSPECIFIED

leakProbeobject

Show child attributes

adcMvnumber<float> | null

adcRawinteger<int64> | null

leakDetectedboolean | null

moistDetectedboolean | null

presentboolean | null

timestampSecinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

pmSenseobject

Show child attributes

nc0p5number<float> | null

nc10p0number<float> | null

nc1p0number<float> | null

nc2p5number<float> | null

nc4p0number<float> | null

noxIdxnumber<float> | null

pm10p0number<float> | null

pm1p0number<float> | null

pm2p5number<float> | null

pm4p0number<float> | null

relHumidnumber<float> | null

tempCnumber<float> | null

timestampSecinteger<int64> | null

typPartSizenumber<float> | null

vocIdxnumber<float> | null

policyUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

pressSenseobject

Show child attributes

pressurenumber<float> | null

tempCnumber<float> | null

timestampSecinteger<int64> | null

tempProbeobject

Show child attributes

adcMvnumber<float> | null

adcRawinteger<int64> | null

presentboolean | null

tempCnumber<float> | null

timestampSecinteger<int64> | null

timestampMsinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lastEvaluatedKeystring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.