Avaya Avaya Aura Device Services API

openapi: 3.2.0
info:
  title: Admin - Voice Avaya Aura Device Services API
  description: 'The Voice provider APIs are used to manage information about voice specific elements and different voice related entities e.g. Phone numbers.


    Voice Services will support multiple ways to provision voice providers

    1. Programmatic Interface (Rest APIs)

    2. User Interface'
  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.2
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/voice/v1
security:
- {}
- BearerAuth: []
  AppKey: []
tags:
- name: Avaya Aura Device Services
  description: Administration of Avaya Aura Device Service Elements. These API are expected to be called by an account administrator. AADS is the abbreviated form for Avaya Aura Device Service and is commonly used in the summary of the Apis. OIDC stands for OpenID Connect Discovery.
paths:
  /accounts/{accountId}/avaya-aura-device-services:
    post:
      tags:
      - Avaya Aura Device Services
      summary: Creates an AADS Element
      description: '**This API requires the Account Administrator role.**


        Creates an Avaya Aura Device Service Element for specified account'
      operationId: createAvayaAuraDeviceService
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvayaAuraDeviceService'
            examples:
              default:
                $ref: '#/components/examples/AvayaAuraDeviceServiceReq'
        required: true
      responses:
        '202':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvayaAuraDeviceServiceResponse'
              examples:
                default:
                  $ref: '#/components/examples/AvayaAuraDeviceServiceRes'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Avaya Aura Device Services
      summary: Gets a list of all AADS
      description: '**This API requires the Account Administrator role.**


        Returns the list of all available Avaya Aura Device Service Elements by account Id'
      operationId: getAllAvayaAuraDeviceService
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: filter
        in: query
        required: false
        description: "Specifies details of a row filter.\n\n The possible fields that can be filtered on are:\n  * name\n\nThe allowed format:\n  - Begins with the column name to be filtered, followed by a colon, then:\n    - Either an exact string to match, or\n    - A string expression including the * wildcard character\n      - :{PREFIX}* will be used to find out word start with.\n      - :*{POSTFIX} will be used to find out word end with\n      - : will be used to match exact word\n  - Begin with column name to be filtered, followed by a = operator. (this will be used to match exact string)\n"
        schema:
          type: string
          maxLength: 255
        examples:
          exact:
            description: Example of filtering based on an exact string.
            value: name=AADS123
          prefix:
            description: Example of filtering based on a prefix string.
            value: name:AADS1*
          postfix:
            description: Example of filtering based on a postfix string.
            value: name:*AADS
      - name: orderBy
        in: query
        required: false
        description: '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".

          '
        schema:
          type: string
          default: name
          maxLength: 255
        examples:
          ascending:
            value: name
          descending:
            value: name desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvayaAuraDeviceServices'
              examples:
                default:
                  $ref: '#/components/examples/AvayaAuraDeviceServicesRes'
        '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'
  /accounts/{accountId}/avaya-aura-device-services/{avayaAuraDeviceServiceId}:
    put:
      tags:
      - Avaya Aura Device Services
      summary: Updates an AADS Element
      description: '**This API requires the Account Administrator role.**


        Updates an existing Avaya Aura Device Service Element with unique id of the element by account id'
      operationId: updateAvayaAuraDeviceService
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/avayaAuraDeviceServiceId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvayaAuraDeviceService'
            examples:
              default:
                $ref: '#/components/examples/AvayaAuraDeviceServiceReq'
        required: true
      responses:
        '202':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvayaAuraDeviceServiceResponse'
              examples:
                default:
                  $ref: '#/components/examples/AvayaAuraDeviceServiceRes'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Avaya Aura Device Services
      summary: Gets the details of a AADS
      description: '**This API requires the Account Administrator role.**


        Returns the details of an Avaya Aura Device Service Element, based on unique id of the element and account id'
      operationId: getAvayaAuraDeviceService
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/avayaAuraDeviceServiceId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvayaAuraDeviceService'
              examples:
                default:
                  $ref: '#/components/examples/AvayaAuraDeviceServiceObj'
        '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'
    delete:
      tags:
      - Avaya Aura Device Services
      summary: Deletes an AADS Element
      description: '**This API requires the Account Administrator role.**


        Deletes an existing Avaya Aura Device Service Element identified by unique id of the element'
      operationId: deleteAvayaAuraDeviceService
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/avayaAuraDeviceServiceId'
      responses:
        '202':
          description: Accepted
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/avaya-aura-device-services:discoveryUrl:
    get:
      tags:
      - Avaya Aura Device Services
      summary: Gets the OIDC Url
      description: '**This API requires the Account Administrator role.**


        Returns the OpenID Connect Discovery Url, based on account id'
      operationId: getOpenIDConnectDiscovery
      parameters:
      - $ref: '#/components/parameters/accountId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenIDConnectDiscovery'
              examples:
                default:
                  $ref: '#/components/examples/OpenIDConnectDiscoveryRes'
        '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'
