openapi: 3.0.3
info:
  title: Activiti Public Rest About Process Instances Listing 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: Process Instances Listing
  description: Listing
paths:
  /api/enterprise/process-instances/filter:
    post:
      tags:
      - Process Instances Listing
      summary: Filter a list of process instances
      operationId: filterProcessInstancesUsingPOST
      requestBody:
        description: filterRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessInstanceFilterRequestRepresentation'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/process-instances/query:
    post:
      tags:
      - Process Instances Listing
      summary: Retrieve a list of process instances
      operationId: getProcessInstancesUsingPOST
      requestBody:
        description: requestNode
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ObjectNode'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '201':
          description: Created
        '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
    AbstractRepresentation: {}
    ProcessInstanceFilterRepresentation:
      properties:
        asc:
          type: boolean
        name:
          type: string
        processDefinitionId:
          type: string
        processDefinitionKey:
          type: string
        sort:
          type: string
        state:
          type: string
    ProcessInstanceFilterRequestRepresentation:
      properties:
        appDefinitionId:
          type: integer
          format: int64
        filter:
          $ref: '#/components/schemas/ProcessInstanceFilterRepresentation'
        filterId:
          type: integer
          format: int64
        page:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
    ObjectNode: {}
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using valid Activiti user credentials