Jump to

• Request
• Response

Delete a Configuration Element

post

/rest/{versionId}/configuration/deviceConfigs/{deviceId}/configElements/delete

Use this (POST) method to delete the complete targeted configuration element instance. If the configuration element instance has sub-element children, they are also deleted from the targeted device configuration. This deletion is only done on the SDM database and is not pushed to the device. The deletion is not applied to the device until an action method is initiated. Refer to the Perform a Device Action (POST) method for more information.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• deviceId: string
• versionId: string

Body ()

Root Schema : configElement

Type: object

Show Source

• attributes(optional): array attribute
• childrenElements(optional): array childrenElement
• elementTypePath(optional): string
• parentElement(optional): object configElement

{
    "type":"object",
    "properties":{
        "elementTypePath":{
            "type":"string"
        },
        "parentElement":{
            "$ref":"#/definitions/RestConfigElement"
        },
        "attributes":{
            "type":"array",
            "xml":{
                "name":"attribute",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RestConfigAttribute"
            }
        },
        "childrenElements":{
            "type":"array",
            "xml":{
                "name":"childrenElement",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RestConfigElement"
            }
        }
    },
    "xml":{
        "name":"configElement"
    }
}

Nested Schema : attribute

Type: array

Show Source

• Array of: object attribute

{
    "type":"array",
    "xml":{
        "name":"attribute",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/RestConfigAttribute"
    }
}

Nested Schema : childrenElement

Type: array

Show Source

• Array of: object configElement

{
    "type":"array",
    "xml":{
        "name":"childrenElement",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/RestConfigElement"
    }
}

Nested Schema : attribute

Type: object

Show Source

• name(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "xml":{
        "name":"attribute"
    }
}

Back to Top

Response

204 Response

Successfully processed the request with no content.

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

Back to Top