Cyan Web API - Version 1


DELETE api/nodeRoutes?{nodeId}&{userId?}&{userGroupId?}&{deviceId?}&{deviceGroupId?}&{applicationId?}&{applicationVersionId?}&{customKey?}&{customValue?}&{deleteChildRoutes?}

            Deletes node routes for the given node.  Allows the caller to pass optional route filter parameters to control
            exactly which routes will be deleted from the node (and child nodes, if deleteChildNodes is true).
            

Request Information

Parameters

NameDescriptionAdditional information
nodeId
NodeId for the top-level node for which to delete routes.

Define this parameter in the request URI.

userId
Optional filter to only delete routes matching this userId.

Define this parameter in the request URI.

userGroupId
Optional filter to only delete routes matching this userGroupId.

Define this parameter in the request URI.

deviceId
Optional filter to only delete routes matching this deviceId.

Define this parameter in the request URI.

deviceGroupId
Optional filter to only delete routes matching this deviceGroupId.

Define this parameter in the request URI.

applicationId
Optional filter to only delete routes matching this applicationId.

Define this parameter in the request URI.

applicationVersionId
Optional filter to only delete routes metching this applicationVersionId.

Define this parameter in the request URI.

customKey
Optional filter to only delete routes metching this custom key.

Define this parameter in the request URI.

customValue
Optional filter to only delete routes metching this custom value.

Define this parameter in the request URI.

deleteChildRoutes
Whether to delete the same routes for children of the given Node.
            If this is set to false, only routes for the specified node will be deleted.
            If set to true, all children, children-of-children, and so on will be recursively deleted starting at the specified Node
            and working downwards.
            Child nodes are found by matching the ParentType+ParentId to the specified node's Type+Id.
            The same optional route filters (userId, userGroupId, etc.) will be applied when deleting routes for child nodes.

Define this parameter in the request URI.