openapi: 3.2.0
info:
title: Avaya Audit Records API
contact:
name: Avaya API Team
url: https://developers.avayacloud.com/onecloud-ccaas
email: apiteam@avaya.com
license:
name: Avaya Software Development Kit (SDK) Software License Terms
url: http://support.avaya.com/css/P8/documents/101038288
version: '1.0'
description: 'Operations tagged Audit Records across 6 of this provider''s published API definitions: avaya-axp-admin-account-openapi-original.json, avaya-axp-admin-element-inventory-openapi-original.json, avaya-axp-admin-group-openapi-original.json, avaya-axp-admin-match-openapi-original.json, avaya-axp-admin-timetable-openapi-original.json, avaya-axp-admin-user-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: '{protocol}://{server}{basePath}'
description: Open API
variables:
protocol:
enum:
- https
default: https
server:
default: HOST-REGION.api.avayacloud.com
basePath:
default: /api/admin/account/v1
- url: '{protocol}://{server}:{port}'
description: Internal API
variables:
protocol:
enum:
- http
- https
default: http
server:
default: cc-admin-assisted
port:
enum:
- '80'
- '443'
default: '80'
- url: '{protocol}://{server}:{port}{basePath}'
description: Open API
variables:
protocol:
enum:
- https
default: https
server:
default: HOST-REGION.api.avayacloud.com
port:
enum:
- '443'
default: '443'
basePath:
default: /api/admin/user/v1
tags:
- name: Audit Records
description: Search or export audit records for auditable objects.
paths:
/accounts/{accountId}/audit-records:search:
post:
tags:
- Audit Records
summary: Search Audit Records
description: '**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).'
operationId: searchAuditRecords
parameters:
- $ref: '#/components/parameters/accountId'
- $ref: '#/components/parameters/pageNumber'
- name: pageSize
in: query
description: 'The max number of records to retrieve per page. Default value is 5, max value is 50.
'
required: false
schema:
type: integer
format: int32
example: 5
default: 5
minimum: 5
maximum: 50
- name: orderBy
in: query
description: '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-sensitive (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".
'
required: false
schema:
type: string
example: date desc
minLength: 4
maxLength: 255
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuditSearchFilter'
examples:
Search-Audit-Records:
$ref: '#/components/examples/SearchAuditRecordsRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AuditRecords'
examples:
Search-Audit-Records:
$ref: '#/components/examples/SearchAuditRecordsResponse'
'400':
$ref: '#/components/responses/ErrorConstraintViolation'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
security:
- {}
- BearerAuth: []
AppKey: []
servers:
- url: '{protocol}://{server}{basePath}'
description: Open API
variables:
protocol:
enum:
- https
default: https
server:
default: HOST-REGION.api.avayacloud.com
basePath:
default: /api/admin/account/v1
/accounts/{accountId}/audit-records:export:
post:
tags:
- Audit Records
summary: Export Audit Records
description: '**This API requires the Account Administrator role.**
Exports the audit records within the date-time range in CSV format.
A maximum of 1000 records can be exported for a given date-time range per request.
If the number of records within a date-time range exceeds the maximum then this API will
return a _HTTP 400 Bad Request_. This response will contain:
* A human readable message explaining the issue.
* A unique error code that a client can use to identify the issue.'
operationId: exportAuditRecords
parameters:
- $ref: '#/components/parameters/accountId'
- name: orderBy
in: query
description: '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-sensitive (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".
'
required: false
schema:
type: string
example: date desc
minLength: 4
maxLength: 255
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuditSearchFilter'
examples:
Export-Audit-Records:
$ref: '#/components/examples/SearchAuditRecordsRequest'
responses:
'200':
description: OK
content:
text/csv:
schema:
type: string
format: binary
example: 'Account Id,Date,Event,Author,IP Address,Type,Audit Data
ABCDEF,2021-11-14T09:24:05.234Z,CREATED,jsmith@example.com,165.225.72.60,ACCOUNT,"{""name"":""AricentAccount"",""type"":""ACCOUNT"",""enabled"":""true"",""accountSize"":""10""}"
'
'400':
description: BadRequest
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
Too-many-records:
$ref: '#/components/examples/ErrorTooManyRecords'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
security:
- {}
- BearerAuth: []
AppKey: []
servers:
- url: '{protocol}://{server}{basePath}'
description: Open API
variables:
protocol:
enum:
- https
default: https
server:
default: HOST-REGION.api.avayacloud.com
basePath:
default: /api/admin/account/v1
components:
schemas:
AuditSearchFilter:
type: object
description: 'The filter to be applied when searching for audit records.
'
properties:
startDate:
type: string
format: date-time
description: 'The starting datetime to use when searching for audit records (in ISO 8601 format including timezone, ''yyyy-MM-dd''T''HH:mm:ss[.SSS]Z'').
'
example: '2021-11-13T20:25:39.534Z'
endDate:
type: string
format: date-time
description: 'The ending datetime to use when searching for audit records (in ISO 8601 format including timezone, ''yyyy-MM-dd''T''HH:mm:ss[.SSS]Z'').
'
example: '2021-11-15T16:07:12.723Z'
author:
type: string
description: 'The ID of the author who changed the auditable object. This can be a user within the system or an automated app.
'
maxLength: 255
pattern: ^[a-zA-Z0-9@._-]+$
example: jsmith@example.com
event:
type: string
description: "This field indicates the type of event that occurred on the auditable object.\n\nAn explanation of the values is listed below:\n * CREATED - A new auditable object was created.\n * UPDATED - An existing auditable object was updated.\n * DELETED - An existing auditable object was deleted.\n"
enum:
- CREATED
- UPDATED
- DELETED
type:
description: 'The type of auditable object.
Accepted values:
* ACCOUNT
'
type: string
enum:
- ACCOUNT
example: ACCOUNT
ipAddress:
description: 'The originating IP Address of the author who changed the auditable object.
'
type: string
maxLength: 15
example: 165.225.72.60
searchKeyword:
description: 'Keyword to search for across all the audit records.
'
type: string
maxLength: 255
required:
- startDate
- endDate
- type
AuditRecord:
type: object
description: 'An audit record. Captures who, what, and when an auditable object changed within the system.
'
properties:
date:
type: string
description: 'The date and time of when the audit record was created.
'
example: '2021-06-24T19:03:01.463+00:00'
event:
type: string
description: "This field indicates the type of event that occurred on the auditable object.\n\nAn explanation of the values is listed below:\n * CREATED - A new auditable object was created.\n * UPDATED - An existing auditable object was updated.\n * DELETED - An existing auditable object was deleted.\n * ENABLED - An existing auditabled object was enabled.\n * DISABLED - An existing auditabled object was disabled.\n"
enum:
- CREATED
- UPDATED
- DELETED
- ENABLED
- DISABLED
author:
type: string
example: jsmith@example.com
description: 'The ID of the author who changed the auditable object. This can be a user within the system or an automated app.
'
type:
description: 'The type of auditable object.
Accepted values:
* ACCOUNT
'
type: string
enum:
- ACCOUNT
ipAddress:
description: 'The originating IP Address of the author who changed the auditable object.
'
type: string
example: 165.225.72.60
auditData:
$ref: '#/components/schemas/JsonNode'
Problem:
type: object
description: 'Problem Detail as a way to carry machine-readable details of errors in a HTTP response to avoid the need to define new error response formats for HTTP APIs RFC 7807
'
properties:
type:
type: string
format: uri
description: 'An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type (e.g., using HTML).
'
default: about:blank
example: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
title:
type:
- string
- 'null'
description: 'A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized).
'
example: Service Unavailable
status:
type:
- integer
- 'null'
format: int32
description: 'The HTTP status code generated by the origin server for this occurrence of the problem.
'
minimum: 100
example: 503
exclusiveMaximum: 600
detail:
type:
- string
- 'null'
description: 'A human readable explanation specific to this occurrence of the problem.
'
example: Connection to database timed out
instance:
type:
- string
- 'null'
format: uri
description: 'An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
'
violations:
type:
- array
- 'null'
description: 'A list of violations that occurred as a result of invalid data provided as part of a request.
'
items:
type: object
properties:
field:
type: string
description: 'The name of the field in the request that caused the violation. This can be the name of a path parameter, query parameter, or a field within the request body.
'
example: accountId
message:
type: string
description: 'A human readable explanation specific to this occurrence of the violation.
'
example: must match "^[a-zA-Z]{6}$"
code:
type: integer
format: int32
description: 'The violation code generated by the server for this occurrence of the violation. Use this code when implementing any error handling logic instead of the message, as the message can change.
'
example: 20006
example:
- field: emailAddress
message: must not be null
code: 20002
- field: accountId
message: must match "^[a-zA-Z]{6}$"
code: 20006
JsonNode:
type: object
title: JsonNode
description: 'Contains the state of the auditable object at the time the audit record was created.
'
Pagination:
type: object
properties:
pageNumber:
type: integer
description: The current page number.
pageSize:
type: integer
description: The max number of records that can be retrieved on this page.
total:
type: integer
description: The total number of records.
Links:
type: object
properties:
prev:
type: string
default: ''
description: URL of the previous page. Blank if currently on the first page.
next:
type: string
default: ''
description: URL of the next page. Blank if currently on the last page.
AuditRecords:
description: 'A collection of audit records.
'
type: object
properties:
pagination:
$ref: '#/components/schemas/Pagination'
auditRecords:
type: array
items:
$ref: '#/components/schemas/AuditRecord'
links:
allOf:
- $ref: '#/components/schemas/Links'
example:
prev: /api/admin/account/v1/accounts/ASDJGE/audit-records:search?pageNumber=1&pageSize=10
next: /api/admin/account/v1/accounts/ASDJGE/audit-records:search?pageNumber=2&pageSize=10
AuditSearchFilter_2:
type: object
description: 'The filter to be applied when searching for audit records.
'
properties:
startDate:
type: string
format: date-time
description: 'The starting datetime to use when searching for audit records (in ISO 8601 format including timezone, ''yyyy-MM-dd''T''HH:mm:ss[.SSS]Z'').
'
example: '2021-11-13T20:25:39.534Z'
endDate:
type: string
format: date-time
description: 'The ending datetime to use when searching for audit records (in ISO 8601 format including timezone, ''yyyy-MM-dd''T''HH:mm:ss[.SSS]Z'').
'
example: '2021-11-15T16:07:12.723Z'
author:
type: string
description: 'The ID of the author who changed the auditable object. This can be a user within the system or an automated app.
'
maxLength: 255
pattern: ^[a-zA-Z0-9@._-]+$
example: jsmith@example.com
event:
type: string
description: "This field indicates the type of event that occurred on the auditable object.\n\nAn explanation of the values is listed below:\n * CREATED - A new auditable object was created.\n * UPDATED - An existing auditable object was updated.\n * DELETED - An existing auditable object was deleted.\n"
enum:
- CREATED
- UPDATED
- DELETED
type:
description: "The type of auditable object.\n\nAccepted values:\n * ELEMENT\n"
type: string
enum:
- ELEMENT
example: ELEMENT
ipAddress:
description: 'The originating IP Address of the author who changed the auditable object.
'
type: string
maxLength: 15
example: 165.225.72.60
searchKeyword:
description: 'Keyword to search for across all the audit records.
'
type: string
maxLength: 255
required:
- startDate
- endDate
- type
AuditRecord_2:
type: object
description: 'An audit record.
'
properties:
date:
type: string
description: 'The date and time of when the audit record was created.
'
example: '2021-06-24T19:03:01.463+00:00'
event:
type: string
description: "This field indicates the type of event that occurred on the auditable object.\n\nAn explanation of the values is listed below:\n * CREATED - A new auditable object was created.\n * UPDATED - An existing auditable object was updated.\n * DELETED - An existing auditable object was deleted.\n"
enum:
- CREATED
- UPDATED
- DELETED
author:
type: string
example: jsmith@example.com
description: 'The ID of the author who changed the auditable object. This can be a user within the system or an automated app.
'
type:
description: 'The type of auditable object.
Accepted values:
* ELEMENT
'
type: string
enum:
- ELEMENT
example: ELEMENT
ipAddress:
description: 'The originating IP Address of the author who changed the auditable object.
'
type: string
example: 165.225.72.60
auditData:
$ref: '#/components/schemas/JsonNode'
AuditRecords_2:
description: 'A collection of audit records.
'
type: object
properties:
pagination:
$ref: '#/components/schemas/Pagination'
auditRecords:
type: array
items:
$ref: '#/components/schemas/AuditRecord_2'
links:
allOf:
- $ref: '#/components/schemas/Links'
example:
prev: /api/admin/inventory/v1/accounts/ASDJGE/audit-records:search?pageNumber=1&pageSize=10
next: /api/admin/inventory/v1/accounts/ASDJGE/audit-records:search?pageNumber=2&pageSize=10
AuditSearchFilter_3:
type: object
description: 'The filter to be applied when searching for audit records.
'
properties:
startDate:
type: string
format: date-time
description: 'The starting datetime to use when searching for audit records (in ISO 8601 format including timezone, ''yyyy-MM-dd''T''HH:mm:ss[.SSS]Z'').
'
example: '2021-11-13T20:25:39.534Z'
endDate:
type: string
format: date-time
description: 'The ending datetime to use when searching for audit records (in ISO 8601 format including timezone, ''yyyy-MM-dd''T''HH:mm:ss[.SSS]Z'').
'
example: '2021-11-15T16:07:12.723Z'
author:
type: string
description: 'The ID of the author who changed the auditable object. This can be a user within the system or an automated app.
'
maxLength: 255
pattern: ^[a-zA-Z0-9@._-]+$
example: jsmith@example.com
event:
type: string
description: "This field indicates the type of event that occurred on the auditable object.\n\nAn explanation of the values is listed below:\n * CREATED - A new auditable object was created.\n * UPDATED - An existing auditable object was updated.\n * DELETED - An existing auditable object was deleted.\n"
enum:
- CREATED
- UPDATED
- DELETED
type:
description: "The type of auditable object.\n\nAccepted values:\n * GROUP\n"
type: string
enum:
- GROUP
example: GROUP
ipAddress:
description: 'The originating IP Address of the author who changed the auditable object.
'
type: string
maxLength: 15
example: 165.225.72.60
searchKeyword:
description: 'Keyword to search for across all the audit records.
'
type: string
maxLength: 255
required:
- startDate
- endDate
- type
AuditRecord_3:
type: object
description: 'An audit record.
'
properties:
date:
type: string
description: 'The date and time of when the audit record was created.
'
example: '2021-06-24T19:03:01.463+00:00'
event:
type: string
description: "This field indicates the type of event that occurred on the auditable object.\n\nAn explanation of the values is listed below:\n * CREATED - A new auditable object was created.\n * UPDATED - An existing auditable object was updated.\n * DELETED - An existing auditable object was deleted.\n"
enum:
- CREATED
- UPDATED
- DELETED
author:
type: string
example: jsmith@example.com
description: 'The ID of the author who changed the auditable object. This can be a user within the system or an automated app.
'
type:
description: 'The type of auditable object.
Accepted values:
* GROUP
'
enum:
- GROUP
type: string
example: GROUP
ipAddress:
description: 'The originating IP Address of the author who changed the auditable object.
'
type: string
example: 165.225.72.60
auditData:
$ref: '#/components/schemas/JsonNode'
AuditRecords_3:
description: 'A collection of audit records.
'
type: object
properties:
pagination:
$ref: '#/components/schemas/Pagination'
auditRecords:
type: array
items:
$ref: '#/components/schemas/AuditRecord_3'
links:
allOf:
- $ref: '#/components/schemas/Links'
example:
prev: /api/admin/group/v1/accounts/ASDJGE/audit-records:search?pageNumber=1&pageSize=10
next: /api/admin/group/v1/accounts/ASDJGE/audit-records:search?pageNumber=2&pageSize=10
AuditSearchFilter_4:
type: object
description: 'The filter to be applied when searching for audit records.
'
properties:
startDate:
type: string
format: date-time
description: 'The starting datetime to use when searching for audit records (in ISO 8601 format including timezone, ''yyyy-MM-dd''T''HH:mm:ss[.SSS]Z'').
'
example: '2021-11-13T20:25:39.534Z'
endDate:
type: string
format: date-time
description: 'The ending datetime to use when searching for audit records (in ISO 8601 format including timezone, ''yyyy-MM-dd''T''HH:mm:ss[.SSS]Z'').
'
example: '2021-11-15T16:07:12.723Z'
author:
type: string
description: 'The ID of the author who changed the auditable object. This can be a user within the system or an automated app.
'
maxLength: 255
pattern: ^[a-zA-Z0-9@._-]+$
example: jsmith@example.com
event:
type: string
description: "This field indicates the type of event that occurred on the auditable object.\n\nAn explanation of the values is listed below:\n * CREATED - A new auditable object was created.\n * UPDATED - An existing auditable object was updated.\n * DELETED - An existing auditable object was deleted.\n"
enum:
- CREATED
- UPDATED
- DELETED
type:
description: 'The type of auditable object.
'
type: string
enum:
- QUEUE
- ATTRIBUTE
example: QUEUE
ipAddress:
description: 'The originating IP Address of the author who changed the auditable object.
'
type: string
maxLength: 15
example: 165.225.72.60
searchKeyword:
description: 'Keyword to search for across all the audit records.
'
type: string
maxLength: 255
required:
- startDate
- endDate
- type
AuditRecord_4:
type: object
description: 'An audit record. Captures who, what, and when an auditable object changed within the system.
'
properties:
date:
type: string
description: 'The date and time of when the audit record was created.
'
example: '2021-06-24T19:03:01.463+00:00'
event:
type: string
description: "This field indicates the type of event that occurred on the auditable object.\n\nAn explanation of the values is listed below:\n * CREATED - A new auditable object was created.\n * UPDATED - An existing auditable object was updated.\n * DELETED - An existing auditable object was deleted.\n"
enum:
- CREATED
- UPDATED
- DELETED
author:
type: string
example: jsmith@example.com
description: 'The ID of the author who changed the auditable object. This can be a user within the system or an automated app.
'
type:
description: 'The type of auditable object.
'
type: string
enum:
- QUEUE
- ATTRIBUTE
example: QUEUE
ipAddress:
description: 'The originating IP Address of the author who changed the auditable object.
'
type: string
example: 165.225.72.60
auditData:
$ref: '#/components/schemas/JsonNode'
Links_2:
type: object
properties:
prev:
type: string
description: URL of the previous page. Blank if currently on the first page.
next:
type: string
description: URL of the next page. Blank if currently on the last page.
AuditRecords_4:
description: 'A collection of audit records.
'
type: object
properties:
pagination:
$ref: '#/components/schemas/Pagination'
auditRecords:
type: array
items:
$ref: '#/components/schemas/AuditRecord_4'
links:
allOf:
- $ref: '#/components/schemas/Links_2'
example:
prev: /api/admin/match/v1/accounts/ABCDEF/audit-records:search?pageNumber=1&pageSize=10
next: /api/admin/match/v1/accounts/ABCDEF/audit-records:search?pageNumber=2&pageSize=10
AuditSearchFilter_5:
type: object
description: The filter to be applied when searching for audit records.
properties:
startDate:
type: string
format: date-time
description: The starting datetime to use when searching for audit records (in ISO 8601 format including timezone, 'yyyy-MM-dd'T'HH:mm:ss[.SSS]Z').
example: '2021-11-13T20:25:39.534Z'
endDate:
type: string
format: date-time
description: The ending datetime to use when searching for audit records (in ISO 8601 format including timezone, 'yyyy-MM-dd'T'HH:mm:ss[.SSS]Z').
example: '2021-11-15T16:07:12.723Z'
author:
type: string
description: The ID of the author who changed the auditable object. This can be a user within the system or an automated app.
maxLength: 255
pattern: ^[a-zA-Z0-9@._-]+$
example: jsmith@example.com
event:
type: string
description: "This field indicates the type of event that occurred on the auditable object.\n\nAn explanation of the values is listed below:\n * CREATED - A new auditable object was created.\n * UPDATED - An existing auditable object was updated.\n * DELETED - An existing auditable object was deleted.\n"
enum:
- CREATED
- UPDATED
- DELETED
type:
type: string
enum:
- TIMETABLE
description: 'The type of auditable object.
Accepted values:
* TIMETABLE
'
example: TIMETABLE
ipAddress:
description: The originating IP Address of the author who changed the auditable object.
type: string
maxLength: 50
example: 165.225.72.60
searchKeyword:
description: Keyword to search for across all the audit records.
type: string
maxLength: 255
required:
- startDate
- endDate
- type
AuditRecord_5:
type: object
description: An audit record. Captures who, what, and when an auditable object changed within the system.
required:
- date
- event
- author
- type
- ipAddress
- auditData
properties:
date:
type: string
description: The date and time of when the audit record was created.
example: '2021-06-24T19:03:01.463Z'
event:
type: string
description: "This field indicates the type of event that occurred on the auditable object.\n\nAn explanation of the values is listed below:\n * CREATED - A new auditable object was created.\n * UPDATED - An existing auditable object was updated.\n * DELETED - An existing auditable object was deleted.\n"
enum:
- CREATED
- UPDATED
- DELETED
author:
type: string
description: The ID of the author who changed the auditable object. This can be a user within the system or an automated app.
example: jsmith@example.com
type:
type: string
enum:
- TIMETABLE
description: 'The type of auditable object.
Accepted values:
* TIMETABLE
'
maxLength: 20
example: TIMETABLE
ipAddress:
description: The originating IP Address of the author who changed the auditable object.
type: string
maxLength: 50
pattern: (?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)
example: 165.225.72.60
auditData:
$ref: '#/components/schemas/JsonNode'
Links_3:
type: object
properties:
prev:
type: string
description: URL of the previous page. Blank if currently on the first page.
next:
type: string
description: URL of the next page. Blank if currently on the last page.
AuditRecords_5:
description: A collection of audit records.
type: object
properties:
pagination:
$ref: '#/components/schemas/Pagination'
auditRecords:
type: array
items:
$ref: '#/components/schemas/AuditRecord_5'
links:
$ref: '#/components/schemas/Links_3'
AuditSearchFilter_6:
type: object
description: 'The filter to be applied when searching for audit records.
'
required:
- startDate
- endDate
- type
properties:
startDate:
type: string
format: date-time
description: 'The starting datetime to use when searching for audit records (in ISO 8601 format including timezone, ''yyyy-MM-dd''T''HH:mm:ss[.SSS]Z'').
'
example: '2021-11-13T20:25:39.534Z'
endDate:
type: string
format: date-time
description: 'The ending datetime to use when searching for audit records (in ISO 8601 format including timezone, ''yyyy-MM-dd''T''HH:mm:ss[.SSS]Z'').
'
example: '2021-11-15T16:07:12.723Z'
author:
type: string
description: 'The ID of the author who changed the auditable object. This can be a user within the system or an automated app.
'
maxLength: 255
pattern: ^[a-zA-Z0-9@._-]+$
example: jsmith@example.com
event:
type: string
description: "This field indicates the type of event that occurred on the auditable object.\n\nAn explanation of the values is listed below:\n * CREATED - A new auditable object was created.\n * UPDATED - An existing auditable object was updated.\n * DELETED - An existing auditable object was deleted.\n"
enum:
- CREATED
- UPDATED
- DELETED
type:
description: "The type of auditable object.\n\nAccepted values:\n* PROFILE\n* USER\n* RESOURCE_PARTITION \n* USERS_DEFAULT_RESOURCE\n"
type: string
enum:
- PROFILE
- USER
- RESOURCE_PARTITION
- USERS_DEFAULT_RESOURCE
example: PROFILE
ipAddress:
description: 'The originating IP Address of the author who changed the auditable object.
'
type: string
maxLength: 15
example: 165.225.72.60
searchKeyword:
description: 'Keyword to search for across all the audit records.
'
type: string
maxLength: 255
AuditRecord_6:
type: object
description: 'An audit record. Captures who, what, and when an auditable object changed within the system.
'
properties:
date:
type: string
description: 'The date and time of when the audit record was created.
'
example: '2021-06-24T19:03:01.463+00:00'
event:
type: string
description: "This field indicates the type of event that occurred on the auditable object.\n\nAn explanation of the values is listed below:\n * CREATED - A new auditable object was created.\n * UPDATED - An existing auditable object was updated.\n * DELETED - An existing auditable object was deleted.\n"
enum:
- CREATED
- UPDATED
- DELETED
author:
type: string
example: jsmith@example.com
description: 'The ID of the author who changed the auditable object. This can be a user within the system or an automated app.
'
type:
description: "The type of auditable object.\n\nAccepted values:\n* PROFILE\n* USER\n* RESOURCE_PARTITION \n* USERS_DEFAULT_RESOURCE\n"
enum:
- PROFILE
- USER
- RESOURCE_PARTITION
- USERS_DEFAULT_RESOURCE
type: string
example: PROFILE
ipAddress:
description: 'The originating IP Address of the author who changed the auditable object.
'
type: string
example: 165.225.72.60
auditData:
$ref: '#/components/schemas/JsonNode'
previousData:
$ref: '#/components/schemas/JsonNode'
Pagination_2:
type: object
properties:
pageNumber:
type: integer
description: The current page number.
example: 2
pageSize:
type: integer
description: The max number of records that can be retrieved on this page.
example: 10
total:
type: integer
description: The total number of records.
example: 100
AuditRecords_6:
description: 'A collection of audit records.
'
type: object
properties:
pagination:
$ref: '#/components/schemas/Pagination_2'
auditRecords:
type: array
items:
$ref: '#/components/schemas/AuditRecord_6'
links:
allOf:
- $ref: '#/components/schemas/Links'
example:
prev: /api/admin/user/v1/accounts/ASDJGE/audit-records:search?pageNumber=1&pageSize=10
next: /api/admin/user/v1/accounts/ASDJGE/audit-records:search?pageNumber=3&pageSize=10
responses:
ErrorConstraintViolation:
description: Constraint Violation
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ConstraintViolationError'
InternalServerError:
description: All other application errors
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ServerError'
Unauthorized:
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/UnauthorizedError'
NotFound:
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/NotFoundError'
Forbidden:
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ForbiddenError'
ErrorConstraintViolation_2:
description: Constraint Violation
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorConstraintViolation'
InternalServerError_2:
description: All other application errors
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorInternalServerError'
Unauthorized_2:
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorUnauthorized'
NotFound_2:
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorNotFound'
Forbidden_2:
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorForbidden'
Not_Found:
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/NotFoundError_2'
InternalServerError_3:
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorInternalServerError'
Unauthorized_3:
description: Unauthorized.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorUnauthorized'
NotFound_3:
description: Not Found.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorNotFound'
BadRequest:
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorConstraintViolation'
Forbidden_3:
description: Forbidden.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorForbidden'
Unauthorized_4:
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorUnauthorized'
InternalServer:
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorInternalServerError'
NotFound_4:
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorNotFound_2'
BadRequest_2:
description: BadRequest
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorConstraintViolation'
Forbidden_4:
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorForbidden'
ErrorConstraintViolation_3:
description: Constraint Violation
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorConstraintViolation_2'
Unauthorized_5:
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorUnauthorized_2'
InternalServer_2:
description: Request processing failed
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorInternalServerError_2'
NotFound_5:
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorNotFound_3'
Forbidden_5:
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
examples:
default:
$ref: '#/components/examples/ErrorForbidden_2'
examples:
SearchAuditRecordsResponse:
value:
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: ACCOUNT
auditData:
name: AricentAccount
type: ACCOUNT
enabled: true
accountSize: 10
links:
next: /api/admin/account/v1/accounts/ASDJGE/audit-records:search?pageNumber=2&pageSize=5
prev: /api/admin/account/v1/accounts/ASDJGE/audit-records:search?pageNumber=1&pageSize=5
ErrorTooManyRecords:
description: Constraint Violation
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
title: Constraint Violation
status: 400
detail: A problem that indicates a syntactically correct, yet semantically illegal request. The Server can not process this request until the client resolves the semantic errors described in the violations section.
violations:
- field: interval
message: Too many records within the requested time interval.
code: 20007
ServerError:
description: Internal Server Error
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#server-error
title: Server Error
status: 500
detail: An internal server error was encountered.
ConstraintViolationError:
description: Constraint Violation
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
title: Constraint Violation
status: 400
detail: A problem that indicates a syntactically correct, yet semantically illegal request. The Server can not process this request until the client resolves the semantic errors described in the violations section.
violations:
- field: accountId
message: must match "^[a-zA-Z]{6}$"
code: 20006
SearchAuditRecordsRequest:
value:
startDate: '2021-11-13T20:25:39.534Z'
endDate: '2021-11-15T16:07:12.723Z'
event: CREATED
author: jsmith@example.com
type: ACCOUNT
ipAddress: 165.225.72.60
searchKeyword: Chris Dunbar
UnauthorizedError:
description: Forbidden
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#unauthorized
title: Unauthorized
status: 401
detail: This operation requires authentication. See https://developers.avayacloud.com/onecloud-ccaas/docs/how-to-authenticate-with-ccaas-apis
ForbiddenError:
description: Forbidden
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#forbidden
title: Forbidden
status: 403
detail: According to the access control policy the current user and/or accountId does not have permission to access this resource.
NotFoundError:
description: Resource not found
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#resource-not-found
title: Resource Not Found
status: 404
detail: Account with AccountId:ASDAES not found.
SearchAuditRecordsResponse_2:
value:
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/v1/accounts/ASDJGE/audit-records:search?pageNumber=2&pageSize=5
prev: /api/admin/inventory/v1/accounts/ASDJGE/audit-records:search?pageNumber=1&pageSize=5
ErrorForbidden:
description: Forbidden
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#forbidden
title: Forbidden
status: 403
detail: According to the access control policy the current user and/or accountId does not have permission to access this resource.
ErrorConstraintViolation:
description: Constraint Violation
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
title: Constraint Violation
status: 400
detail: A problem that indicates a syntactically correct, yet semantically illegal request. The Server can not process this request until the client resolves the semantic errors described in the violations section.
violations:
- field: accountId
message: must match "^[a-zA-Z]{6}$"
code: 20006
ErrorNotFound:
description: Not Found
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#resource-not-found
title: Resource Not Found
status: 404
detail: Either there is no API method associated with the URL path of the request, or the request refers to one or more resources that were not found.
SearchAuditRecordsRequest_2:
value:
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
ErrorUnauthorized:
description: Unauthorized
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#unauthorized
title: Unauthorized
status: 401
detail: This operation requires authentication. See https://developers.avayacloud.com/onecloud-ccaas/docs/how-to-authenticate-with-ccaas-apis
ErrorInternalServerError:
description: Server Error
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#server-error
title: Server Error
status: 500
detail: An internal server error was encountered.
ErrorTooManyRecords_2:
description: Constraint Violation
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
title: Constraint Violation
status: 400
detail: A problem that indicates a syntactically correct, yet semantically illegal request. The Server can not process this request until the client resolves the semantic errors described in the violations section.
violations:
- field: endDate
message: Too many records within the requested time interval.
code: 20007
SearchAuditRecordsRequest_3:
value:
startDate: '2021-11-13T20:25:39.534Z'
endDate: '2021-11-15T16:07:12.723Z'
event: CREATED
author: jsmith@example.com
type: GROUP
ipAddress: 165.225.72.60
searchKeyword: Out-of-Office
GroupSearchAuditRecordsResponse:
value:
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: GROUP
auditData:
groupId: rt3e4567-e89b-12d3-a456-556642440000
name: CreditCardAgentGroup
description: Credit Card Agent Group
resources:
- type: User
resourceIds:
- 04703a3a-3dfb-4606-ae79-fd0fe0be3e64
links:
next: /api/admin/group/v1/accounts/ASDJGE/audit-records:search?pageNumber=2&pageSize=5
prev: /api/admin/group/v1/accounts/ASDJGE/audit-records:search?pageNumber=1&pageSize=5
NotFoundError_2:
description: Resource not found
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#resource-not-found
title: Resource Not Found
status: 404
detail: Group with id:7b711203-03fe-425c-8503-25826f2b579e not found.
SearchAuditRecordsResponse_3:
value:
pagination:
pageNumber: 1
pageSize: 5
total: 1
auditRecords:
- date: '2021-11-14T09:24:05.234Z'
event: CREATED
author: admin
ipAddress: 165.225.72.60
type: QUEUE
auditData:
queueId: d62d5178-9920-415a-a5d9-066716384750
name: NA Support
description: Route enagements to support agents in the NA Region
timetableId: 7893b4a3-c952-43f5-87c7-8cefa1f49685
defaultAccountQueue: false
afterContactWork: true
links:
next: /api/admin/match/v1/accounts/ABCDEF/audit-records:search?pageNumber=2&pageSize=5
prev: /api/admin/match/v1/accounts/ABCDEF/audit-records:search?pageNumber=1&pageSize=5
SearchAuditRecordsRequest_4:
value:
startDate: '2021-11-13T20:25:39.534Z'
endDate: '2021-11-15T16:07:12.723Z'
event: CREATED
author: jsmith@example.com
type: QUEUE
ipAddress: 165.225.72.60
searchKeyword: Support
SearchAuditRecordsResponse_4:
value:
pagination:
pageNumber: 2
pageSize: 5
total: 20
auditRecords:
- date: '2021-11-14T09:24:05.234Z'
event: CREATED
author: jsmith@example.com
ipAddress: 165.225.72.60
type: TIMETABLE
auditData:
autoDaylightSavingTime: false
description: Test Timetable
name: TestTimetable
timeZone: Pacific/Midway
timetableId: 5702a5be-51f9-4493-a83e-c09e768059e5
links:
next: /api/business-hours/v1/accounts/ASDJGE/audit-records:search?pageNumber=3&pageSize=5
prev: /api/business-hours/v1/accounts/ASDJGE/audit-records:search?pageNumber=1&pageSize=5
ErrorNotFound_2:
description: Not Found
value:
type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#resource-not-found
title: Resource Not Found
status: 404
detail: Resource not found.
SearchAuditRecordsRequest_5:
value:
startDate: '2021-11-13T20:25:39.534Z'
endDate: '2021-11-15T16:07:12.723Z'
event: CREATED
author: jsmith@example.com
type: TIMETABLE
ipAddress: 165.225.72.60
searchKeyword: timetable
SearchAuditRecordsResponse_5:
value:
pagination:
pageNumber: 2
pageSize: 5
total: 30
auditRecords:
- date: '2021-11-14T09:24:05.234Z'
event: CREATED
author: jsmith@example.com
ipAddress: 165.225.72.60
type: PROFILE
auditData:
profileId: W6D1JQ
profileName: Advanced
description: A profile with all the features
uxProfileId: 6f482dcd-54a9-445f-ba6d-8ca5ebd5261a
roles:
- Agent
memberOfGroups:
- 04703a3a-3dfb-4606-ae79-fd0fe0be3e64
links:
next: /api/admin/user/v1/accounts/ASDJGE/audit-records:search?pageNumber=1&pageSize=5
prev: /api/admin/user/v1/accounts/ASDJGE/audit-records:search?pageNumber=3&pageSize=5
ErrorTooManyRecords_3:
description: Constraint Violation
value:
type: https://developers.avayacloud.com/avaya-experience-platform/docs/error-handling#constraint-violation
title: Constraint Violation
status: 400
detail: A problem that indicates a syntactically correct, yet semantically illegal request. The Server can not process this request until the client resolves the semantic errors described in the violations section.
violations:
- field: interval
message: Too many records within the requested time interval.
code: 20007
ErrorForbidden_2:
description: Forbidden
value:
type: https://developers.avayacloud.com/avaya-experience-platform/docs/error-handling#forbidden
title: Forbidden
status: 403
detail: According to the access control policy the current user and/or accountId does not have permission to access this resource.
ErrorConstraintViolation_2:
description: Constraint Violation
value:
type: https://developers.avayacloud.com/avaya-experience-platform/docs/error-handling#constraint-violation
title: Constraint Violation
status: 400
detail: A problem that indicates a syntactically correct, yet semantically illegal request. The Server can not process this request until the client resolves the semantic errors described in the violations section.
violations:
- field: accountId
message: must match "^[a-zA-Z]{6}$"
code: 20006
ErrorNotFound_3:
description: Not Found
value:
type: https://developers.avayacloud.com/avaya-experience-platform/docs/error-handling#resource-not-found
title: Resource Not Found
status: 404
detail: Either there is no API method associated with the URL path of the request, or the request refers to one or more resources that were not found.
SearchAuditRecordsRequest_6:
value:
startDate: '2021-11-13T20:25:39.534Z'
endDate: '2021-11-15T16:07:12.723Z'
event: CREATED
author: jsmith@example.com
type: PROFILE
ipAddress: 165.225.72.60
searchKeyword: Chris Dunbar
ErrorUnauthorized_2:
description: Unauthorized
value:
type: https://developers.avayacloud.com/avaya-experience-platform/docs/error-handling#unauthorized
title: Unauthorized
status: 401
detail: This operation requires authentication. See https://developers.avayacloud.com/avaya-experience-platform/docs/how-to-authenticate-with-ccaas-apis
ErrorInternalServerError_2:
description: Server Error
value:
type: https://developers.avayacloud.com/avaya-experience-platform/docs/error-handling#server-error
title: Server Error
status: 500
detail: An internal server error was encountered.
parameters:
accountId:
name: accountId
description: The unique 6 character internal id that represents the customer account.
required: true
in: path
schema:
type: string
minLength: 6
maxLength: 6
pattern: ^[a-zA-Z]{6}$
example: ABCDEF
pageNumber:
name: pageNumber
in: query
description: The page number of the records to retrieve. Default value is 1.
schema:
type: integer
format: int32
default: 1
minimum: 1
example: 2
pageNumber_2:
name: pageNumber
in: query
description: The page number of the records to retrieve. Default value is 1.
schema:
type: integer
format: int32
default: 1
minimum: 1
example: 1
accountId_2:
name: accountId
description: The unique 6 character internal id that represents the customer account
required: true
in: path
schema:
type: string
minLength: 6
maxLength: 6
pattern: ^[a-zA-Z]{6}$
example: ABCDEF
pageNumber_3:
name: pageNumber
in: query
description: The page number of the records to retrieve. Default value is 1.
schema:
type: integer
format: int32
default: 1
minimum: 1
example: 1
pageSize:
name: pageSize
description: The maximum number of results per page.
required: false
in: query
schema:
type: integer
format: int32
default: 5
minimum: 5
maximum: 50
example: 5
orderBy:
name: orderBy
in: query
description: '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-sensitive (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".
'
schema:
type: string
minLength: 4
maxLength: 23
example: date desc
pageNumber_4:
name: pageNumber
description: The target page of results.
required: false
in: query
schema:
type: integer
format: int32
default: 1
minimum: 1
example: 1
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: This API uses Bearer Token Authorization Flow
bearerFormat: JWT
AppKey:
type: apiKey
in: header
name: appkey
description: This API needs an appKey as header
x-refined-from:
- avaya-axp-admin-account-openapi-original.json
- avaya-axp-admin-element-inventory-openapi-original.json
- avaya-axp-admin-group-openapi-original.json
- avaya-axp-admin-match-openapi-original.json
- avaya-axp-admin-timetable-openapi-original.json
- avaya-axp-admin-user-openapi-original.json
x-explorer-enabled: false
x-samples-languages:
- curl
- node
- java
- javascript
- python
- go