Skip to content

User Guide

This guide provides instructions on how to use the Graph API Service.

Getting Started

  1. Ensure the service is running.
  2. Use the provided API endpoints to interact with the service.

API Endpoints

Graph API

  • POST /device/all - Gets all devices
  • POST /device/totalDevices - Gets the total number of devices
  • POST /device/numOfDevicesConnected - Gets the number of connected devices
  • POST /device/devicesConnected - Gets a list of connected devices
  • POST /device/numDevicesByRoom - Gets the number of devices by room
  • POST /device/numOfRooms - Gets the number of rooms
  • POST /device/roomStatusCount - Gets the status count of rooms
  • GET /device/:id - Gets a specific device by serial number
  • GET /device/:id/health - Gets the health of a specific device by ID
  • POST /device/:id/refresh - Refreshes a specific device by serial number
  • POST /device/:id/filters - Updates filters for a specific device
  • PUT /device/:id/filters - Updates filters for a specific device
  • DELETE /device/:id/filters - Deletes filters for a specific device
  • POST /device/calls/getSubscriptionData - Gets subscription data

Filters

  • POST /filters/location - Gets location filters
  • POST /filters/region - Gets region filters
  • POST /filters/room - Gets room filters
  • GET /filtersConfig - Gets all filters config
  • GET /filtersConfig/:id - Gets filter config by ID
  • GET /filtersConfig/count - Counts all filters config
  • POST /filtersConfig/:id - Upserts filter config by ID
  • POST /filtersConfig - Upserts filters config
  • DELETE /filtersConfig/:id - Deletes filter config by ID
  • DELETE /filtersConfig - Deletes filters config not in given IDs
  • GET /filters - Gets all filters
  • GET /filters/:id - Gets filter by ID
  • GET /filters/device/:deviceSN - Gets filter by device serial number
  • GET /filters/count - Counts all filters
  • POST /filters/:id - Upserts filter by ID
  • POST /filters - Upserts filters
  • DELETE /filters/:id - Deletes filter by ID
  • DELETE /filters - Deletes filters not in given IDs

Intervals

  • POST /intervals/createTable - Creates the intervals table
  • GET /intervals - Gets all intervals
  • GET /intervals/:id - Gets interval by ID
  • POST /intervals - Creates a new interval
  • PUT /intervals/:id - Updates interval by ID
  • DELETE /intervals/:id - Deletes interval by ID

Refer to the API documentation for detailed information on each endpoint.