1. REST API for Enterprise Communications Broker Release 3.3.0
  2. Tasks
  3. configuration

Get the metadata for a configuration element type

get

/rest/{version}/configuration/elementTypes/metadata

Retrieves the metadata (schema) for the specified configuration element type. The metadata enables the client to know the characteristics of each attribute/sub-element that comprises the element type, so the client can self-validate its instance data before submitting a POST or PUT request. Note that the values for certain metadata tags may vary based on the platform or entitlements of the target system, as certain attribute ranges depend on the platform. The metadata returned for a given element type by one system may not be identical to the metadata returned by a different system.

Request

Path Parameters
  • REST API version string.
    Available values: v1.1
Query Parameters
  • Specifies the configuration element type whose metadata is being requested.
Header Parameters
  • The value in the Authorization header must be the string "Bearer {access token}", where {access token} is a valid, unexpired token received in response to a prior /rest/{version}/auth/token request.
Back to Top

Response

200 Response

The metadata for the requested configuration element type is returned in the data section of the response.

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.

401 Response

Unauthorized - Request lacks valid authentication credentials.

404 Response

Unsupported versionId in URI, or requested element type not supported.
Back to Top

Examples

Example of Accessing the API with cURL

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

curl -X GET \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://10.0.0.2/rest/v1.1/configuration/elementTypes/metadata?elementType=user-number"

Example of Accessing the API with Python

The following example shows how to get the metadata for a configuration element type by submitting a GET request on the REST resource using Python. This example assumes you have a valid token stored in the token variable. For an example of authenticating with Python, see Authenticate. 

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://10.0.0.2/rest/v1.1/configuration/elementTypes/metadata?elementType=user-number"
resp = requests.get(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Wed, 30 Oct 2019 08:59:02 GMT
Cache-Control: no-cache
Content-Length: 2610
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Wed, 30 Oct 2019 08:59:02 GMT
X-Appweb-Seq: 13

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"?>
<response>
  <data>
    <elementType>user-number</elementType>
    <singleInstance>false</singleInstance>
    <attributeMetadata>
      <name>AoR</name>
      <help>AOR associated with this user.</help>
      <descriptions>AOR for this user</descriptions>
      <required>false</required>
      <key>false</key>
      <valueType>string</valueType>
    </attributeMetadata>
    <attributeMetadata>
      <name>number-or-pattern</name>
      <help>Universal number or pattern associated with this user.</help>
      <descriptions>
        <description>Universal number for this user</description>
        <description>Telephony digits: 0-9 maximum 25 digits, allows ranges in brackets []</description>
        <description>and 'x' at the end of the string meaning 0-9.  Also, optional digits are in parens ()</description>
        <description>Example: 555[2000-3999]</description>
        <description>Example: 555xx(xxxx) means 555 with between 2 and 6 digits afterward</description>
      </descriptions>
      <required>true</required>
      <key>true</key>
      <valueType>string</valueType>
    </attributeMetadata>
    <attributeMetadata>
      <name>description</name>
      <help>user number description</help>
      <descriptions>user number description</descriptions>
      <required>false</required>
      <key>false</key>
      <valueType>string</valueType>
    </attributeMetadata>
    <attributeMetadata>
      <name>Dialing-context</name>
      <help>Name of the context that defines this user's preferred dialing rules.</help>
      <descriptions>Name of the context that defines this user's preferred dialing rules.</descriptions>
      <required>false</required>
      <key>false</key>
      <valueType>string</valueType>
    </attributeMetadata>
    <attributeMetadata>
      <name>agent</name>
      <help>Name of the agent to which this user is connected.</help>
      <descriptions>Name of the agent to which this user is connected.</descriptions>
      <required>false</required>
      <key>false</key>
      <valueType>string</valueType>
    </attributeMetadata>
    <attributeMetadata>
      <name>policy</name>
      <help>Policies that can alter processing of routes to this user</help>
      <descriptions/>
      <required>false</required>
      <key>false</key>
      <valueType>string</valueType>
    </attributeMetadata>
    <attributeMetadata>
      <name>tags</name>
      <help>Tags for organizing and associating user entries.</help>
      <descriptions>Tags for organizing and associating user entries.</descriptions>
      <required>false</required>
      <key>false</key>
      <valueType>string</valueType>
    </attributeMetadata>
  </data>
  <messages/>
  <links/>
</response>
Back to Top