Flowable · Schema
Flowable FORM API Schemas
JSON Schema definitions extracted from the Flowable FORM OpenAPI specification
BPMBusiness Process ManagementWorkflowBPMNCMMNDMNProcess AutomationCase ManagementOpen SourceREST API
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Flowable FORM API Schemas",
"description": "JSON Schema definitions extracted from the Flowable FORM OpenAPI specification",
"definitions": {
"ButtonModelResponse": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"CustomValidationDefinition": {
"type": "object",
"properties": {
"expression": {
"type": "string"
},
"errorMsg": {
"type": "string"
},
"i18n": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
},
"DataResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"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"
}
}
},
"DataResponseFormDeploymentResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FormDeploymentResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseFormInstanceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FormInstanceResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"EngineInfoResponse": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "default"
},
"resourceUrl": {
"type": "string",
"example": "file://flowable/flowable.cfg.xml"
},
"exception": {
"type": "string",
"example": "null"
},
"version": {
"type": "string",
"example": "6.3.1"
}
}
},
"EventDefinition": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"eventType": {
"type": "string"
},
"implementationType": {
"type": "string"
},
"expression": {
"type": "string"
},
"resultVariable": {
"type": "string"
}
}
},
"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"
}
}
},
"FormDeploymentResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "10"
},
"name": {
"type": "string",
"example": "flowable-form-examples"
},
"deploymentTime": {
"type": "string",
"format": "date-time",
"example": "2010-10-13T14:54:26.750+02:00"
},
"category": {
"type": "string",
"example": "examples"
},
"url": {
"type": "string",
"example": "http://localhost:8081/form-api/form-repository/deployments/10"
},
"parentDeploymentId": {
"type": "string",
"example": "5"
},
"tenantId": {
"type": "string",
"example": "null"
}
}
},
"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"
}
}
}
},
"FormInstanceQueryRequest": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"format": "int32"
},
"size": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"id": {
"type": "string"
},
"formDefinitionId": {
"type": "string"
},
"formDefinitionIdLike": {
"type": "string"
},
"taskId": {
"type": "string"
},
"taskIdLike": {
"type": "string"
},
"processInstanceId": {
"type": "string"
},
"processInstanceIdLike": {
"type": "string"
},
"processDefinitionId": {
"type": "string"
},
"processDefinitionIdLike": {
"type": "string"
},
"scopeId": {
"type": "string"
},
"scopeType": {
"type": "string"
},
"scopeDefinitionId": {
"type": "string"
},
"submittedBy": {
"type": "string"
},
"submittedByLike": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"tenantIdLike": {
"type": "string"
},
"withoutTenantId": {
"type": "boolean"
}
}
},
"FormInstanceResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "48b9ac82-f1d3-11e6-8549-acde48001122"
},
"formDefinitionId": {
"type": "string",
"example": "818e4703-f1d2-11e6-8549-acde48001122"
},
"taskId": {
"type": "string",
"example": "88"
},
"processInstanceId": {
"type": "string",
"example": "66"
},
"processDefinitionId": {
"type": "string",
"example": "oneTaskProcess:1:158"
},
"submittedDate": {
"type": "string",
"format": "date-time",
"example": "2013-04-17T10:17:43.902+0000"
},
"submittedBy": {
"type": "string",
"example": "testUser"
},
"formValuesId": {
"type": "string",
"example": "818e4703-f1d2-11e6-8549-acde48001110"
},
"tenantId": {
"type": "string",
"example": "null"
},
"url": {
"type": "string",
"example": "http://localhost:8182/form/form-instances/48b9ac82-f1d3-11e6-8549-acde48001122"
},
"scopeId": {
"type": "string",
"example": "66"
},
"scopeType": {
"type": "string",
"example": "CAS-d6d53baa-2618-11e9-895e-aee50c200f02"
},
"scopeDefinitionId": {
"type": "string",
"example": "CAS-d6d53baa-2618-11e9-895e-aee50c200f02"
}
}
},
"FormModel": {
"type": "object"
},
"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"
}
}
}
},
"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"
}
}
}
},
"MetadataDefinition": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"version": {
"type": "string"
},
"modelType": {
"type": "string"
},
"flowableDesignVersion": {
"type": "integer",
"format": "int32"
}
}
},
"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"
}
}
}
}
},
"RowDefinition": {
"type": "object",
"properties": {
"cols": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
},
"SectionDefinition": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"visibility": {
"type": "string"
}
}
}
}
}