Flowable Query API

openapi: 3.0.0
info:
  description: "# flowable / flowəb(ə)l /\r\n\r\n- a compact and highly efficient workflow and Business Process Management (BPM) platform for developers, system admins and business users.\r\n- a lightning fast, tried and tested BPMN 2 process engine written in Java. It is Apache 2.0 licensed open source, with a committed community.\r\n- can run embedded in a Java application, or as a service on a server, a cluster, and in the cloud. It integrates perfectly with Spring. With a rich Java and REST API, it is the ideal engine for orchestrating human or system activities."
  version: v1
  title: Flowable REST Access Tokens Query API
  contact:
    name: Flowable
    url: http://www.flowable.org/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: /flowable-rest/service
tags:
- name: Query
paths:
  /query/activity-instances:
    post:
      tags:
      - Query
      summary: Query for activity instances
      description: All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic task instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long.
      operationId: queryActivityInstances
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivityInstanceQueryRequest'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the activities are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseActivityInstanceResponse'
        '400':
          description: Indicates an parameter was passed in the wrong format. The status-message contains additional information
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryActivityInstances has multiple requestBodies
  /query/executions:
    post:
      tags:
      - Query
      summary: Query executions
      description: 'The request body can contain all possible filters that can be used in the List executions URL query. On top of these, it’s possible to provide an array of variables and processInstanceVariables to include in the query, with their format described here.


        The general paging and sorting query-parameters can be used for this URL.'
      operationId: queryExecutions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecutionQueryRequest'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the executions are returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseExecutionResponse'
        '404':
          description: Indicates a parameter was passed in the wrong format . The status-message contains additional information.
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryExecutions has multiple requestBodies
  /query/historic-activity-instances:
    post:
      tags:
      - Query
      summary: Query for historic activity instances
      description: All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic task instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long.
      operationId: queryActivityInstances
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HistoricActivityInstanceQueryRequest'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the activities are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseHistoricActivityInstanceResponse'
        '400':
          description: Indicates an parameter was passed in the wrong format. The status-message contains additional information
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryActivityInstances has multiple requestBodies
  /query/historic-detail:
    post:
      tags:
      - Query
      summary: Query for historic details
      description: All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic process instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long.
      operationId: queryHistoricDetail
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HistoricDetailQueryRequest'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the historic details are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseHistoricDetailResponse'
        '400':
          description: Indicates an parameter was passed in the wrong format. The status-message contains additional information.
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryHistoricDetail has multiple requestBodies
  /query/historic-process-instances:
    post:
      tags:
      - Query
      summary: Query for historic process instances
      description: All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic process instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The variables property is a JSON-array containing objects with the format as described here.
      operationId: queryHistoricProcessInstance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HistoricProcessInstanceQueryRequest'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the process instances are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseHistoricProcessInstanceResponse'
        '400':
          description: Indicates an parameter was passed in the wrong format. The status-message contains additional information.
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryHistoricProcessInstance has multiple requestBodies
  /query/historic-task-instances:
    post:
      tags:
      - Query
      summary: Query for historic task instances
      description: All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic task instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The taskVariables and processVariables properties are JSON-arrays containing objects with the format as described here.
      operationId: queryHistoricTaskInstance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HistoricTaskInstanceQueryRequest'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the tasks are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseHistoricTaskInstanceResponse'
        '404':
          description: Indicates an parameter was passed in the wrong format. The status-message contains additional information.
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryHistoricTaskInstance has multiple requestBodies
  /query/historic-variable-instances:
    post:
      tags:
      - Query
      summary: Query for historic variable instances
      description: All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic process instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The variables property is a JSON-array containing objects with the format as described here.
      operationId: queryVariableInstances
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HistoricVariableInstanceQueryRequest'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the tasks are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseHistoricVariableInstanceResponse'
        '400':
          description: Indicates an parameter was passed in the wrong format. The status-message contains additional information.
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryVariableInstances has multiple requestBodies
  /query/process-instances:
    post:
      tags:
      - Query
      summary: Query process instances
      description: 'The request body can contain all possible filters that can be used in the List process instances URL query. On top of these, it’s possible to provide an array of variables to include in the query, with their format described here.


        The general paging and sorting query-parameters can be used for this URL.'
      operationId: queryProcessInstances
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessInstanceQueryRequest'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the process-instances are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseProcessInstanceResponse'
        '400':
          description: Indicates a parameter was passed in the wrong format . The status-message contains additional information.
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryProcessInstances has multiple requestBodies
  /query/tasks:
    post:
      tags:
      - Query
      summary: Query for tasks
      description: All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of tasks (except for candidateGroupIn which is only available in this POST task query REST service), but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on task and process variables. The taskVariables and processInstanceVariables are both JSON-arrays containing objects with the format as described here.
      operationId: queryTasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskQueryRequest'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the tasks are returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseTaskResponse'
        '400':
          description: Indicates a parameter was passed in the wrong format or that delegationState has an invalid value (other than pending and resolved). The status-message contains additional information.
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryTasks has multiple requestBodies
  /query/variable-instances:
    post:
      tags:
      - Query
      summary: Query for variable instances
      description: All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of variable instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long.
      operationId: queryVariableInstances
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VariableInstanceQueryRequest'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the tasks are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseVariableInstanceResponse'
        '400':
          description: Indicates an parameter was passed in the wrong format. The status-message contains additional information.
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryVariableInstances has multiple requestBodies
  /cmmn-query/case-instances:
    post:
      tags:
      - Query
      summary: Query case instances
      description: 'The request body can contain all possible filters that can be used in the List case instances URL query. On top of these, it’s possible to provide an array of variables to include in the query, with their format described here.


        The general paging and sorting query-parameters can be used for this URL.'
      operationId: queryCaseInstances
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CaseInstanceQueryRequest'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the case instances are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseCaseInstanceResponse'
        '400':
          description: Indicates a parameter was passed in the wrong format . The status-message contains additional information.
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryCaseInstances has multiple requestBodies
  /cmmn-query/historic-case-instances:
    post:
      tags:
      - Query
      summary: Query for historic case instances
      description: All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic case instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The variables property is a JSON-array containing objects with the format as described here.
      operationId: queryHistoricCaseInstance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HistoricCaseInstanceQueryRequest'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the case instances are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseHistoricCaseInstanceResponse'
        '400':
          description: Indicates an parameter was passed in the wrong format. The status-message contains additional information.
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryHistoricCaseInstance has multiple requestBodies
  /cmmn-query/historic-milestone-instances:
    post:
      tags:
      - Query
      summary: Query for historic milestone instances
      description: All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic milestone instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long.
      operationId: queryHistoricMilestoneInstance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HistoricMilestoneInstanceQueryRequest'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the milestone instances are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseHistoricMilestoneInstanceResponse'
        '400':
          description: Indicates an parameter was passed in the wrong format. The status-message contains additional information.
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryHistoricMilestoneInstance has multiple requestBodies
  /cmmn-query/historic-planitem-instances:
    post:
      tags:
      - Query
      summary: Query for historic plan item instances
      description: All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic plan item instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long.
      operationId: queryHistoricPlanItemInstance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HistoricPlanItemInstanceQueryRequest'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the plan item instances are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseHistoricPlanItemInstanceResponse'
        '400':
          description: Indicates an parameter was passed in the wrong format. The status-message contains additional information.
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryHistoricPlanItemInstance has multiple requestBodies
  /cmmn-query/historic-task-instances:
    post:
      tags:
      - Query
      summary: Query for historic task instances
      description: All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic task instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The taskVariables and processVariables properties are JSON-arrays containing objects with the format as described here.
      operationId: queryHistoricTaskInstance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HistoricTaskInstanceQueryRequest_2'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the tasks are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseHistoricTaskInstanceResponse'
        '404':
          description: Indicates an parameter was passed in the wrong format. The status-message contains additional information.
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryHistoricTaskInstance has multiple requestBodies
  /cmmn-query/historic-variable-instances:
    post:
      tags:
      - Query
      summary: Query for historic variable instances
      description: All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic process instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The variables property is a JSON-array containing objects with the format as described here.
      operationId: queryVariableInstances
      parameters:
      - name: sort
        in: query
        description: The field to sort by. Defaults to 'variableName'.
        required: false
        schema:
          type: string
          enum:
          - caseInstanceId
          - variableName
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HistoricVariableInstanceQueryRequest_2'
      responses:
        '200':
          description: Indicates request was successful and the tasks are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseHistoricVariableInstanceResponse'
        '400':
          description: Indicates an parameter was passed in the wrong format. The status-message contains additional information.
      security:
      - basicAuth: []
  /cmmn-query/plan-item-instances:
    post:
      tags:
      - Query
      summary: Query plan item instances
      description: 'The request body can contain all possible filters that can be used in the List plan item instances URL query. On top of these, it’s possible to provide an array of variables and caseInstanceVariables to include in the query, with their format described here.


        The general paging and sorting query-parameters can be used for this URL.'
      operationId: queryPlanItemInstances
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlanItemInstanceQueryRequest'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the plan item instances are returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponsePlanItemInstanceResponse'
        '404':
          description: Indicates a parameter was passed in the wrong format. The status message contains additional information.
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryPlanItemInstances has multiple requestBodies
  /cmmn-query/tasks:
    post:
      tags:
      - Query
      summary: Query for tasks
      description: All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of tasks (except for candidateGroupIn which is only available in this POST task query REST service), but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on task and process variables. The taskVariables and processInstanceVariables are both JSON-arrays containing objects with the format as described here.
      operationId: queryTasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskQueryRequest_2'
        x-s2o-overloaded: true
      responses:
        '200':
          description: Indicates request was successful and the tasks are returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseTaskResponse'
        '400':
          description: Indicates a parameter was passed in the wrong format or that delegationState has an invalid value (other than pending and resolved). The status-message contains additional information.
      security:
      - basicAuth: []
      x-s2o-warning: Operation queryTasks has multiple requestBodies
  /cmmn-query/variable-instances:
    post:
      tags:
      - Query
      summary: Query for variable instances
      description: 'All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of variable instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. '
      operationId: queryVariableInstances
      parameters:
      - name: sort
        in: query
        description: The field to sort by. Defaults to 'variableName'.
        required: false
        schema:
          type: string
          enum:
          - caseInstanceId
          - variableName
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VariableInstanceQueryRequest_2'
      responses:
        '200':
          description: Indicates request was successful and the tasks are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseVariableInstanceResponse'
        '400':
          description: Indicates an parameter was passed in the wrong format. The status-message contains additional information.
      security:
      - basicAuth: []
  /query/rendition-items:
    post:
      tags:
      - Query
      summary: Query for rendition items
      description: All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of rendition items, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long.
      operationId: getQueryResult
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenditionItemQueryRequest'
      responses:
        '200':
          description: Indicates request was successful and the rendition items are returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseRenditionItemResponse'
        '400':
          description: Indicates a parameter was passed in the wrong format. The status-message contains additional information.
      security:
      - basicAuth: []
  /query/form-instances:
    post:
      tags:
      - Query
      summary: Query form instances
      description: 'The request body can contain all possible filters that can be used in the List form instances URL query. On top of these, it’s possible to provide an array of variables to include in the query, with their format described here.


        The general paging and sorting query-parameters can be used for this URL.'
      operationId: queryFormInstances
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormInstanceQueryRequest'
      responses:
        '200':
          description: Indicates request was successful and the form instances are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseFormInstanceResponse'
        '400':
          description: Indicates a parameter was passed in the wrong format . The status-message contains additional information.
      security:
      - basicAuth: []
  /query/groups:
    post:
      tags:
      - Query
      summary: Query groups
      description: ''
      operationId: queryGroups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupQueryRequest'
        description: Group request
      responses:
        '200':
          description: Indicates the requested groups were returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseGroupResponse'
      security:
      - basicAuth: []
  /query/users:
    post:
      tags:
      - Query
      summary: Query users
      description: ''
      operationId: queryUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserBodyQueryRequest'
        description: User request
      responses:
        '200':
          description: Indicates the request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponsePlatformUserResponse'
        '400':
          description: Indicates the request body is incomplete or contains illegal values.
        '403':
          description: Indicates the user does not have the rights to view the users.
      security:
      - basicAuth: []
