Skip to main content

"deleteOutput"

Abstract

deleteOutput removes a previously created integration.

The "deleteOutput" action removes a previously created integration.

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.
Property summary
Table 1. "params" property summaries
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
Minimum length: 0
Maximum length: 12
"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
Minimum length: 0
Maximum length: 255
"databaseName"
contains the name of a database
Required - No default value
string
Minimum length: 1
Maximum length: 64
"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
Minimum length: 1
Maximum length 64
"transforms"
contains up to nine transformations
"source_payload"
array of objects