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 |
Response properties ("result")
| Property | Description | Type | Limits (inclusive) |
|---|---|---|---|
data |
The |
array of objects | The action determines its contents. |
|
data .settings |
The |
object |
See these pages for connector specific properties: |
|
data settings .propertyMapList |
The "propertyMapList" property specifies which data the connector requests and where to put it in the generated JSON. |
array of objects |
See these pages for connector specific properties: |
|
data settings propertyMapList .propertyPath |
The "propertyPath" property specifies the JSON path in the JSON document where the connector puts the data it collects. It is mutually exclusive with the "tagName" and "tagId" properties. |
string | JSON path |
|
data settings propertyMapList .tagId |
The "tagId" property associates a tag with a value being collected by a connector. It is mutually exclusive with the "tagName" and "propertyPath" properties. See tagId for more details. |
integer | If present, it must contain the ID of an existing tag, which is an integer from 0 to 9223372036854770000.Note FairCom recommends using this property instead of "propertyPath". |
|
data settings propertyMapList .tagName |
The "tagName" property associates a tag with a value being collected by a connector. It is mutually exclusive with the "tagId" and "propertyPath" properties. See tagName for more details. |
string |
If present, it must contain the name of an existing tag. Note FairCom recommends using this property instead of |
|
data .thingId |
The "thingId" property associates a connector with a device or software application. It is mutually exclusive with the "thingName" property. See thingId for more details. |
integer | If present, it must contain the ID of an existing thing, which is an integer form 0 to 9223372036854770000. |
|
data .thingName |
The "thingName" property associates a connector with a device or software application. It is mutually exclusive with the "thingId" property. See thingName for more details. |
string | 1 to 64 bytes |