Flowable Plan Item Instance Variables API

The Plan Item Instance Variables API from Flowable — 1 operation(s) for plan item instance variables.

OpenAPI Specification

flowable-plan-item-instance-variables-api-openapi.yml Raw ↑
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 Plan Item Instance Variables 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: Plan Item Instance Variables
paths:
  /cmmn-runtime/plan-item-instances/{planItemInstanceId}/variables/{variableName}/data:
    get:
      tags:
      - Plan Item Instance Variables
      summary: Get the binary data for a variable
      description: ''
      operationId: getPlanItemInstanceVariableData
      parameters:
      - name: planItemInstanceId
        in: path
        required: true
        schema:
          type: string
      - name: variableName
        in: path
        required: true
        schema:
          type: string
      - name: scope
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Indicates the plan item instance was found and the requested variables are returned.
          content:
            '*/*':
              schema:
                type: array
                items:
                  type: string
                  format: byte
        '404':
          description: Indicates the requested plan item was not found or the plan item does not have a variable with the given name (in the given scope). Status message provides additional information.
      security:
      - basicAuth: []
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic