---
title: "Get a form instance model"
method: POST
path: "/form/form-instance-model"
tags: ["Form Instance Models"]
---

# Get a form instance model

`POST /form/form-instance-model`

## Request

- Base URL: `http://localhost:8090/form-api`
- URL: `http://localhost:8090/form-api/form/form-instance-model`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/flowable/apis/flowable-form-rest-api/docs/form/form-instance-model/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- FormRequest
  - `formInstanceId` string
  - `formDefinitionId` string
  - `formDefinitionKey` string
  - `taskId` string
  - `processInstanceId` string
  - `processDefinitionId` string
  - `scopeId` string
  - `scopeType` string
  - `scopeDefinitionId` string
  - `outcome` string
  - `tenantId` string
  - `parentDeploymentId` string
  - `variables` object

## Response `200`

Indicates the form instance was found and the model is returned.

- FormInstanceModelResponse
  - `id` string
  - `name` string
  - `description` string
  - `key` string
  - `version` integer
  - `formInstanceId` string
  - `submittedBy` string
  - `submittedDate` string, date-time
  - `selectedOutcome` string
  - `taskId` string
  - `processInstanceId` string
  - `processDefinitionId` string
  - `tenantId` string
  - `url` string
  - `formKey` string
  - `dialogSize` string
  - `dialogTitle` string
  - `dialogDescription` string
  - `forceValidation` boolean
  - `defaultDateFormat` string
  - `defaultNumberFormat` string
  - `rows` RowDefinition[]
    - `cols` object[]
  - `metadata` MetadataDefinition
    - `key` string
    - `name` string
    - `description` string
    - `version` string
    - `modelType` string
    - `flowableDesignVersion` integer
  - `section` SectionDefinition
    - `name` string
    - `visibility` string
  - `outcomes` OutcomeDefinition[]
    - `label` string
    - `value` string
    - `visible` string
    - `enabled` string
    - `primary` string
    - `ignorePayload` boolean
    - `ignoreValidation` boolean
    - `hideErrors` boolean
    - `styleClass` string
    - `navigationUrl` string
    - `outcomeFormKey` string
    - `i18n` object
  - `customValidations` CustomValidationDefinition[]
    - `expression` string
    - `errorMsg` string
    - `i18n` object

## Other responses

- `404`: Indicates the form instance was not found.

---

[API](https://skmtc.dev/flowable/apis/flowable-form-rest-api.md) - [All operations](https://skmtc.dev/flowable/apis/flowable-form-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/flowable/apis/flowable-form-rest-api/revisions/e581eab990c1?raw)