Get Additional Element Metadata
post
/{versionId}/configuration/deviceConfigs/{deviceId}/elementTypes/elementMetadata
Use this (POST) method to retrieve additional meta-data information about a targeted configuration element. SDM configuration support is model driven to allow a user to query any attribute supported by a release, and get additional information such as if it contains additional sub-element children, what are its inter-dependencies between other elements, and so on. A client can be configured to use this metadata for self-describing the characteristics of all elements supported by a given device release to develop an understanding of configuration element dependencies and the flow for which elements need to configured first, second, and so on.
Request
Path Parameters
Back to Top
Response
200 Response
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.
Examples
Example of Accessing the API with cURL
The following example shows how to get additional element metadata by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X POST \
-b sessionid.txt \
--header "Accept: application/xml" \
--header "Content-Type: application/xml" \
"https://example.com:8443/rest/v1.3/configuration/deviceConfigs/{deviceId}/elementTypes/elementMetadata"Example of Accessing the API with Python
The following example shows how to get additional element metadata by submitting a POST request on the REST resource using Python. This example assumes the cookie variable contains a valid authentication cookie. For an example of authenticating with Python, see Authenticate.
import requests
url = "https://example.com:8443/rest/v1.3/configuration/deviceConfigs/{deviceId}/elementTypes/elementMetadata"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.post(url, headers=headers)Example of the Response Body
This endpoint does not return a response body.