components:
  examples:
    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 does not have permission to access this resource.
    AvayaAuraDeviceServiceReq:
      description: Avaya Aura Device Service request model
      value:
        name: AADS
        description: AADS server for testing
        hostname: dev-11.avaya.com
        port: 443
    AvayaAuraDeviceServiceObj:
      description: Avaya Aura Device Service model
      value:
        id: 04703a3a-3dfb-4606-ae79-fd0fe0be3e64
        name: AADS
        description: AADS server for testing
        hostname: aadsserver.avaya.com
        port: 443
        openIDConnectDiscovery: https://dev-11.ixcc-sandbox.avayacloud.com/auth/realms/YOPXPM/.well-known/openid-configuration
        status: SUCCESS
    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
    ErrorMethodNotAllowed:
      description: Method not allowed
      value:
        title: Method not allowed
        status: 405
        detail: The request calls an HTTP method that is not supported at the resource.
    AvayaAuraDeviceServiceRes:
      description: A HATEOAS url response that is a reference to the created or updated AADS Element
      value:
        url: /api/admin/voice/v1/accounts/ABCDEF/avaya-aura-device-services/63c6ff9d-3370-090e-bkb2-7gh442b99985
    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.
    OpenIDConnectDiscoveryRes:
      description: Open ID Connect Discovery model
      value:
        openIDConnectDiscovery: https://dev-11.ixcc-sandbox.avayacloud.com/auth/realms/YOPXPM/.well-known/openid-configuration
    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
    AvayaAuraDeviceServicesRes:
      description: Avaya Aura Device Services model
      value:
        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
    ErrorConflict:
      description: Conflict
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#conflict
        title: Conflict
        status: 409
        detail: A resource with the same unique constraint values already exists.
        violations:
        - field: name
          message: Communication Manager with same name already exists.
        - field: hostname
          message: Communication Manager with same hostname already exists.
    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.
  parameters:
    avayaAuraDeviceServiceId:
      name: avayaAuraDeviceServiceId
      description: The unique id of the element
      in: path
      required: true
      schema:
        type: string
        example: 2ec20580-d204-43f3-ae0b-34795439137f
        maxLength: 36
        minLength: 36
    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
  responses:
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorNotFound'
    InternalServerError:
      description: All other application errors
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorInternalServerError'
    ErrorConstraintViolation:
      description: Constraint Violation
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorConstraintViolation'
    Conflict:
      description: Conflict
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorConflict'
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorForbidden'
    MethodNotAllowed:
      description: Method Not Allowed
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorMethodNotAllowed'
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorUnauthorized'
  schemas:
    AvayaAuraDeviceServices:
      title: AvayaAuraDeviceServices
      type: object
      description: List of Avaya Aura Device Service Elements
      properties:
        resources:
          type: array
          maxItems: 10
          items:
            $ref: '#/components/schemas/AvayaAuraDeviceService'
    AvayaAuraDeviceService:
      title: AvayaAuraDeviceService
      type: object
      description: Avaya Aura Device Service Element
      required:
      - hostname
      - name
      - port
      properties:
        id:
          type: string
          readOnly: true
          description: The unique id of the element.
          example: 04703a3a-3dfb-4606-ae79-fd0fe0be3e64
        name:
          type: string
          description: Name of the element. This should be unique per type.
          example: AADS
          minLength: 3
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        description:
          type: string
          description: Description of Avaya Aura Device Service Element
          example: cust
          minLength: 3
          maxLength: 255
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        hostname:
          type: string
          description: Hostname of Element
          example: aads-dev-11.avaya.com
          minLength: 1
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\@\-\_\/\:\.\ ]+$
        port:
          type: integer
          format: int32
          description: Port used to connect to Avaya Aura Device Service Element
          minimum: 0
          maximum: 65536
          example: 443
        openIDConnectDiscovery:
          type: string
          readOnly: true
          description: OpenID Connect Discovery URL
          example: https://dev-11.ixcc-sandbox.avayacloud.com/auth/realms/YOPXPM/.well-known/openid-configuration
        status:
          type: string
          readOnly: true
          description: Status of the object under operation
          enum:
          - IN_PROGRESS
          - FAILED
          - SUCCESS
          example: SUCCESS
    OpenIDConnectDiscovery:
      title: OpenIDConnectDiscovery
      type: object
      description: OpenID Connect Discovery Url  which is associated with Avaya Aura Device Service
      properties:
        openIDConnectDiscovery:
          type: string
          readOnly: true
          description: OpenID Connect Discovery Url
          example: https://dev-11.ixcc-sandbox.avayacloud.com/auth/realms/YOPXPM/.well-known/openid-configuration
    AvayaAuraDeviceServiceResponse:
      type: object
      description: Represents the response for an asynchronous operation that simply returns a HATEOAS url, that provides a reference to the object under operation
      properties:
        url:
          type: string
          example: /api/admin/voice/v1/accounts/ABCDEF/avaya-aura-device-services/63c6ff9d-3370-090e-bkb2-7gh442b99985
          maxLength: 2048
    Problem:
      type: object
      description: '<b>Problem Detail</b> 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 <a href="https://tools.ietf.org/html/rfc7807">RFC 7807</a>

        '
      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
  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-explorer-enabled: false
x-samples-languages:
- curl
- node
- java
- javascript
- python
- go