List Elements

GET https://{{axpAPIDomain}}/api/admin/inventory/v1/accounts/:accountId/elements?pageNumber=2&pageSize=5

This API requires the Account Administrator role.

Lists all of the elements for an account.

Request Params

The possible fields that can be filtered on are:

• name
• hostname
• elementType
• elementSubType

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
• hostname
• elementType
• elementSubType

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

RESPONSES

status: OK

{"pagination":{"pageNumber":2,"pageSize":10,"total":45},"elements":[{"elementId":"ce8042a2-12f8-406f-5fd3-86c1c16d3a53","description":"Avaya Cloud Office Description","elementType":"ACO","elementData":{"description":"Avaya Cloud Office Description","name":"Avaya Cloud Office","environment":"Production","didNumbers":["+16062128688","+12702289911"]},"status":"SUCCESS"},{"elementId":"883542c6-94bc-4d23-ace8-915bc91dfbb8","description":"Chat Connector Description","elementType":"DigitalProvider","elementSubType":"ChatConnector","elementData":{"name":"ChatProvider","hostname":"chat.lab","callbackurl":"chat.connector.provider"},"status":"SUCCESS"}],"links":{"prev":"/api/admin/inventory/api/admin/inventory/v1/elements?pageNumber=1\u0026pageSize=10","next":"/api/admin/inventory/api/admin/inventory/v1/elements?pageNumber=3\u0026pageSize=10"}}