1. REST API for Session Delivery Manager Release 8.2.5p1
  2. Tasks
  3. device configuration

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.
Back to Top

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"

The following shows an example of the contents of the request.json file sent as the request body. 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<elementTypeRequest>
  <elementTypePath>surrogateAgent</elementTypePath>
</elementTypeRequest>

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
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 Response Body

The following example shows the contents of the response body in XML format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<elementMetadata>
    <attributeMetadatas>
        <attributeMetadata>
            <cliName>route-to-registrar</cliName>
            <defaultValue>enabled</defaultValue>
            <key>false</key>
            <name>routeToRegistrar</name>
            <required>false</required>
            <valueType>BOOLEAN</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>customer-host</cliName>
            <defaultValue></defaultValue>
            <key>false</key>
            <name>customerHost</name>
            <required>false</required>
            <valueType>STRING</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>register-contact-host</cliName>
            <defaultValue></defaultValue>
            <key>false</key>
            <name>contactHost</name>
            <required>true</required>
            <valueType>STRING</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>register-expires</cliName>
            <defaultValue>600000</defaultValue>
            <key>false</key>
            <name>expires</name>
            <required>false</required>
            <validNumericRanges>0-999999999</validNumericRanges>
            <valueType>NUMERIC</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>realm-id</cliName>
            <defaultValue></defaultValue>
            <key>false</key>
            <name>realmID</name>
            <referredElementType>realmConfig</referredElementType>
            <referredValue>realm2</referredValue>
            <referredValue>realm1</referredValue>
            <referredValue>realmconfig5</referredValue>
            <referredValue>realmconfig2</referredValue>
            <referredValue>realmconfig3</referredValue>
            <referredValue>realmconfig4</referredValue>
            <required>true</required>
            <valueType>REFERENCE_TO_ANOTHER_ELEMENT</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>max-register-attempts</cliName>
            <defaultValue>3</defaultValue>
            <key>false</key>
            <name>maxRegisterAttempts</name>
            <required>false</required>
            <validNumericRanges>0-10</validNumericRanges>
            <valueType>NUMERIC</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>description</cliName>
            <defaultValue></defaultValue>
            <key>false</key>
            <name>description</name>
            <required>false</required>
            <valueType>STRING</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>customer-next-hop</cliName>
            <defaultValue></defaultValue>
            <key>false</key>
            <name>customerRoute</name>
            <required>true</required>
            <valueType>STRING</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>auth-user</cliName>
            <defaultValue></defaultValue>
            <key>false</key>
            <name>authUser</name>
            <required>false</required>
            <valueType>STRING</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>register-mode</cliName>
            <defaultValue>automatic</defaultValue>
            <enumeratedValues>triggered</enumeratedValues>
            <enumeratedValues>automatic</enumeratedValues>
            <key>false</key>
            <name>registerMode</name>
            <required>false</required>
            <valueType>ENUMERATED_VALUE</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>options</cliName>
            <defaultValue></defaultValue>
            <delimiter>,</delimiter>
            <key>false</key>
            <name>options</name>
            <required>false</required>
            <valueType>DELIMITED_STRING</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>register-host</cliName>
            <defaultValue></defaultValue>
            <key>true</key>
            <name>registerHost</name>
            <required>true</required>
            <valueType>STRING</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>state</cliName>
            <defaultValue>enabled</defaultValue>
            <key>false</key>
            <name>state</name>
            <required>false</required>
            <valueType>BOOLEAN</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>register-retry-time</cliName>
            <defaultValue>300</defaultValue>
            <key>false</key>
            <name>registerRetryTime</name>
            <required>false</required>
            <validNumericRanges>30-3600</validNumericRanges>
            <valueType>NUMERIC</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>triggered-inactivity-interval</cliName>
            <defaultValue>30</defaultValue>
            <key>false</key>
            <name>triggeredInactivityInterval</name>
            <required>false</required>
            <validNumericRanges>5-300</validNumericRanges>
            <valueType>NUMERIC</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>triggered-oos-response</cliName>
            <defaultValue>503</defaultValue>
            <enumeratedValues>503</enumeratedValues>
            <enumeratedValues>dropresponse</enumeratedValues>
            <key>false</key>
            <name>triggeredOosResponse</name>
            <required>false</required>
            <valueType>ENUMERATED_VALUE</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>last-modified-date</cliName>
            <defaultValue></defaultValue>
            <key>false</key>
            <name>lastModifiedDate</name>
            <required>false</required>
            <valueType>STRING</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>data-version</cliName>
            <defaultValue></defaultValue>
            <key>false</key>
            <name>dataVersion</name>
            <required>false</required>
            <valueType>STRING</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>last-modified-by</cliName>
            <defaultValue></defaultValue>
            <key>false</key>
            <name>lastModifiedBy</name>
            <required>false</required>
            <valueType>STRING</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>aor-count</cliName>
            <defaultValue>1</defaultValue>
            <key>false</key>
            <name>count</name>
            <required>false</required>
            <validNumericRanges>0-999999999</validNumericRanges>
            <valueType>NUMERIC</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>count-start</cliName>
            <defaultValue>1</defaultValue>
            <key>false</key>
            <name>countStart</name>
            <required>false</required>
            <validNumericRanges>0-999999999</validNumericRanges>
            <valueType>NUMERIC</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>replace-contact</cliName>
            <defaultValue>disabled</defaultValue>
            <key>false</key>
            <name>replaceContact</name>
            <required>false</required>
            <valueType>BOOLEAN</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>register-user</cliName>
            <defaultValue></defaultValue>
            <key>true</key>
            <name>registerUser</name>
            <required>true</required>
            <valueType>STRING</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>password</cliName>
            <defaultValue></defaultValue>
            <key>false</key>
            <name>ENCR-PBE-password</name>
            <required>false</required>
            <valueType>STRING</valueType>
        </attributeMetadata>
        <attributeMetadata>
            <cliName>register-contact-user</cliName>
            <defaultValue></defaultValue>
            <key>false</key>
            <name>contactUser</name>
            <required>true</required>
            <valueType>STRING</valueType>
        </attributeMetadata>
    </attributeMetadatas>
    <elementTypePath>surrogateAgent</elementTypePath>
    <readOnly>false</readOnly>
    <singleInstance>false</singleInstance>
    <subElements/>
    <type>surrogateAgent</type>
</elementMetadata>
Back to Top