Avaya Element Management API

openapi: 3.2.0
info:
  title: Admin - Element Inventory Element Management API
  description: 'The Element Inventory Service API is use to manage information about Elements.


    Element Inventory Services will support multiple ways to provision Elements

    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.1
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/inventory/v1
security:
- {}
- BearerAuth: []
  AppKey: []
tags:
- name: Element Management
  description: An Element is a server instance which provides feature capability. Some examples of elements are Avaya Cloud Office, Chat Connector, Microsoft Teams and so on.
paths:
  /accounts/{accountId}/elements:
    get:
      tags:
      - Element Management
      summary: List Elements
      description: '**This API requires the Account Administrator role.**


        Lists all of the elements for an account.'
      operationId: listElements
      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 10.

          '
        required: false
        schema:
          type: integer
          format: int32
          example: 5
          default: 10
          minimum: 5
          maximum: 50
      - 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  * hostname\n  * elementType\n  * elementSubType\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:Avaya Cloud Office
          prefix:
            description: Example of filtering based on a prefix string.
            value: name:Avaya Cloud*
          postfix:
            description: Example of filtering based on a postfix string.
            value: name:*Cloud Office
      - name: orderBy
        in: query
        required: false
        description: "Field name on which ordering needs to be performed. The default order is ascending.\n\nThe possible fields that can be ordered on are:\n  * name\n  * hostname\n  * elementType\n  * elementSubType\n\nField Names are case-senstive (should be written as it is in description).\n\nTo specify descending order, a suffix \" desc\" should be added. For example, \"name\" for ascending or \"name desc\" for descending\".\n"
        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/ElementPage'
              examples:
                Element:
                  $ref: '#/components/examples/ElementPage'
        '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:
  responses:
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorForbidden'
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorNotFound'
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorUnauthorized'
    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'
  examples:
    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.
    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.
    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
    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
    ElementPage:
      description: Paginated Element Data
      value:
        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/v1/elements?pageNumber=1&pageSize=10
          next: /api/admin/inventory/v1/elements?pageNumber=3&pageSize=10
    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:
    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
  schemas:
    Element:
      type: object
      description: 'An Element is a server instance

        '
      properties:
        elementId:
          type: string
          example: fa703a3a-3dfb-4606-ae79-fd0fe0be3e64
          description: The unique 36 character internal id (uuid) that represents the element.
          minLength: 36
          maxLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        description:
          type: string
          example: Avaya Cloud Office Description
          maxLength: 1024
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        elementData:
          type: object
          properties: {}
          example:
            name: Avaya Cloud Office
            hostname: Production
        elementType:
          type: string
          example: ACO
          minLength: 1
          maxLength: 255
          pattern: ^[a-zA-Z0-9\-\_\.\ ]+$
        elementSubType:
          type: string
          maxLength: 255
          pattern: ^[a-zA-Z0-9\-\_\.\ ]+$
        status:
          type: string
          description: "This field indicates the current status of an Element.\n\nAn explanation of the values is listed below:\n  * SUCCESS - An Element was created/updated successfully.\n  * FAILED - operation on Element was failed.\n  * IN_PROGRESS - operation performed on an Element is in progress.\n"
          enum:
          - SUCCESS
          - FAILED
          - IN_PROGRESS
        statusCode:
          type: string
          readOnly: true
          example: '14066'
        statusMessage:
          type: string
          readOnly: true
          example: cannot create element due to database failure
      required:
      - elementData
      - elementType
    ElementPage:
      description: 'Paginated Element Data

        '
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        elements:
          type: array
          items:
            $ref: '#/components/schemas/Element'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/inventory/v1/elements?pageNumber=1&pageSize=10
            next: /api/admin/inventory/v1/elements?pageNumber=3&pageSize=10
    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
    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.
    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.
  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