"deleteInput"
deleteInput removes a previously created input definition as long as no output definitions are using it.
The "deleteInput"
action removes a previously created input definition as long as no output definitions are using it. A failure response lists the output definitions that prevent the input definition from being deleted.
Request examples
Minimal request example
{ "api": "hub", "apiVersion": "1.0", "action": "deleteInput", "requestId": "00000001", "authToken": "anAuthorizationTokenFromTheServer", "params": { "inputName": "opcDS2" } }
{ "api": "hub", "apiVersion": "1.0", "action": "deleteInput", "requestId": "00000001", "authToken": "anAuthorizationTokenFromTheServer", "params": { "inputName": "opcDS2", "preserve": "data" } }
Response examples
{ "result": {}, "requestId": "00000016", "errorCode": 0, "errorMessage": "" }
{ "result": {}, "requestId": "00000016", "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
"params"
property summariesProperty | Description | Default | Type | Limits (inclusive) | ||
---|---|---|---|---|---|---|
| contains a unique name for the mapping of a data source to an input plugin to an integration table | A FairCom generated name that follows the pattern | string |
| ||
determines how data, if any, that is associated with the topic is preserved |
| string |
|
The "preserve"
property is an optional, case-insensitive string enum that determines how data, if any, that is associated with an integration table or MQTT topic is preserved. It defaults to "data"
.
"data"
"data"
is the default value, it preserves the entire table and its records."nothing"
"nothing"
removes the table and its data.