Step | API | Comments |
|---|---|---|
1. Enroll the sensor | POST /devices/sensor-enrollments | Use the serial number on the sensor. |
2. List sensors associated with a tenant | GET /devices/environmental-sensors | Verify that the sensor has been enrolled. Optional filters are available. |
3. Create a task | POST /environmental/tasks | Configure the temperature recording thresholds and start method. Repeat for each task. |
4. Create a Webhook subscription | User receives only one Webhook notification per sensor per task. | |
5. Associate the sensor with the task | POST /environmental/tasks/{taskId)/sensors | Use the Task ID returned when the task was created and the Sensor ID returned when verifying sensor enrollment. Repeat for each sensor or associate multiple sensors at the same time. The task starts when the sensor receives the task. |
6. Add an asset to a task | POST/environmental/tasks/{taskId}/assets | Use the task ID returned when the task was created |
7. Stop the task | POST /environmental/tasks/{taskId}/stop | Stop recording temperatures. |
8. Retrieve details for the task | GET /environmental/tasks/{taskId} | Use the Task ID returned when the task was created. |
9. Retrieve all tasks | GET /environmental/tasks | Optional filters are available. |
10. Retrieve alarms for the task | GET /environmental/tasks/{taskId}/alarms | Use the Task ID returned when the task was created. Optional filters are available. |
11. Retrieve sensor read-event logs for the task | GET /data/environmental/tasks/{taskId}/log | Use the Task ID returned when the task was crated. Data may not be immediately available. |
