openapi: 3.0.3
info:
  title: Aisera Ingestion APIs
  description: >-
    Ingestion APIs enable external systems to push payloads of different types
    to your Aisera applications. The payloads vary by the endpoints that are
    registered to the external systems.
  version: 1.0.0
  contact: {}
servers:
  - url: https://<Name of your Aisera tenant>.api.aisera.cloud
paths:
  /tenant-users/oauth2/token:
    post:
      summary: Generate Access Token
      description: Generate Access Token
      operationId: generateAccessToken
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                client_id:
                  type: string
                  example: >-
                    <Available in the App details page on the Aisera management
                    portal>
                grant_type:
                  type: string
                  example: password
                password:
                  type: string
                  example: <Password of your Aisera tenant service account>
                username:
                  type: string
                  example: <Username of your Aisera tenant service account>
            examples:
              Generate Access Token:
                value:
                  client_id: >-
                    <Available in the App details page on the Aisera management
                    portal>
                  grant_type: password
                  password: <Password of your Aisera tenant service account>
                  username: <Username of your Aisera tenant service account>
      responses:
        '200':
          description: Access Token Generator
          headers:
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Length:
              schema:
                type: string
                example: '886'
            Date:
              schema:
                type: string
                example: Thu, 21 Mar 2024 03:43:31 GMT
            Server:
              schema:
                type: string
                example: Jetty(9.4.53.v20231009)
            Vary:
              schema:
                type: string
                example: Origin
          content:
            application/json:
              schema:
                type: object
                properties:
                  access_token:
                    type: string
                    example: REDACTED
                  expires_in:
                    type: number
                    example: 3600
                  refresh_token:
                    type: string
                    example: REDACTED
                  token_type:
                    type: string
                    example: bearer
                  values:
                    type: object
                    properties:
                      access_token:
                        type: string
                        example: REDACTED
                      expires_in:
                        type: number
                        example: 3600
                      refresh_token:
                        type: string
                        example: REDACTED
                      token_type:
                        type: string
                        example: bearer
              examples:
                Access Token Generator:
                  value:
                    access_token: REDACTED
                    expires_in: 3600
                    refresh_token: REDACTED
                    token_type: bearer
                    values:
                      access_token: REDACTED
                      expires_in: 3600
                      refresh_token: REDACTED
                      token_type: bearer
  /alerts:
    post:
      summary: Alerts Ingestion
      description: Alerts Ingestion
      operationId: alertsIngestion
      parameters:
        - name: x-app-token
          in: header
          schema:
            type: string
            example: '{{Client ID / App Token}}'
      requestBody:
        content:
          application/json:
            examples:
              Alerts Ingestion:
                value: "{\r\n    /*\r\n        Use the fields as defined on your data source.\r\n    */\r\n}"
      responses:
        '200':
          description: ''
      security:
        - bearerAuth: []
  /changes:
    post:
      summary: Changes Ingestion
      description: Changes Ingestion
      operationId: changesIngestion
      parameters:
        - name: x-app-token
          in: header
          schema:
            type: string
            example: '{{Client ID / App Token}}'
      requestBody:
        content:
          application/json:
            examples:
              Changes Ingestion:
                value: "{\r\n    /*\r\n        Use the fields as defined on your data source.\r\n    */\r\n}"
      responses:
        '200':
          description: ''
      security:
        - bearerAuth: []
  /incidents:
    post:
      summary: Incidents Ingestion
      description: Incidents Ingestion
      operationId: incidentsIngestion
      parameters:
        - name: x-app-token
          in: header
          schema:
            type: string
            example: '{{Client ID / App Token}}'
      requestBody:
        content:
          application/json:
            examples:
              Incidents Ingestion:
                value: "{\r\n    /*\r\n        Use the fields as defined on your data source.\r\n    */\r\n}"
      responses:
        '200':
          description: ''
      security:
        - bearerAuth: []
  /knowledge-articles:
    post:
      summary: Knowledge Ingestion
      description: >-
        Enables ingestion of new knowledge articles or of updates to existing
        knowledge articles. The request body depends on the field mappings
        defined on the data source to which the API will push the data.
      operationId: knowledgeIngestion
      parameters:
        - name: x-app-token
          in: header
          schema:
            type: string
            example: '{{Client ID / App Token}}'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  groups:
                    type: array
                    items:
                      type: string
                      example: Grp1
                    example:
                      - Grp1
                      - Grp2
                  id:
                    type: string
                    example: '1'
                  text:
                    type: string
                    example: >-
                      <!DOCTYPE html><html><head>    <meta charset="UTF-8">   
                      <title>Sample</title></head><body>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p></body></html>
              example:
                - groups:
                    - Grp1
                    - Grp2
                  id: '1'
                  text: >-
                    <!DOCTYPE html><html><head>    <meta charset="UTF-8">   
                    <title>Sample</title></head><body>    <p>Lorem ipsum dolor,
                    sit amet consectetur adipisicing elit. Quaerat quo corrupti
                    unde aliquam magnam, maxime labore        eos omnis possimus
                    autem similique quae, quia nam, molestiae aperiam ratione
                    est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet
                    consectetur adipisicing elit. Quaerat quo corrupti unde
                    aliquam magnam, maxime labore        eos omnis possimus
                    autem similique quae, quia nam, molestiae aperiam ratione
                    est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet
                    consectetur adipisicing elit. Quaerat quo corrupti unde
                    aliquam magnam, maxime labore        eos omnis possimus
                    autem similique quae, quia nam, molestiae aperiam ratione
                    est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet
                    consectetur adipisicing elit. Quaerat quo corrupti unde
                    aliquam magnam, maxime labore        eos omnis possimus
                    autem similique quae, quia nam, molestiae aperiam ratione
                    est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet
                    consectetur adipisicing elit. Quaerat quo corrupti unde
                    aliquam magnam, maxime labore        eos omnis possimus
                    autem similique quae, quia nam, molestiae aperiam ratione
                    est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet
                    consectetur adipisicing elit. Quaerat quo corrupti unde
                    aliquam magnam, maxime labore        eos omnis possimus
                    autem similique quae, quia nam, molestiae aperiam ratione
                    est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet
                    consectetur adipisicing elit. Quaerat quo corrupti unde
                    aliquam magnam, maxime labore        eos omnis possimus
                    autem similique quae, quia nam, molestiae aperiam ratione
                    est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet
                    consectetur adipisicing elit. Quaerat quo corrupti unde
                    aliquam magnam, maxime labore        eos omnis possimus
                    autem similique quae, quia nam, molestiae aperiam ratione
                    est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet
                    consectetur adipisicing elit. Quaerat quo corrupti unde
                    aliquam magnam, maxime labore        eos omnis possimus
                    autem similique quae, quia nam, molestiae aperiam ratione
                    est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet
                    consectetur adipisicing elit. Quaerat quo corrupti unde
                    aliquam magnam, maxime labore        eos omnis possimus
                    autem similique quae, quia nam, molestiae aperiam ratione
                    est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet
                    consectetur adipisicing elit. Quaerat quo corrupti unde
                    aliquam magnam, maxime labore        eos omnis possimus
                    autem similique quae, quia nam, molestiae aperiam ratione
                    est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet
                    consectetur adipisicing elit. Quaerat quo corrupti unde
                    aliquam magnam, maxime labore        eos omnis possimus
                    autem similique quae, quia nam, molestiae aperiam ratione
                    est ut repellendus?</p></body></html>
                - groups:
                    - Grp1
                    - Grp4
                  id: '2'
                  text: >-
                    <HTML><HEAD><TITLE>Your Title Here</TITLE></HEAD><BODY
                    BGCOLOR="FFFFFF"><CENTER><IMG SRC="clouds.jpg"
                    ALIGN="BOTTOM"> </CENTER><HR><a
                    href="http://somegreatsite.com">Link Name</a>is a link to
                    another nifty site<H1>This is a Header</H1><H2>This is a
                    Medium Header</H2>Send me mail at <a
                    href="mailto:support@yourcompany.com">support@yourcompany.com</a>.<P>
                    This is a new paragraph!<P> <B>This is a new
                    paragraph!</B><BR> <B><I>This is a new sentence without a
                    paragraph break, in bold italics.</I></B><HR></BODY></HTML>
            examples:
              Knowledge Ingestion:
                value:
                  - groups:
                      - Grp1
                      - Grp2
                    id: '1'
                    text: >-
                      <!DOCTYPE html><html><head>    <meta charset="UTF-8">   
                      <title>Sample</title></head><body>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum
                      dolor, sit amet consectetur adipisicing elit. Quaerat quo
                      corrupti unde aliquam magnam, maxime labore        eos
                      omnis possimus autem similique quae, quia nam, molestiae
                      aperiam ratione est ut repellendus?</p></body></html>
                  - groups:
                      - Grp1
                      - Grp4
                    id: '2'
                    text: >-
                      <HTML><HEAD><TITLE>Your Title Here</TITLE></HEAD><BODY
                      BGCOLOR="FFFFFF"><CENTER><IMG SRC="clouds.jpg"
                      ALIGN="BOTTOM"> </CENTER><HR><a
                      href="http://somegreatsite.com">Link Name</a>is a link to
                      another nifty site<H1>This is a Header</H1><H2>This is a
                      Medium Header</H2>Send me mail at <a
                      href="mailto:support@yourcompany.com">support@yourcompany.com</a>.<P>
                      This is a new paragraph!<P> <B>This is a new
                      paragraph!</B><BR> <B><I>This is a new sentence without a
                      paragraph break, in bold
                      italics.</I></B><HR></BODY></HTML>
      responses:
        '200':
          description: ''
      security:
        - bearerAuth: []
    delete:
      summary: Knowledge Deletion
      description: >-
        Enables batch deletion of knowledge articles previously ingested into
        Aisera.
      operationId: knowledgeDeletion
      parameters:
        - name: x-app-token
          in: header
          schema:
            type: string
            example: '{{Client ID / App Token}}'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    example: '949896746'
              example:
                - id: '949896746'
                - id: '21024079790'
                - id: '2102407979'
            examples:
              Knowledge Deletion:
                value:
                  - id: '949896746'
                  - id: '21024079790'
                  - id: '2102407979'
      responses:
        '200':
          description: ''
      security:
        - bearerAuth: []
  /problems:
    post:
      summary: Problems Ingestion
      description: Problems Ingestion
      operationId: problemsIngestion
      parameters:
        - name: x-app-token
          in: header
          schema:
            type: string
            example: '{{Client ID / App Token}}'
      requestBody:
        content:
          application/json:
            examples:
              Problems Ingestion:
                value: "{\r\n    /*\r\n        Use the fields as defined on your data source.\r\n    */\r\n}"
      responses:
        '200':
          description: ''
      security:
        - bearerAuth: []
  /requests:
    post:
      summary: Requests Ingestion
      description: Requests Ingestion
      operationId: requestsIngestion
      parameters:
        - name: x-app-token
          in: header
          schema:
            type: string
            example: '{{Client ID / App Token}}'
      requestBody:
        content:
          application/json:
            examples:
              Requests Ingestion:
                value: "{\r\n    /*\r\n        Use the fields as defined on your data source.\r\n    */\r\n}"
      responses:
        '200':
          description: ''
      security:
        - bearerAuth: []
  /requestitems:
    post:
      summary: Request Items Ingestion
      description: Request Items Ingestion
      operationId: requestItemsIngestion
      parameters:
        - name: x-app-token
          in: header
          schema:
            type: string
            example: '{{Client ID / App Token}}'
      requestBody:
        content:
          application/json:
            examples:
              Request Items Ingestion:
                value: "{\r\n    /*\r\n        Use the fields as defined on your data source.\r\n    */\r\n}"
      responses:
        '200':
          description: ''
      security:
        - bearerAuth: []
  /conversations:
    post:
      summary: Conversations Ingestion
      description: Conversations Ingestion
      operationId: conversationsIngestion
      parameters:
        - name: x-app-token
          in: header
          schema:
            type: string
            example: '{{Client ID / App Token}}'
      requestBody:
        content:
          application/json:
            examples:
              Conversations Ingestion:
                value: "{\r\n    /*\r\n        Use the fields as defined on your data source.\r\n    */\r\n}"
      responses:
        '200':
          description: ''
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
tags: []
