Flowable History PlanItem 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 History PlanItem 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: History PlanItem
paths:
  /cmmn-history/historic-planitem-instances:
    get:
      tags:
      - History PlanItem
      summary: List of historic plan item instances
      description: ''
      operationId: listHistoricPlanItemInstances
      parameters:
      - name: planItemInstanceId
        in: query
        description: The id of the historic planItem instance.
        required: false
        schema:
          type: string
      - name: planItemInstanceName
        in: query
        description: The name of the historic planItem instance.
        required: false
        schema:
          type: string
      - name: planItemInstanceState
        in: query
        description: The state of the historic planItem instance.
        required: false
        schema:
          type: string
      - name: caseDefinitionId
        in: query
        description: The id of the definition of the case were the historic planItem instance is defined.
        required: false
        schema:
          type: string
      - name: caseInstanceId
        in: query
        description: The id of the case instance were the historic planItem instance existed.
        required: false
        schema:
          type: string
      - name: caseInstanceIds
        in: query
        description: The ids of the case instances were the historic planItem instance existed.
        required: false
        schema:
          type: string
      - name: stageInstanceId
        in: query
        description: The id of the stage were the historic planItem instance was contained.
        required: false
        schema:
          type: string
      - name: elementId
        in: query
        description: The id of the planItem model of the historic planItem instance.
        required: false
        schema:
          type: string
      - name: planItemDefinitionId
        in: query
        description: The id of the planItem model definition of the historic planItem instance.
        required: false
        schema:
          type: string
      - name: planItemDefinitionType
        in: query
        description: The type of planItem of the historic planItem instance.
        required: false
        schema:
          type: string
      - name: createdBefore
        in: query
        description: Return only historic planItem instances that were created before this date.
        required: false
        schema:
          type: date-time
      - name: createdAfter
        in: query
        description: Return only historic planItem instances that were created after this date.
        required: false
        schema:
          type: date-time
      - name: lastAvailableBefore
        in: query
        description: Return only historic planItem instances that were last in available before this date.
        required: false
        schema:
          type: date-time
      - name: lastAvailableAfter
        in: query
        description: Return only historic planItem instances that were last in available state after this date.
        required: false
        schema:
          type: date-time
      - name: lastEnabledBefore
        in: query
        description: Return only historic planItem instances that were last in enabled state before this date.
        required: false
        schema:
          type: date-time
      - name: lastEnabledAfter
        in: query
        description: Return only historic planItem instances that were last in enabled state after this date.
        required: false
        schema:
          type: date-time
      - name: lastDisabledBefore
        in: query
        description: Return only historic planItem instances that were last in disable state before this date.
        required: false
        schema:
          type: date-time
      - name: lastDisabledAfter
        in: query
        description: Return only historic planItem instances that were last in disabled state after this date.
        required: false
        schema:
          type: date-time
      - name: lastStartedBefore
        in: query
        description: Return only historic planItem instances that were last in active state before this date.
        required: false
        schema:
          type: date-time
      - name: lastStartedAfter
        in: query
        description: Return only historic planItem instances that were last in active state after this date.
        required: false
        schema:
          type: date-time
      - name: lastSuspendedBefore
        in: query
        description: Return only historic planItem instances that were last in suspended state before this date.
        required: false
        schema:
          type: date-time
      - name: lastSuspendedAfter
        in: query
        description: Return only historic planItem instances that were last in suspended state after this date.
        required: false
        schema:
          type: date-time
      - name: completedBefore
        in: query
        description: Return only historic planItem instances that were completed before this date.
        required: false
        schema:
          type: date-time
      - name: completedAfter
        in: query
        description: Return only historic planItem instances that were completed after this date.
        required: false
        schema:
          type: date-time
      - name: terminatedBefore
        in: query
        description: Return only historic planItem instances that were terminated before this date.
        required: false
        schema:
          type: date-time
      - name: terminatedAfter
        in: query
        description: Return only historic planItem instances that were terminated after this date.
        required: false
        schema:
          type: date-time
      - name: occurredBefore
        in: query
        description: Return only historic planItem instances that occurred before this date.
        required: false
        schema:
          type: date-time
      - name: occurredAfter
        in: query
        description: Return only historic planItem instances that occurred after after this date.
        required: false
        schema:
          type: date-time
      - name: exitBefore
        in: query
        description: Return only historic planItem instances that exit before this date.
        required: false
        schema:
          type: date-time
      - name: exitAfter
        in: query
        description: Return only historic planItem instances that exit after this date.
        required: false
        schema:
          type: date-time
          format: date-time
      - name: endedBefore
        in: query
        description: Return only historic planItem instances that ended before this date.
        required: false
        schema:
          type: date-time
          format: date-time
      - name: endedAfter
        in: query
        description: Return only historic planItem instances that ended after this date.
        required: false
        schema:
          type: date-time
          format: date-time
      - name: startUserId
        in: query
        description: Return only historic planItem instances that were started by this user.
        required: false
        schema:
          type: string
          format: date-time
      - name: referenceId
        in: query
        description: The id of process that was referenced by this historic planItem instance.
        required: false
        schema:
          type: string
      - name: referenceType
        in: query
        description: The type of reference to the process referenced by this historic planItem instance.
        required: false
        schema:
          type: string
      - name: tenantId
        in: query
        description: Only return instances with the given tenantId.
        required: false
        schema:
          type: string
      - name: withoutTenantId
        in: query
        description: 'If true, only returns instances without a tenantId set. If false, the withoutTenantId parameter is ignored.

          '
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Indicates that historic planItem instances could be queried.
          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: []
  /cmmn-history/historic-planitem-instances/{planItemInstanceId}:
    get:
      tags:
      - History PlanItem
      summary: Get a historic plan item instance
      description: ''
      operationId: getHistoricPlanItemInstance
      parameters:
      - name: planItemInstanceId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Indicates that the historic plan item instances could be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HistoricPlanItemInstanceResponse'
        '404':
          description: Indicates that the historic plan item instances could not be found.
      security:
      - basicAuth: []
  /cmmn-query/historic-planitem-instances:
    post:
      tags:
      - History PlanItem
      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
