Jump to

• Request
• Response

Get a List of Configuration Element Instances

get

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

Use this (GET) method to retrieve a list of configuration element instances for a specific element type (refer to Get an Element by Its Type). For example, requesting configuration element instances for NetworkInterface returns all the network-interface instances currently existing in the targeted device configuration.

Request

Path Parameters

• deviceId: string
• versionId: string

Query Parameters

• ascending(optional): string
• elementTypePath(optional): string
• limitation(optional): string
• offset(optional): string
• sort(optional): string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : configElements

Type: object

Show Source

• configElements(optional): array configElement
• pageInfo(optional): object PageInfo

{
    "type":"object",
    "properties":{
        "pageInfo":{
            "$ref":"#/definitions/PageInfo"
        },
        "configElements":{
            "type":"array",
            "xml":{
                "name":"configElement"
            },
            "items":{
                "$ref":"#/definitions/RestConfigElement"
            }
        }
    },
    "xml":{
        "name":"configElements"
    }
}

Nested Schema : configElement

Type: array

Show Source

• Array of: object configElement

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

Nested Schema : PageInfo

Type: object

Show Source

• limitation(optional): integer(int32)
• numberOfElements(optional): integer(int64)
• offset(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "limitation":{
            "type":"integer",
            "format":"int32"
        },
        "numberOfElements":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested 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"
    }
}

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