openapi: 3.0.3
info:
  title: Activiti Public Rest About Integration API
  description: " The Alfresco Activiti BPM Suite comes with a REST API. It includes both an Enterprise equivalent of the Activiti Open Source REST API exposing the generic Activiti Engine operations, and a dedicated set op REST API endpoints specific for the functionality in the Alfresco Activiti BPM Suite. \n      Note that there is also an 'internal' REST API, which are the REST endpoints used by the Javascript UI. It is advised not to use this API, these REST API urls and way of using it will change and evolve with the product and are unsupported. The supported API is stable. Also, the internal REST API uses a different authentication mechanism tailored towards web browser usage.\n"
  version: 1.4.0
  contact:
    name: Activiti Community
    url: https://www.activiti.org/
    email: activiti-community@alfresco.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://{host}/activiti-app
  description: Activiti BPM Server
  variables:
    host:
      default: localhost:8080
      description: The Activiti server host
security:
- basicAuth: []
tags:
- name: Integration
paths:
  /api/enterprise/integration/alfresco-cloud/confirm-auth-request:
    get:
      tags:
      - Integration
      summary: Alfresco Cloud Authorization
      description: Returns Alfresco Oauth HTML Page
      operationId: confirmAuthorisationUsingGET
      parameters:
      - name: code
        in: query
        description: code
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/integration/alfresco-cloud/networks:
    get:
      tags:
      - Integration
      summary: List Alfresco networks
      operationId: getAllNetworksUsingGET
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/integration/alfresco-cloud/networks/{networkId}/folders/{folderId}/content:
    get:
      tags:
      - Integration
      summary: List file & folders inside a specific folder
      operationId: getContentInFolderUsingGET
      parameters:
      - name: networkId
        in: path
        description: networkId
        required: true
        schema:
          type: string
      - name: folderId
        in: path
        description: folderId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/integration/alfresco-cloud/networks/{networkId}/sites:
    get:
      tags:
      - Integration
      summary: List Alfresco sites
      description: Returns ALL Sites
      operationId: getAllSitesUsingGET
      parameters:
      - name: networkId
        in: path
        description: networkId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/integration/alfresco-cloud/networks/{networkId}/sites/{siteId}/content:
    get:
      tags:
      - Integration
      summary: List file & folders inside a specific site
      operationId: getContentInSiteUsingGET
      parameters:
      - name: networkId
        in: path
        description: networkId
        required: true
        schema:
          type: string
      - name: siteId
        in: path
        description: siteId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/integration/alfresco/{repositoryId}/folders/{folderId}/content:
    get:
      tags:
      - Integration
      summary: List file & folders inside a specific folder
      operationId: getContentInFolderUsingGET_1
      parameters:
      - name: repositoryId
        in: path
        description: repositoryId
        required: true
        schema:
          type: string
      - name: folderId
        in: path
        description: folderId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/integration/alfresco/{repositoryId}/sites:
    get:
      tags:
      - Integration
      summary: List Alfresco sites
      description: Returns ALL Sites
      operationId: getAllSitesUsingGET_1
      parameters:
      - name: repositoryId
        in: path
        description: repositoryId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/integration/alfresco/{repositoryId}/sites/{siteId}/content:
    get:
      tags:
      - Integration
      summary: List file & folders inside a specific site
      operationId: getContentInSiteUsingGET_1
      parameters:
      - name: repositoryId
        in: path
        description: repositoryId
        required: true
        schema:
          type: string
      - name: siteId
        in: path
        description: siteId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/integration/box/confirm-auth-request:
    get:
      tags:
      - Integration
      summary: Box Authorization
      description: Returns Box Oauth HTML Page
      operationId: confirmAuthorisationUsingGET_1
      parameters:
      - name: code
        in: query
        description: code
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/integration/box/files:
    get:
      tags:
      - Integration
      summary: List file & folders
      operationId: getFilesUsingGET
      parameters:
      - name: filter
        in: query
        description: filter
        required: false
        schema:
          type: string
      - name: parent
        in: query
        description: parent
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/integration/box/status:
    get:
      tags:
      - Integration
      summary: Retrieve if Box Integration is enabled
      operationId: getBoxPluginStatusUsingGET
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: boolean
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/integration/box/{userId}/account:
    get:
      tags:
      - Integration
      summary: List Box Account
      operationId: getRepositoryAccountUsingGET
      parameters:
      - name: userId
        in: path
        description: userId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoxUserAccountCredentialsRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    post:
      tags:
      - Integration
      summary: Create Box account
      operationId: createRepositoryAccountUsingPOST
      parameters:
      - name: userId
        in: path
        description: userId
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: credentials
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAccountCredentialsRepresentation'
        required: true
      responses:
        '200':
          description: OK
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    put:
      tags:
      - Integration
      summary: Update Box account
      operationId: updateRepositoryAccountUsingPUT
      parameters:
      - name: userId
        in: path
        description: userId
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: credentials
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAccountCredentialsRepresentation'
        required: true
      responses:
        '200':
          description: OK
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    delete:
      tags:
      - Integration
      summary: Delete Box account
      operationId: deleteRepositoryAccountUsingDELETE
      parameters:
      - name: userId
        in: path
        description: userId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /api/enterprise/integration/google-drive/confirm-auth-request:
    get:
      tags:
      - Integration
      summary: Drive Authorization
      description: Returns Drive Oauth HTML Page
      operationId: confirmAuthorisationUsingGET_2
      parameters:
      - name: code
        in: query
        description: code
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/integration/google-drive/files:
    get:
      tags:
      - Integration
      summary: List file & folders
      operationId: getFilesUsingGET_1
      parameters:
      - name: filter
        in: query
        description: filter
        required: false
        schema:
          type: string
      - name: parent
        in: query
        description: parent
        required: false
        schema:
          type: string
      - name: currentFolderOnly
        in: query
        description: currentFolderOnly
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/profile/accounts/alfresco:
    get:
      tags:
      - Integration
      summary: List Alfresco repositories
      description: A tenant administrator can configure one or more Alfresco repositories to use when working with content.
      operationId: getRepositoriesUsingGET
      parameters:
      - name: tenantId
        in: query
        description: tenantId
        required: false
        schema:
          type: integer
          format: int64
      - name: includeAccounts
        in: query
        description: includeAccounts
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
components:
  schemas:
    ResultListDataRepresentation:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AbstractRepresentation'
        size:
          type: integer
          format: int32
        start:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
    BoxUserAccountCredentialsRepresentation:
      properties:
        authenticationURL:
          type: string
        expireDate:
          type: string
          format: date-time
        ownerEmail:
          type: string
    UserAccountCredentialsRepresentation:
      properties:
        password:
          type: string
        username:
          type: string
    AbstractRepresentation: {}
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using valid Activiti user credentials