Get Configuration

POST {{base_url}}/api/v2/configuration/get

Description

Response Body Contents

  • _id (string): The unique idenitifiaction of the post request.

  • configurationId (string): The unique idenitifiaction of the configuration.

  • templateId (string): The unique idenitifiaction of the template.

  • isDefault (boolean): Indicates if it is the default configuration.

  • name (string): The name of the configuration.

  • deviceType (string): The type of the device (Tag or Locator).

  • protocol (string): The protocol used by the device (BLE,WIFI,LTE,IOX").

  • industry (string): The industry associated with the configuration.

  • profile (object): Additional profile information containing the following parameters:

    • lteFrequency (number): The idle frequency in the user interface. Represents how many times per day an event is sent when the service is idle.
    • motionRate (number): The motion frequency in the user interface. Represents how many times per day an event is sent when the device is in motion.
    • accMgThreshold (number): The accelerometer magnetic threshold.
    • gpsOnly (boolean): Indicates if GPS-only mode is enabled.
    • gpsEnabled (boolean): Indicates if GPS is enabled.
    • gpsTimeout (number): The GPS timeout duration.
    • debugOutput (boolean): Indicates if debug output is enabled.
    • mqttUrl (object): Indicates MQTT (Message Queuing Telemetry Transport) is set

Request Body

{"deviceType"=>"Tag", "protocol"=>"LTE"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"_id":"6331b62dd5e309775113503a","configurationId":"6331b62df18d2eb10e170a41","templateId":"LTE-Tag","isDefault":true,"name":"LTE-Tag","deviceType":"Tag","protocol":"LTE","industry":"assetflo","profile":{"lteFrequency":4,"motionFrequency":2,"accMgThreshold":150,"gpsOnly":false,"gpsEnabled":true,"gpsTimeout":180,"noOfAnchorsForNoGPS":3,"numOfAnchorsToScan":4,"blePresent":1,"BLEAdvEnabled":false,"isPoweredDevice":false,"isIndoorDevice":false,"inShipping":false,"ledEnabled":true,"debugOutput":true,"txPower":-31,"configurationNumber":0,"mqtt":{"url":"mqtts://xxxx-xxxx.cloudmqtt.com","options":{"username":"xxxx","password":"xxxx","port":"8883"}},"statusServer":"assetflo.io"}}