Search Audit Records
POST https://{{axpAPIDomain}}/api/admin/inventory/v1/accounts/:accountId/audit-records:search?pageNumber=2&pageSize=5&orderBy=date desc
This API requires the Account Administrator role.
Searches the audit records based on the supplied filter.
The value of searchKeyword can be used to perform a text search across all fields within an audit record (excluding date).
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
pageNumber | number | The page number of the records to retrieve. Default value is 1. | |
pageSize | number | The max number of records to retrieve per page. Default value is 5, max value is 50. | |
orderBy | string | Field name on which sorting needs to be performed. The possible fields | |
| you ordered on are date (date of audit record) and author. | |||
| Field Names are case-senstive (should be written as it is in description). The default sorting order is descending. To specify ascending order, a suffix " asc" should be added. For example, "date asc" for ascending or "date desc" for descending". | |||
Request Body
{"startDate"=>"2021-11-13T20:25:39.534Z", "endDate"=>"2021-11-15T16:07:12.723Z", "event"=>"CREATED", "author"=>"jsmith@example.com", "type"=>"ELEMENT", "ipAddress"=>"165.225.72.60", "searchKeyword"=>"Out-of-Office"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
appkey | string | ||
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"pagination":{"pageNumber":1,"pageSize":5,"total":1},"auditRecords":[{"date":"2021-11-14T09:24:05.234Z","event":"CREATED","author":"jsmith@example.com","ipAddress":"165.225.72.60","type":"ELEMENT","auditData":{"name":"Avaya Cloud Office","didNumbers":["+16062128688","+12702289911"],"elementType":"ACO","environment":"Production","description":"An Avaya Cloud Office Element","sipServerHostName":"sip://platform.ringcentral.com/restapi/v1"}}],"links":{"next":"/api/admin/inventory/api/admin/inventory/v1/accounts/ASDJGE/audit-records:search?pageNumber=2\u0026pageSize=5","prev":"/api/admin/inventory/api/admin/inventory/v1/accounts/ASDJGE/audit-records:search?pageNumber=1\u0026pageSize=5"}}