1. REST API for Session Border Controller Release 8.2
  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 and/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
Query Parameters
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 /auth/token request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The metadata for the requested configuration element type is returned in the data section of the response.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Show Source
Nested Schema : messages
Type: object
Nested Schema : attributeMetadata
Type: array
Show Source
Nested Schema : attributeMetadata
Type: object

400 Response

The request is malformed or missing required information.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source

401 Response

The client is not authorized.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source

404 Response

Unsupported versionId in URI, or requested element type not supported
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source
Back to Top

Examples

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.0/configuration/elementTypes/metadata?elementType=password-policy'

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Wed, 08 Aug 2018 12:34:43 GMT
Cache-Control: no-cache
Content-Length: 668
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Wed, 08 Aug 2018 12:34:43 GMT
X-Appweb-Seq: 150

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>password-policy</elementType>
    <singleInstance>true</singleInstance>
    <attributeMetadata>
      <name>min-secure-pwd-len</name>
      <help>minimum length for secure passwords</help>
      <descriptions>minimum password length in secure-password-mode</descriptions>
      <required>false</required>
      <key>false</key>
      <defaultValue>8</defaultValue>
      <valueType>ushort</valueType>
      <validNumericRanges>
        <validNumericRange>
          <min>8</min>
          <max>64</max>
        </validNumericRange>
      </validNumericRanges>
    </attributeMetadata>
  </data>
  <messages/>
  <links/>
</response>
Back to Top