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 70includes both the named data temperature and the value70. 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 of70.
Request examples
Minimal
{
"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": {
"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"
}
Properties
Request properties ("params")
| Property | Description | Default | Type | Limits (inclusive) |
|---|---|---|---|---|
outputName |
The "outputName" property specifies a unique name for mapping an integration table to an output plugin to an external system. A FairCom generated name follows the pattern "Output #n from <databaseName>.<schemaName>.<tableName> to <pluginName>". |
Optional with default of |
string | 1 to 64 bytes |