Skip to main content

"deleteOutput" (JSON Action)

JSON hub "deleteOutput" action removes a previously created FairCom Edge integration

The "deleteOutput" action removes a previously created integration. An integration connects data in the server to an output plugin that delivers tags from the server to external systems.

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

{
  "api": "hub",
  "apiVersion": "1.0",
  "requestId": "00000001",
  "action": "deleteOutput",
  "params": {
    "outputName": "restOutput"
  },
  "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",
  "debugInfo": {
    "request": {
      "api": "hub",
      "action": "deleteOutput",
      "params": {
        "outputName": "restOutput"
      },
      "apiVersion": "1",
      "requestId": "00000001",
      "responseOptions": {
      },
      "debug": "max",
      "authToken": "replaceWithAuthTokenFromCreateSession"
    },
    "warnings": [
      {
        "code": 100,
        "message": "Not able to find integration by name [restOutput]."
      }
    ]
  },
  "errorCode": 0,
  "errorMessage": "",
  "authToken": "replaceWithAuthTokenFromCreateSession"
}

Use the deleteOutput JSON API action to delete a previously created FairCom Edge integration

JSON hub APIAPI actionsJSON Actionoutput actionsdelete outputdeleteOutput

"params"

The "params" property is an object that contains an action's request parameters as defined by a set of properties. Each action defines its own required and optional properties. See System limits for a comprehensive overview of property requirements and limitations.

Table 1. deleteOutput "params" property summaries

Property

Description

Default

Type

Limits (inclusive)

outputName

uniquely names the mapping of a data source to an Input Service to an Integration Table.

Required - No default value

array of objects

1 to 64 bytes



"outputName"

The "outputName" property is an optional string that specifies a unique name for mapping an integration table to an output plugin to an external system.

  "params": {
    "outputName": "AcmefactoryLine1Station1AcidbathTelemetryOutput"
  }