Gets a list of all AADS

GET https://{{axpAPIDomain}}/api/admin/voice/v1/accounts/:accountId/avaya-aura-device-services?filter=name=AADS123&orderBy=name

This API requires the Account Administrator role.

Returns the list of all available Avaya Aura Device Service Elements by account Id

Request Params

KeyDatatypeRequiredDescription
filterstringSpecifies details of a row filter.

The possible fields that can be filtered on are:

  • name

The allowed format:

  • Begins with the column name to be filtered, followed by a colon, then:
    • Either an exact string to match, or
    • A string expression including the * wildcard character
      • :{PREFIX}* will be used to find out word start with.
      • :*{POSTFIX} will be used to find out word end with
      • : will be used to match exact word
  • Begin with column name to be filtered, followed by a = operator. (this will be used to match exact string) | | orderBy | string | | Field name on which ordering needs to be performed. The default order is ascending.

The possible fields that can be ordered on are:

  • name

Field Names are case-senstive (should be written as it is in description).

To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc" for descending". |

HEADERS

KeyDatatypeRequiredDescription
appkeystring
Acceptstring

RESPONSES

status: OK

{"resources":[{"id":"04703a3a-3dfb-4606-ae79-fd0fe0be3e64","name":"AADS","description":"AADS server for testing","hostname":"dev-11.avaya.com","port":443,"openIDConnectDiscovery":"https://dev-11.ixcc-sandbox.avayacloud.com/auth/realms/YOPXPM/.well-known/openid-configuration","status":"SUCCESS"}]}