Flowable

Flowable Form Instance Models API

The Form Instance Models API from Flowable — 1 operation(s) for form instance models.

Documentation GitHub OpenAPI

Operations 1

POST /form/form-instance-model Get a form instance model #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/flowable-form-instance-models-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: '# flowable / flowəb(ə)l /


    - a compact and highly efficient workflow and Business Process Management (BPM) platform for developers, system admins and business users.

    - 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.

    - 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 Form Instance Models 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: Form Instance Models
paths:
  /form/form-instance-model:
    post:
      tags:
      - Form Instance Models
      summary: Get a form instance model
      description: ''
      operationId: getFormInstanceModel
      requestBody:
        $ref: '#/components/requestBodies/FormRequest'
      responses:
        '200':
          description: Indicates the form instance was found and the model is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormInstanceModelResponse'
        '404':
          description: Indicates the form instance was not found.
      security:
      - basicAuth: []
components:
  schemas:
    RowDefinition:
      type: object
      properties:
        cols:
          type: array
          items:
            type: object
            additionalProperties:
              type: object
    OutcomeDefinition:
      type: object
      properties:
        label:
          type: string
        value:
          type: string
        visible:
          type: string
        enabled:
          type: string
        primary:
          type: string
        ignorePayload:
          type: boolean
        ignoreValidation:
          type: boolean
        hideErrors:
          type: boolean
        styleClass:
          type: string
        navigationUrl:
          type: string
        outcomeFormKey:
          type: string
        i18n:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
    FormInstanceModelResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        key:
          type: string
        version:
          type: integer
          format: int32
        formInstanceId:
          type: string
        submittedBy:
          type: string
        submittedDate:
          type: string
          format: date-time
        selectedOutcome:
          type: string
        taskId:
          type: string
        processInstanceId:
          type: string
        processDefinitionId:
          type: string
        tenantId:
          type: string
        url:
          type: string
        formKey:
          type: string
        dialogSize:
          type: string
        dialogTitle:
          type: string
        dialogDescription:
          type: string
        forceValidation:
          type: boolean
        defaultDateFormat:
          type: string
        defaultNumberFormat:
          type: string
        rows:
          type: array
          items:
            $ref: '#/components/schemas/RowDefinition'
        metadata:
          $ref: '#/components/schemas/MetadataDefinition'
        section:
          $ref: '#/components/schemas/SectionDefinition'
        outcomes:
          type: array
          items:
            $ref: '#/components/schemas/OutcomeDefinition'
        customValidations:
          type: array
          items:
            $ref: '#/components/schemas/CustomValidationDefinition'
    MetadataDefinition:
      type: object
      properties:
        key:
          type: string
        name:
          type: string
        description:
          type: string
        version:
          type: string
        modelType:
          type: string
        flowableDesignVersion:
          type: integer
          format: int32
    FormRequest:
      type: object
      properties:
        formInstanceId:
          type: string
        formDefinitionId:
          type: string
        formDefinitionKey:
          type: string
        taskId:
          type: string
        processInstanceId:
          type: string
        processDefinitionId:
          type: string
        scopeId:
          type: string
        scopeType:
          type: string
        scopeDefinitionId:
          type: string
        outcome:
          type: string
        tenantId:
          type: string
        parentDeploymentId:
          type: string
        variables:
          type: object
          additionalProperties:
            type: object
    CustomValidationDefinition:
      type: object
      properties:
        expression:
          type: string
        errorMsg:
          type: string
        i18n:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
    SectionDefinition:
      type: object
      properties:
        name:
          type: string
        visibility:
          type: string
  requestBodies:
    FormRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FormRequest'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic