Skip to main content

"deleteOutput"

The JSON Edge API "deleteOutput" action removes a previously created FairCom Edge integration

Abstract

deleteOutput removes a previously created 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 request example

{
  "api": "hub",
  "apiVersion": "1.0",
  "requestId": "00000001",
  "authToken": "anAuthorizationTokenFromTheServer",
  "action": "deleteOutput",
  "params": {
    "outputName": "AcmefactoryLine1Station1AcidbathTelemetryOutput"
  }
}

Maximal request example

Response examples
Minimal response example
Maximal request example
"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)
addFields
adds new fields to the table and specify their properties
[]
array of objects
apiVersion
specifies the major, minor, and patch versions of the API
Required - No default value
string
0 to 12 bytes
applyChangesNow
applies your specified changes immediately to the table when true
false
Boolean
true
false
authToken
signifies that the client is authenticated and authorized
Required - No default value
string
0 to 255 bytes
databaseName
contains the name of a database
Required - No default value
string
1 to 64 bytes
increaseFieldSize
specifies a field in the table and modify its properties
[]
array of objects
metadata
exists primarily for the user interface to find integration information
{}
object
May contain any number and type of user-defined properties
retentionPeriod
sets the number of retention units, which controls how long data is retained – see "retentionUnit"
30
integer
> 0
retentionUnit
purges expired messages each time this unit cycles – see "retentionPeriod"
"day"
string
"minute"
"hour"
"day"
"week"
"month"
"year"
tableName
specifies the name of the table where FairCom will store the data that it extracts for incoming data messages published to the "configureTopic"
Required - No default value
string
1 to 64 bytes
transforms
contains up to nine transformations
"source_payload"
array of objects