"describeInputs"
The "describeInputs" action returns all available information about each specified input.
Request examples
Minimal request example
{
"api": "hub",
"apiVersion": "1.0",
"requestId": "00000027",
"authToken": "F59Y2O7c4YBfuHDIamLJJnULdWFauXxRwMMTwBOHffAECs6gLSotW8dcdewTid2E",
"action": "describeInputs",
"params": {
"inputNames": [
"modbusTCP"
]
}
}Response examples
{
"result": {
"data": [
{
"inputName": "modbusTCP",
"serviceName": "modbus",
"settings": {
"modbusProtocol": "TCP",
"modbusServer": "127.0.0.1",
"modbusServerPort": 1505,
"modbusDataCollectionIntervalMilliseconds": 15000,
"propertyMapList": [
{
"propertyPath": "temperature",
"modbusDataAddress": 1199,
"modbusDataAccess": "register",
"modbusSlave": 5,
"modbusDataLen": 1
},
{
"propertyPath": "volume",
"modbusDataAddress": 1299,
"modbusDataAccess": "register",
"modbusSlave": 5,
"modbusByteOrder": "ABCD",
"modbusDataLen": 2
},
{
"propertyPath": "status",
"modbusDataAddress": 1199,
"modbusDataAccess": "coil",
"modbusSlave": 5,
"modbusDataLen": 1
}
]
},
"databaseName": "ctreeSQL",
"ownerName": "admin",
"tableName": "modbustabletcp",
"metadata": {},
"retentionPolicy": "autoPurge",
"retentionPeriod": 30,
"retentionUnit": "day"
}
]
},
"requestId": "00000027",
"errorCode": 0,
"errorMessage": ""
}"params"
The "params" property is an object that contains an action's parameters. Each action defines its own required and optional properties.
Property summary
Table 1.
"params" property summariesProperty | Description | Default | Type | Limits (inclusive) |
|---|---|---|---|---|
| contains |
| array |
"result"
Property summary
Table 2.
"result" property summariesProperty | Description | Type | Limits (inclusive) |
|---|---|---|---|
| contains an array or object that the server returns, such as records returned by a query NoteIt is an empty array when there are no results available. | array | Its contents are determined by the action |