components:
  schemas:
    DataResponseHistoricPlanItemInstanceResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/HistoricPlanItemInstanceResponse'
        total:
          type: integer
          format: int64
        start:
          type: integer
          format: int32
        sort:
          type: string
        order:
          type: string
        size:
          type: integer
          format: int32
    RestVariable:
      type: object
      properties:
        name:
          type: string
          example: myVariable
          description: Name of the variable
        type:
          type: string
          example: string
          description: Type of the variable.
        value:
          type: object
          example: test
          description: Value of the variable.
        valueUrl:
          type: string
          example: http://....
        scope:
          type: string
    HistoricPlanItemInstanceResponse:
      type: object
      properties:
        id:
          type: string
          example: '5'
        name:
          type: string
          example: myPlanItemName
        state:
          type: string
          example: completed
        caseDefinitionId:
          type: string
          example: myCaseId%3A1%3A4
        derivedCaseDefinitionId:
          type: string
        caseInstanceId:
          type: string
          example: '12345'
        stageInstanceId:
          type: string
          example: stageId
        stage:
          type: boolean
          example: true
        elementId:
          type: string
          example: someElementId
        planItemDefinitionId:
          type: string
          example: someId
        planItemDefinitionType:
          type: string
          example: timerEventListener
        createTime:
          type: string
          format: date-time
          example: 2013-04-17T10:17:43.902+0000
        lastAvailableTime:
          type: string
          format: date-time
          example: 2013-04-17T10:17:43.902+0000
        lastEnabledTime:
          type: string
          format: date-time
          example: 2013-04-17T10:17:43.902+0000
        lastDisabledTime:
          type: string
          format: date-time
          example: 2013-04-17T10:17:43.902+0000
        lastStartedTime:
          type: string
          format: date-time
          example: 2013-04-17T10:17:43.902+0000
        lastSuspendedTime:
          type: string
          format: date-time
          example: 2013-04-17T10:17:43.902+0000
        completedTime:
          type: string
          format: date-time
          example: 2013-04-17T10:17:43.902+0000
        occurredTime:
          type: string
          format: date-time
          example: 2013-04-17T10:17:43.902+0000
        terminatedTime:
          type: string
          format: date-time
          example: 2013-04-17T10:17:43.902+0000
        exitTime:
          type: string
          format: date-time
          example: 2013-04-17T10:17:43.902+0000
        endedTime:
          type: string
          format: date-time
          example: 2013-04-17T10:17:43.902+0000
        lastUpdatedTime:
          type: string
          format: date-time
        startUserId:
          type: string
          example: kermit
        assignee:
          type: string
        completedBy:
          type: string
        referenceId:
          type: string
          example: referenceId
        referenceType:
          type: string
          example: referenceType
        entryCriterionId:
          type: string
        exitCriterionId:
          type: string
        formKey:
          type: string
        extraValue:
          type: string
        showInOverview:
          type: boolean
        tenantId:
          type: string
          example: 'null'
        url:
          type: string
          example: http://localhost:8182/cmmn-history/historic-planitem-instances/5
        caseInstanceUrl:
          type: string
          example: http://localhost:8182/cmmn-history/historic-case-instances/12345
        caseDefinitionUrl:
          type: string
          example: http://localhost:8182/cmmn-repository/case-definitions/myCaseId%3A1%3A4
        derivedCaseDefinitionUrl:
          type: string
        stageInstanceUrl:
          type: string
        localVariables:
          type: array
          items:
            $ref: '#/components/schemas/RestVariable'
    HistoricPlanItemInstanceQueryRequest:
      type: object
      properties:
        start:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
        sort:
          type: string
        order:
          type: string
        planItemInstanceId:
          type: string
        planItemInstanceName:
          type: string
        planItemInstanceState:
          type: string
        caseDefinitionId:
          type: string
        caseInstanceId:
          type: string
        caseInstanceIds:
          type: array
          uniqueItems: true
          items:
            type: string
        stageInstanceId:
          type: string
        elementId:
          type: string
        planItemDefinitionId:
          type: string
        planItemDefinitionType:
          type: string
        createdBefore:
          type: string
          format: date-time
        createdAfter:
          type: string
          format: date-time
        lastAvailableBefore:
          type: string
          format: date-time
        lastAvailableAfter:
          type: string
          format: date-time
        lastEnabledBefore:
          type: string
          format: date-time
        lastEnabledAfter:
          type: string
          format: date-time
        lastDisabledBefore:
          type: string
          format: date-time
        lastDisabledAfter:
          type: string
          format: date-time
        lastStartedBefore:
          type: string
          format: date-time
        lastStartedAfter:
          type: string
          format: date-time
        lastSuspendedBefore:
          type: string
          format: date-time
        lastSuspendedAfter:
          type: string
          format: date-time
        completedBefore:
          type: string
          format: date-time
        completedAfter:
          type: string
          format: date-time
        terminatedBefore:
          type: string
          format: date-time
        terminatedAfter:
          type: string
          format: date-time
        occurredBefore:
          type: string
          format: date-time
        occurredAfter:
          type: string
          format: date-time
        exitBefore:
          type: string
          format: date-time
        exitAfter:
          type: string
          format: date-time
        endedBefore:
          type: string
          format: date-time
        endedAfter:
          type: string
          format: date-time
        startUserId:
          type: string
        referenceId:
          type: string
        referenceType:
          type: string
        tenantId:
          type: string
        withoutTenantId:
          type: boolean
        includeLocalVariables:
          type: boolean
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic