Delete Sub-Device¶
The Delete Sub-Device node deletes one or more sub-devices from a logged in gateway.
Node Type¶
EnOS.
Input and Output Ability¶
This node has multiple entry points and 2 exit points (success/failure).
Node Properties¶
Name
The name for this node.
Description
The description for this node.
Samples¶
Input Sample¶
The devices to be deleted will be displayed in ComponentRequest[Topo-Delete]
.
{
"MetaData": {
"messageType": "TopoDelete",
"assetId": "assetId",
"deviceKey": "deviceKey",
"productKey": "productKey",
"orgId": "yourOrgId",
"ts": "1660634424113"
},
"Body": {
"ComponentRequest[Topo-Delete]": [
{
"deviceKey": "deviceKey1",
"productKey": "productKey1"
},
{
"deviceKey": "deviceKey2",
"productKey": "productKey2"
}
]
}
}
Output Sample¶
The values of
componentResult
indicates whether the devices are deleted successsfully.Success
: All devices are deleted successfully.Failure
: Failed to delete some or all of the devices.
The information for all the devices (includes successful and failed) will be displayed in
ComponentRequest[Topo-Delete]
in theBody
.
{
"MetaData": {
"messageType": "TopoDelete",
"assetId": "assetId",
"deviceKey": "deviceKey",
"productKey": "productKey",
"orgId": "yourOrgId",
"componentResult": "Success",
"ts": "1660634424113"
},
"Body": {
"ComponentRequest[Topo-Delete]": [
{
"deviceKey": "deviceKey1",
"productKey": "productKey1"
},
{
"deviceKey": "deviceKey2",
"productKey": "productKey2"
}
]
}
}