Flowable Form Definitions 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 Form Definitions 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 Definitions
paths:
  /form-repository/button-definitions/key/{formDefinitionKey}/model:
    get:
      tags:
      - Form Definitions
      summary: Get a form definition Form model by form definition key with only buttons
      description: ''
      operationId: getFormDefinitionButtonsByKey
      parameters:
      - name: formDefinitionKey
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Indicates the form definition Form model was found returned.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ButtonModelResponse'
        '404':
          description: Indicates the form definition Form model was not found.
      security:
      - basicAuth: []
  /form-repository/form-definitions:
    get:
      tags:
      - Form Definitions
      summary: List of form definitions
      description: ''
      operationId: listFormDefinitions
      parameters:
      - name: category
        in: query
        description: Only return form definitions with the given category.
        required: false
        schema:
          type: string
      - name: categoryLike
        in: query
        description: Only return form definitions with a category like the given value.
        required: false
        schema:
          type: string
      - name: categoryNotEquals
        in: query
        description: Only return form definitions not with the given category.
        required: false
        schema:
          type: string
      - name: key
        in: query
        description: Only return form definitions with the given key.
        required: false
        schema:
          type: string
      - name: keyLike
        in: query
        description: Only return form definitions with a key like the given value.
        required: false
        schema:
          type: string
      - name: name
        in: query
        description: Only return form definitions with the given name.
        required: false
        schema:
          type: string
      - name: nameLike
        in: query
        description: Only return form definitions with a name like the given value.
        required: false
        schema:
          type: string
      - name: resourceName
        in: query
        description: Only return form definitions with the given resource name.
        required: false
        schema:
          type: string
      - name: resourceNameLike
        in: query
        description: Only return form definitions a resource name like the given value.
        required: false
        schema:
          type: string
      - name: version
        in: query
        description: Only return form definitions with the given version.
        required: false
        schema:
          type: string
      - name: versionGreaterThan
        in: query
        description: Only return form definitions with a version greater than the given value.
        required: false
        schema:
          type: string
      - name: versionGreaterThanOrEquals
        in: query
        description: Only return form definitions with a version greater than or equal to the given value.
        required: false
        schema:
          type: string
      - name: versionLowerThan
        in: query
        description: Only return form definitions with a version lower than the given value.
        required: false
        schema:
          type: string
      - name: versionLowerThanOrEquals
        in: query
        description: Only return form definitions with a version lower than or equal to the given value.
        required: false
        schema:
          type: string
      - name: deploymentId
        in: query
        description: Only return form definitions with the given deployment id.
        required: false
        schema:
          type: string
      - name: parentDeploymentId
        in: query
        description: Only return form definitions with the given parent deployment id.
        required: false
        schema:
          type: string
      - name: tenantId
        in: query
        description: Only return form definitions with the given tenant id.
        required: false
        schema:
          type: string
      - name: tenantIdLike
        in: query
        description: Only return form definitions with a tenant id like the given value.
        required: false
        schema:
          type: string
      - name: withoutTenantId
        in: query
        description: Only return form definitions without a tenant id.
        required: false
        schema:
          type: string
      - name: latest
        in: query
        description: If true; only the latest versions will be returned.
        required: false
        schema:
          type: boolean
      - name: sort
        in: query
        description: Property to sort on, to be used together with the order.
        required: false
        schema:
          type: string
          enum:
          - key
          - category
          - id
          - version
          - name
          - deploymentId
          - tenantId
      responses:
        '200':
          description: Indicates request was successful and the form definitions are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseFormDefinitionResponse'
        '400':
          description: Indicates a parameter was passed in the wrong format . The status-message contains additional information.
      security:
      - basicAuth: []
  /form-repository/form-definitions/key/{formDefinitionKey}/model:
    get:
      tags:
      - Form Definitions
      summary: Get a form definition Form model by form definition key
      description: ''
      operationId: getFormDefinitionFormModelByKey
      parameters:
      - name: formDefinitionKey
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Indicates the form definition Form model was found returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormModelResponse'
        '404':
          description: Indicates the form definition Form model was not found.
      security:
      - basicAuth: []
  /form-repository/form-definitions/{formDefinitionId}:
    get:
      tags:
      - Form Definitions
      summary: Get a form definition
      description: ''
      operationId: getForm
      parameters:
      - name: formDefinitionId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Indicates the form definition was found returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormDefinitionResponse'
        '404':
          description: Indicates the form definition was not found.
      security:
      - basicAuth: []
  /form-repository/form-definitions/{formDefinitionId}/model:
    get:
      tags:
      - Form Definitions
      summary: Get a form definition Form model
      description: ''
      operationId: getFormDefinitionFormModel
      parameters:
      - name: formDefinitionId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Indicates the form definition Form model was found returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormModelResponse'
        '404':
          description: Indicates the form definition Form model was not found.
      security:
      - basicAuth: []
  /form-repository/form-definitions/{formDefinitionId}/resourcedata:
    get:
      tags:
      - Form Definitions
      summary: Get a form definition resource content
      description: ''
      operationId: getFormDefinitionContent
      parameters:
      - name: formDefinitionId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Indicates both form definition and resource have been found and the resource data has been returned.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                  format: byte
        '404':
          description: Indicates the requested form definition was not found or there is no resource with the given id present in the process definition. The status-description contains additional information.
      security:
      - basicAuth: []
components:
  schemas:
    FormDefinitionResponse:
      type: object
      properties:
        id:
          type: string
          example: '10'
        url:
          type: string
          example: http://localhost:8182/form-repository/form-definitions/simpleForm
        category:
          type: string
          example: Examples
        name:
          type: string
          example: The Simple Form
        key:
          type: string
          example: simpleForm
        description:
          type: string
          example: This is a form for testing purposes
        version:
          type: integer
          format: int32
          example: 1
        resourceName:
          type: string
          example: SimpleSourceName
        deploymentId:
          type: string
          example: 818e4703-f1d2-11e6-8549-acde48001121
        tenantId:
          type: string
          example: 'null'
    DataResponseFormDefinitionResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/FormDefinitionResponse'
        total:
          type: integer
          format: int64
        start:
          type: integer
          format: int32
        sort:
          type: string
        order:
          type: string
        size:
          type: integer
          format: int32
    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
    FormModelResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        key:
          type: string
        version:
          type: integer
          format: int32
        formModel:
          $ref: '#/components/schemas/FormModel'
        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'
        formModelEvents:
          type: array
          items:
            $ref: '#/components/schemas/EventDefinition'
        customValidations:
          type: array
          items:
            $ref: '#/components/schemas/CustomValidationDefinition'
    FormModel:
      type: object
    MetadataDefinition:
      type: object
      properties:
        key:
          type: string
        name:
          type: string
        description:
          type: string
        version:
          type: string
        modelType:
          type: string
        flowableDesignVersion:
          type: integer
          format: int32
    RowDefinition:
      type: object
      properties:
        cols:
          type: array
          items:
            type: object
            additionalProperties:
              type: object
    ButtonModelResponse:
      type: object
      properties:
        label:
          type: string
        value:
          type: string
    EventDefinition:
      type: object
      properties:
        id:
          type: string
        eventType:
          type: string
        implementationType:
          type: string
        expression:
          type: string
        resultVariable:
          type: string
    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
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic