Skip to main content

"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 request

{
  "api": "hub",
  "apiVersion": "1.0",
  "action": "deleteInput",
  "requestId": "00000001",
  "authToken": "anAuthorizationTokenFromTheServer",
  "params": {
    "inputName": "opcDS2"
  }
}

Maximal request

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

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 response

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

Maximal response

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

Use the deleteInput JSON API action to delete an input in FairCom Edge

API actionsJSON hub APIjsonActioninput actionsdelete inputdeleteInput

"params"

The "params" property is an object that contains an action's parameters. Each action defines its own required and optional properties.

Properties summary

Table 1. "params" properties summary

Property

Description

Default

Type

Limits (inclusive)

inputName

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 "Input #n from <pluginName> to <databaseName>.<ownerName>.<tableName>"

string

0 to 100 bytes

preserve

specifies how data, if any, that is associated with the topic is preserved

"nothing"

string

"data"
"nothing"


"preserve"

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".

Possible values:

  • "data"

    "data" is the default value, it preserves the entire table and its records.

  • "nothing"

    "nothing" removes the table and its data.