Jump to

• Request
• Response
• Examples

Get a List of Top-level Configuration Element Types

get

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

Use this (GET) method to retrieve a list of top-level configuration element types that the targeted device release supports. A top-level element can contain several layers of sub-element children but has no parent configuration element. The top level element types can then be used to construct any configuration element that the targeted device release supports by invoking the Add an Element Type (POST) method.

Request

Path Parameters

• deviceId: string
• versionId: string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : elementTypes

Type: object

Show Source

• types(optional): array elementType

{
    "type":"object",
    "properties":{
        "types":{
            "type":"array",
            "xml":{
                "name":"elementType"
            },
            "items":{
                "$ref":"#/definitions/RestElementType"
            }
        }
    },
    "xml":{
        "name":"elementTypes"
    }
}

Nested Schema : elementType

Type: array

Show Source

• Array of: object elementType

{
    "type":"array",
    "xml":{
        "name":"elementType"
    },
    "items":{
        "$ref":"#/definitions/RestElementType"
    }
}

Nested Schema : elementType

Type: object

Show Source

• cliName(optional): string
• name(optional): string

{
    "type":"object",
    "properties":{
        "cliName":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "xml":{
        "name":"elementType"
    }
}

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

The following example shows how to display the configuration element types by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

Example of cURL Data

The following shows an example of cURL data sent with the request.

curl -v -b sessionid.txt -X GET -H"Content-Type: application/xml" -H"Accept: application/xml" http://localhost:8080/rest/v1.1/configuration/deviceConfigs/ID9/elementTypes

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Mon, 11 Sep 2017 19:11:25 GMT
Server: Apache
X-Frame-Options: SAMEORIGIN
Vary: Accept-Encoding
Transfer-Encoding: chunked
Content-Type: application/xml

Example of Response Body

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<elementTypes>
  <elementType>
    <cliName>session-router-&gt;sip-q850-map</cliName>
    <name>sipQ850Map</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;authentication</cliName>
    <name>authConfig</name>
  </elementType>
  <elementType>
    <cliName>media-manager-&gt;dns-config</cliName>
    <name>dnsConfig</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;sip-feature</cliName>
    <name>sipFeature</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;auth-params</cliName>
    <name>authParamsConfig</name>
  </elementType>
  <elementType>
    <cliName>system-&gt;snmp-community</cliName>
    <name>snmpCommunity</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;ipsec-&gt;security-policy</cliName>
    <name>spdConfig</name>
  </elementType>
  <elementType>
    <cliName>media-manager-&gt;realm-group</cliName>
    <name>realmGroup</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;password-policy</cliName>
    <name>passwordPolicy</name>
  </elementType>
  <elementType>
    <cliName>system-&gt;spl-config</cliName>
    <name>splConfig</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;cert-status-profile</cliName>
    <name>certStatusProfile</name>
  </elementType>
  <elementType>
    <cliName>media-manager-&gt;steering-pool</cliName>
    <name>steeringPool</name>
  </elementType>
  <elementType>
    <cliName>media-manager-&gt;media-policy</cliName>
    <name>mediaPolicy</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;h248-config</cliName>
    <name>h248Config</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;account-config</cliName>
    <name>acctConfig</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;allowed-elements-profile</cliName>
    <name>allowedElementsProfile</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;security-config</cliName>
    <name>securityConfig</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;tls-profile</cliName>
    <name>tlsProfile</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;rph-profile</cliName>
    <name>rphProfile</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;ims-aka-profile</cliName>
    <name>imsAkaProfile</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;session-group</cliName>
    <name>sessionAgentGroup</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;enum-config</cliName>
    <name>EnumConfig</name>
  </elementType>
  <elementType>
    <cliName>media-manager-&gt;static-flow</cliName>
    <name>staticFlow</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;h248-config-&gt;h248-mgc-config</cliName>
    <name>h248MgcConfig</name>
  </elementType>
  <elementType>
    <cliName>system-&gt;system-config</cliName>
    <name>systemConfig</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;sip-manipulation</cliName>
    <name>sipManipulation</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;home-subscriber-server</cliName>
    <name>extHssManager</name>
  </elementType>
  <elementType>
    <cliName>system-&gt;trap-receiver</cliName>
    <name>trapReceiver</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;sip-profile</cliName>
    <name>sipProfile</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;ike-&gt;tunnel-orig-params</cliName>
    <name>tunnelOrigParams</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;ipsec-&gt;security-association-&gt;manual</cliName>
    <name>saConfig</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;q850-sip-map</cliName>
    <name>q850SipMap</name>
  </elementType>
  <elementType>
    <cliName>media-manager-&gt;ext-policy-server</cliName>
    <name>extBwManager</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;translation-rules</cliName>
    <name>translationRules</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;ike-&gt;ike-interface</cliName>
    <name>ikeInterface</name>
  </elementType>
  <elementType>
    <cliName>media-manager-&gt;vbg-config</cliName>
    <name>VbgConfig</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;session-agent</cliName>
    <name>sessionAgent</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;sip-interface</cliName>
    <name>sipInterface</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;qos-constraints</cliName>
    <name>qosConstraints</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;iwf-config</cliName>
    <name>IwfStackConfig</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;session-translation</cliName>
    <name>sessionTranslation</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;local-routing-config</cliName>
    <name>LocalRoutingConfig</name>
  </elementType>
  <elementType>
    <cliName>system-&gt;network-parameters</cliName>
    <name>NetworkParameters</name>
  </elementType>
  <elementType>
    <cliName>media-manager-&gt;tcp-media-profile</cliName>
    <name>tcpMediaProfile</name>
  </elementType>
  <elementType>
    <cliName>system-&gt;snmp-user-entry</cliName>
    <name>snmpUserEntry</name>
  </elementType>
  <elementType>
    <cliName>media-manager-&gt;codec-policy</cliName>
    <name>codecPolicy</name>
  </elementType>
  <elementType>
    <cliName>system-&gt;timezone-config</cliName>
    <name>TimezoneConfig</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;h323</cliName>
    <name>H323Config</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;local-response-map</cliName>
    <name>sipLocalMap</name>
  </elementType>
  <elementType>
    <cliName>system-&gt;phy-interface</cliName>
    <name>phyInterfaceConfig</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;mgcp-config</cliName>
    <name>mgcpConfig</name>
  </elementType>
  <elementType>
    <cliName>system-&gt;network-interface</cliName>
    <name>networkInterface</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;surrogate-agent</cliName>
    <name>surrogateAgent</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;lawful-intercept</cliName>
    <name>LiConfig</name>
  </elementType>
  <elementType>
    <cliName>system-&gt;ipt-config</cliName>
    <name>iptConfig</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;session-router-config</cliName>
    <name>sessionRouter</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;media-security-&gt;media-sec-policy</cliName>
    <name>mediaSecPolicy</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;ike-&gt;ike-config</cliName>
    <name>ikeConfig</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;media-security-&gt;sdes-profile</cliName>
    <name>sdesProfile</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;enforcement-profile</cliName>
    <name>enforcementProfile</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;certificate-record</cliName>
    <name>certRecord</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;h323-&gt;h323-stacks</cliName>
    <name>H323StackConfig</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;ike-&gt;ike-sainfo</cliName>
    <name>ikeSaInfo</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;sip-config</cliName>
    <name>sipConfig</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;sip-nat</cliName>
    <name>sipNatConfig</name>
  </elementType>
  <elementType>
    <cliName>media-manager-&gt;dnsalg-constraints</cliName>
    <name>dnsAlgConstraints</name>
  </elementType>
  <elementType>
    <cliName>media-manager-&gt;bgf-config</cliName>
    <name>BgfConfig</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;class-profile</cliName>
    <name>classPolicy</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;media-security-&gt;sipura-profile</cliName>
    <name>sipuraProfile</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;tls-global</cliName>
    <name>tlsGlobal</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;public-key</cliName>
    <name>sshPubKeyRecord</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;rph-policy</cliName>
    <name>rphPolicy</name>
  </elementType>
  <elementType>
    <cliName>media-manager-&gt;realm-config</cliName>
    <name>realmConfig</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;ipsec-&gt;ipsec-global-config</cliName>
    <name>ipsecGlobalConfig</name>
  </elementType>
  <elementType>
    <cliName>system-&gt;capture-receiver</cliName>
    <name>captureReceiver</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;access-control</cliName>
    <name>accessControl</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;ike-&gt;data-flow</cliName>
    <name>dataFlow</name>
  </elementType>
  <elementType>
    <cliName>system-&gt;redundancy</cliName>
    <name>RedundancyConfig</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;media-profile</cliName>
    <name>mediaProfile</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;ike-&gt;dpd-params</cliName>
    <name>dpdParams</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;sip-response-map</cliName>
    <name>responseMap</name>
  </elementType>
  <elementType>
    <cliName>system-&gt;system-access-list</cliName>
    <name>sysACL</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;session-constraints</cliName>
    <name>sessionConstraints</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;h248-config-&gt;h248-mg-config</cliName>
    <name>h248MgConfig</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;media-security-&gt;mikey-profile</cliName>
    <name>mikeyProfile</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;net-management-control</cliName>
    <name>netMgmtCtrl</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;session-timer-profile</cliName>
    <name>sessionTimerProfile</name>
  </elementType>
  <elementType>
    <cliName>system-&gt;host-route</cliName>
    <name>ipRoute</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;sip-isup-profile</cliName>
    <name>sipIsupProfile</name>
  </elementType>
  <elementType>
    <cliName>media-manager-&gt;msrp-config</cliName>
    <name>msrpConfig</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;ike-&gt;ike-certificate-profile</cliName>
    <name>ikeCertificateProfile</name>
  </elementType>
  <elementType>
    <cliName>security-&gt;ike-&gt;local-address-pool</cliName>
    <name>localAddressPool</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;call-recording-server</cliName>
    <name>callRecordingServer</name>
  </elementType>
  <elementType>
    <cliName>session-router-&gt;local-policy</cliName>
    <name>localPolicy</name>
  </elementType>
  <elementType>
    <cliName>ntp-sync</cliName>
    <name>ntpConfig</name>
  </elementType>
  <elementType>
    <cliName>media-manager-&gt;media-manager</cliName>
    <name>mediaRouter</name>
  </elementType>
</elementTypes>

Back to Top