Get Additional Element Metadata
post
/{versionId}/configuration/deviceConfigs/{deviceId}/elementTypes/elementMetadata
Retrieve additional metadata 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
Examples of Accessing the API
See Authenticate for how to acquire a session cookie.
The following example shows how to get additional element metadata using 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"The following example shows how to get additional element metadata using Python.
import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/configuration/deviceConfigs/{deviceId}/elementTypes/elementMetadata"
headers = { "Accept":"application/xml", "Content-Type: application/xml", "Cookie":cookie }
data = etree.tostring(etree.parse("request.json"))
resp = requests.post(url, headers=headers, data=data)Example of the Request Body
The following example shows the contents of the request body in XML.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<elementTypeRequest>
<elementTypePath>localPolicy/policyAttribute</elementTypePath>
</elementTypeRequest>The following example shows the contents of the request body in JSON.
{
"elementTypePath": "localPolicy"
}Example of the Response Body
The following example shows the contents of the response body in XML.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<elementMetadata>
<attributeMetadatas>
<cliName>lookup</cliName>
<defaultValue>single</defaultValue>
<enumeratedValues>single</enumeratedValues>
<enumeratedValues>multi</enumeratedValues>
<key>false</key>
<name>lookup</name>
<required>false</required>
<valueType>ENUMERATED_VALUE</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>next-hop</cliName>
<defaultValue></defaultValue>
<key>true</key>
<name>nextHop</name>
<required>true</required>
<valueType>STRING</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>auth-user-lookup</cliName>
<defaultValue></defaultValue>
<key>false</key>
<name>authUserlookup</name>
<required>false</required>
<valueType>STRING</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>cost</cliName>
<defaultValue>0</defaultValue>
<key>false</key>
<name>cost</name>
<required>false</required>
<validNumericRanges>0-999999999</validNumericRanges>
<valueType>NUMERIC</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>methods</cliName>
<defaultValue></defaultValue>
<delimiter> </delimiter>
<key>false</key>
<name>methods</name>
<required>false</required>
<valueType>DELIMITED_STRING</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>terminate-recursion</cliName>
<defaultValue>disabled</defaultValue>
<key>true</key>
<name>isTermRoute</name>
<required>true</required>
<valueType>BOOLEAN</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>app-protocol</cliName>
<defaultValue></defaultValue>
<enumeratedValues>SIP</enumeratedValues>
<enumeratedValues>H323</enumeratedValues>
<key>true</key>
<name>appProtocol</name>
<required>false</required>
<valueType>ENUMERATED_VALUE</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>days-of-week</cliName>
<defaultValue>U-S</defaultValue>
<key>true</key>
<name>dow</name>
<required>true</required>
<valueType>STRING</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>realm</cliName>
<defaultValue></defaultValue>
<key>true</key>
<name>destRealm</name>
<referredElementType>realmConfig</referredElementType>
<referredValue>rcheck1</referredValue>
<referredValue>rcheck2</referredValue>
<referredValue>realmconfig5</referredValue>
<required>false</required>
<valueType>REFERENCE_TO_ANOTHER_ELEMENT</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>carrier</cliName>
<defaultValue></defaultValue>
<key>true</key>
<name>carrierName</name>
<required>false</required>
<valueType>STRING</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>action</cliName>
<defaultValue>none</defaultValue>
<enumeratedValues>redirect</enumeratedValues>
<enumeratedValues>replace-uri</enumeratedValues>
<enumeratedValues>none</enumeratedValues>
<key>true</key>
<name>action</name>
<required>true</required>
<valueType>ENUMERATED_VALUE</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>start-time</cliName>
<defaultValue>0000</defaultValue>
<key>true</key>
<name>startTime</name>
<required>true</required>
<valueType>STRING</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>eloc-str-lkup</cliName>
<defaultValue>disabled</defaultValue>
<key>false</key>
<name>eLocStrLkup</name>
<required>false</required>
<valueType>BOOLEAN</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>end-time</cliName>
<defaultValue>2400</defaultValue>
<key>true</key>
<name>endTime</name>
<required>true</required>
<valueType>STRING</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>state</cliName>
<defaultValue>enabled</defaultValue>
<key>false</key>
<name>state</name>
<required>false</required>
<valueType>BOOLEAN</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>next-key</cliName>
<defaultValue></defaultValue>
<key>false</key>
<name>nextKey</name>
<required>false</required>
<valueType>STRING</valueType>
</attributeMetadatas>
<attributeMetadatas>
<cliName>eloc-str-match</cliName>
<defaultValue></defaultValue>
<key>false</key>
<name>eLocStrMatch</name>
<required>false</required>
<valueType>STRING</valueType>
</attributeMetadatas>
<elementTypePath>localPolicy/policyAttribute</elementTypePath>
<readOnly>false</readOnly>
<singleInstance>false</singleInstance>
<subElements>
<elementTypePath>localPolicy/policyAttribute/mediaProfiles</elementTypePath>
<required>false</required>
</subElements>
<type>policyAttribute</type>
</elementMetadata>The following example shows the contents of the response body in JSON.
{
"attributeMetadatas": [{
"cliName": "last-modified-date",
"defaultValue": "",
"key": false,
"name": "lastModifiedDate",
"required": false,
"valueType": "STRING"
},{
"defaultValue": "",
"key": false,
"name": "dataVersion",
"required": false,
"valueType": "STRING"
},{
"cliName": "policy-priority",
"defaultValue": "",
"enumeratedValues": [
"",
"normal",
"non-urgent",
"emergency",
"none",
"urgent"
],
"key": false,
"name": "anonymousPriority",
"required": false,
"valueType": "ENUMERATED_VALUE"
},{
"cliName": "last-modified-by",
"defaultValue": "",
"key": false,
"name": "lastModifiedBy",
"required": false,
"valueType": "STRING"
},{
"cliName": "activate-time",
"defaultValue": "",
"key": false,
"name": "activateTime",
"regExpPattern": [
"(\\d){4,4}\\-(\\d){2,2}\\-(\\d){2,2}(\\-|\\s)(\\d){2,2}:(\\d){2,2}:(\\d){2,2}|"
],
"required": false,
"valueType": "REGEXP"
},{
"cliName": "description",
"defaultValue": "",
"key": false,
"name": "description",
"required": false,
"valueType": "STRING"
},{
"cliName": "state",
"defaultValue": "enabled",
"enumeratedValues": [
"disabled",
"enabled"
],
"key": false,
"name": "state",
"required": false,
"valueType": "BOOLEAN"
},{
"cliName": "deactivate-time",
"defaultValue": "",
"key": false,
"name": "deactivateTime",
"regExpPattern": [
"(\\d){4,4}\\-(\\d){2,2}\\-(\\d){2,2}(\\-|\\s)(\\d){2,2}:(\\d){2,2}:(\\d){2,2}|"
],
"required": false,
"valueType": "REGEXP"
}],
"elementTypePath": "localPolicy",
"readOnly": false,
"singleInstance": false,
"subElements": [{
"elementTypePath": "localPolicy/sourceRealm",
"required": true
},{
"elementTypePath": "localPolicy/policyAttribute",
"required": false
},{
"elementTypePath": "localPolicy/from",
"required": true
},{
"elementTypePath": "localPolicy/to",
"required": true
}],
"type": "localPolicy"
}