deleteInput

JSON hub "deleteInput" action deletes an input in FairCom Edge

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.

Inputs collect tags from a data source and insert them into an integration table.

Note A tag is a piece of named data with an associated value. For example, the tag temperature 70 includes both the named data temperature and the value 70. In JSON, a tag is a JSON property, such as "temperature": 70. In a SQL table, a tag is a data field, such as a field named temperature with a value of 70.

 

Request examples

Minimal

{
  "apiVersion": "1.0",
  "action": "deleteInput",
  "requestId": "00000001",
  "params": {
    "inputName": "opcDS2"
  },
  "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

Maximal

{
  "api": "hub",
  "apiVersion": "1.0",
  "action": "deleteInput",
  "requestId": "00000001",
  "params": {
    "inputName": "AcmefactoryLine1Station1AcidbathTelemetry",
    "preserve": "data"
  },
  "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

 

Response examples

Note If the target object does not exist, the response returns success, and the debug property contains a warning that the object was not found.

Minimal

{
    "result": {},
    "requestId": "00000001",
    "errorCode": 0,
    "errorMessage": ""
}
 
 

Maximal

{
  "result": {
  },
  "requestId": "00000001",
  "debugInfo": {
    "request": {
      "api": "hub",
      "action": "deleteInput",
      "params": {
        "inputName": "AcmefactoryLine1Station1AcidbathTelemetry",
        "preserve": "data"
      },
      "apiVersion": "1.0",
      "requestId": "00000001",
      "debug": "max",
      "authToken": "replaceWithAuthTokenFromCreateSession"
    },
    "warnings": [
      {
        "code": 100,
        "message": "Not able to find integration by name [AcmefactoryLine1Station1AcidbathTelemetry]."
      }
    ]
  },
  "errorCode": 0,
  "errorMessage": "",
  "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

 

Properties

Request properties ("params")

Property Description Default Type Limits (inclusive)

inputName

The "inputName" property specifies the unique name of an input. A FairCom generated name follows the pattern "Input #n from <pluginName> to <databaseName>.<ownerName>.<tableName>".

"params": {
    "inputName": "modbusTCP",
    "serviceName": "modbus"
}

Required - No default value

 string 1 to 100 bytes

preserve

The "preserve" property determines how data, if any, that is associated with an integration table or MQTT topic is preserved. It defaults to "data".

Possible values:
  • "data"
    • "data" is the default value, it preserves the entire table and its records.
  • "nothing"
    • "nothing" removes the table and its data.

Optional with default of "data"

 string enum

"data"

"nothing"

 

 

 

Was this article helpful?

Give feedback about this article

Related Articles