components:
  schemas:
    HistoricVariableInstanceResponse:
      type: object
      properties:
        id:
          type: string
          example: '14'
        processInstanceId:
          type: string
          example: '5'
        processInstanceUrl:
          type: string
          example: http://localhost:8182/history/historic-process-instances/5
        taskId:
          type: string
          example: '6'
        executionId:
          type: string
        variable:
          $ref: '#/components/schemas/RestVariable'
    UserBodyQueryRequest:
      type: object
      properties:
        start:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
        sort:
          type: string
        order:
          type: string
        id:
          type: string
          description: Only return users with the given id
        ids:
          type: array
          description: Only return users that match the given ids
          items:
            type: string
        idsNotIn:
          type: array
          description: Only return users that do not match the given ids
          items:
            type: string
        firstName:
          type: string
          description: Only return users with the given first name
        firstNameLike:
          type: string
          description: Only return users with first name like the given value
        firstNameLikeIgnoreCase:
          type: string
          description: Only return users with first name like the given value ignoring case
        lastName:
          type: string
          description: Only return users with the given last name
        lastNameLike:
          type: string
          description: Only return users with last name like the given value
        lastNameLikeIgnoreCase:
          type: string
          description: Only return users with last name like the given value ignoring case
        displayName:
          type: string
          description: Only return users with the given display name
        displayNameLike:
          type: string
          description: Only return users with display name like the given value
        displayNameLikeIgnoreCase:
          type: string
          description: Only return users with display name like the given value ignoring case
        fullNameLike:
          type: string
          description: Only return users with full name like the given value
        fullNameLikeIgnoreCase:
          type: string
          description: Only return users with full name like the given value ignoring case
        email:
          type: string
          description: Only return users with the given email
        emailLike:
          type: string
          description: Only return users with email like the given value
        state:
          type: string
          description: Only return users with the given state
        subState:
          type: string
          description: Only return users with the given sub state
        memberOfGroup:
          type: string
          description: Only return users that are member of the given group
        memberOfGroups:
          type: array
          description: Only return users that are member of any of th

# --- truncated at 32 KB (120 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flowable/refs/heads/main/openapi/flowable-query-api-openapi.yml