Flowable · Schema
Flowable BPMN API Schemas
JSON Schema definitions extracted from the Flowable BPMN OpenAPI specification
BPMBusiness Process ManagementWorkflowBPMNCMMNDMNProcess AutomationCase ManagementOpen SourceREST API
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Flowable BPMN API Schemas",
"description": "JSON Schema definitions extracted from the Flowable BPMN OpenAPI specification",
"definitions": {
"ActivityInstanceQueryRequest": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"format": "int32"
},
"size": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"activityId": {
"type": "string"
},
"activityInstanceId": {
"type": "string"
},
"activityName": {
"type": "string"
},
"activityType": {
"type": "string"
},
"executionId": {
"type": "string"
},
"finished": {
"type": "boolean"
},
"taskAssignee": {
"type": "string"
},
"taskCompletedBy": {
"type": "string"
},
"processInstanceId": {
"type": "string"
},
"processInstanceIds": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"processDefinitionId": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"tenantIdLike": {
"type": "string"
},
"withoutTenantId": {
"type": "boolean"
}
}
},
"ActivityInstanceQueryResource": {
"type": "object"
},
"ActivityInstanceResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "5"
},
"activityId": {
"type": "string",
"example": "4"
},
"activityName": {
"type": "string",
"example": "My user task"
},
"activityType": {
"type": "string",
"example": "userTask"
},
"processDefinitionId": {
"type": "string",
"example": "oneTaskProcess%3A1%3A4"
},
"processDefinitionUrl": {
"type": "string",
"example": "http://localhost:8182/repository/process-definitions/oneTaskProcess%3A1%3A4"
},
"processInstanceId": {
"type": "string",
"example": "3"
},
"processInstanceUrl": {
"type": "string",
"example": "http://localhost:8182/runtime/process-instances/3"
},
"executionId": {
"type": "string",
"example": "4"
},
"taskId": {
"type": "string",
"example": "4"
},
"calledProcessInstanceId": {
"type": "string",
"example": "null"
},
"assignee": {
"type": "string",
"example": "fozzie"
},
"startTime": {
"type": "string",
"format": "date-time",
"example": "2013-04-17T10:17:43.902+0000"
},
"endTime": {
"type": "string",
"format": "date-time",
"example": "2013-04-18T14:06:32.715+0000"
},
"durationInMillis": {
"type": "integer",
"format": "int64",
"example": 86400056
},
"tenantId": {
"type": "string",
"example": "null"
}
}
},
"Artifact": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"xmlRowNumber": {
"type": "integer",
"format": "int32"
},
"xmlColumnNumber": {
"type": "integer",
"format": "int32"
},
"extensionElements": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtensionElement"
}
}
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtensionAttribute"
}
}
}
}
},
"AttachmentResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"userId": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string",
"description": "Can be any arbitrary value. When a valid formatted media-type (e.g. application/xml, text/plain) is included, the binary content HTTP response content-type will be set the given value."
},
"taskUrl": {
"type": "string"
},
"processInstanceUrl": {
"type": "string"
},
"externalUrl": {
"type": "string",
"description": "contentUrl:In case the attachment is a link to an external resource, the externalUrl contains the URL to the external content. If the attachment content is present in the Flowable engine, the contentUrl will contain an URL where the binary content can be streamed from."
},
"contentUrl": {
"type": "string"
},
"time": {
"type": "string",
"format": "date-time"
}
}
},
"BaseElement": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"xmlRowNumber": {
"type": "integer",
"format": "int32"
},
"xmlColumnNumber": {
"type": "integer",
"format": "int32"
},
"extensionElements": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtensionElement"
}
}
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtensionAttribute"
}
}
}
}
},
"BatchPartResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "8"
},
"url": {
"type": "string",
"example": "http://localhost:8182/management/batch-parts/8"
},
"batchId": {
"type": "string",
"example": "4"
},
"batchUrl": {
"type": "string",
"example": "http://localhost:8182/management/batch/4"
},
"batchType": {
"type": "string",
"example": "processMigration"
},
"searchKey": {
"type": "string",
"example": "1:22:MP"
},
"searchKey2": {
"type": "string",
"example": "1:24:MP"
},
"scopeId": {
"type": "string",
"example": "1"
},
"subScopeId": {
"type": "string",
"example": "2"
},
"scopeType": {
"type": "string",
"example": "bpmn"
},
"createTime": {
"type": "string",
"format": "date-time",
"example": "2020-06-03T22:05:05.474+0000"
},
"completeTime": {
"type": "string",
"format": "date-time",
"example": "2020-06-03T22:05:05.474+0000"
},
"status": {
"type": "string",
"example": "completed"
},
"tenantId": {
"type": "string",
"example": "null"
}
}
},
"BatchResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "8"
},
"url": {
"type": "string",
"example": "http://localhost:8182/management/batches/8"
},
"batchType": {
"type": "string",
"example": "processMigration"
},
"searchKey": {
"type": "string",
"example": "1:22:MP"
},
"searchKey2": {
"type": "string",
"example": "1:24:MP"
},
"createTime": {
"type": "string",
"format": "date-time",
"example": "2020-06-03T22:05:05.474+0000"
},
"completeTime": {
"type": "string",
"format": "date-time",
"example": "2020-06-03T22:05:05.474+0000"
},
"status": {
"type": "string",
"example": "completed"
},
"tenantId": {
"type": "string",
"example": "null"
}
}
},
"BpmnDiEdge": {
"type": "object",
"properties": {
"sourceDockerInfo": {
"$ref": "#/components/schemas/GraphicInfo"
},
"targetDockerInfo": {
"$ref": "#/components/schemas/GraphicInfo"
},
"waypoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphicInfo"
}
}
}
},
"BpmnModel": {
"type": "object",
"properties": {
"definitionsAttributes": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtensionAttribute"
}
}
},
"processes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Process"
}
},
"locationMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/GraphicInfo"
}
},
"labelLocationMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/GraphicInfo"
}
},
"flowLocationMap": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphicInfo"
}
}
},
"edgeMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/BpmnDiEdge"
}
},
"signals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Signal"
}
},
"pools": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Pool"
}
},
"imports": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Import"
}
},
"interfaces": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Interface"
}
},
"globalArtifacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Artifact"
}
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource"
}
},
"targetNamespace": {
"type": "string"
},
"sourceSystemId": {
"type": "string"
},
"userTaskFormTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"startEventFormTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"exporter": {
"type": "string"
},
"exporterVersion": {
"type": "string"
},
"mainProcess": {
"$ref": "#/components/schemas/Process"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Message"
}
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"escalations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Escalation"
}
},
"dataStores": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/DataStore"
}
},
"namespaces": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"messageFlows": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/MessageFlow"
}
},
"itemDefinitions": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ItemDefinition"
}
}
}
},
"BulkDeleteInstancesRestActionRequest": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"instanceIds": {
"type": "array",
"items": {
"type": "string"
}
},
"deleteReason": {
"type": "string"
}
}
},
"BulkMoveDeadLetterActionRequest": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"jobIds": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"BulkTasksRequest": {
"type": "object",
"properties": {
"owner": {
"type": "string"
},
"assignee": {
"type": "string"
},
"delegationState": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"dueDate": {
"type": "string",
"format": "date-time"
},
"priority": {
"type": "integer",
"format": "int32"
},
"parentTaskId": {
"type": "string"
},
"category": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"formKey": {
"type": "string"
},
"ownerSet": {
"type": "boolean"
},
"assigneeSet": {
"type": "boolean"
},
"delegationStateSet": {
"type": "boolean"
},
"nameSet": {
"type": "boolean"
},
"descriptionSet": {
"type": "boolean"
},
"duedateSet": {
"type": "boolean"
},
"prioritySet": {
"type": "boolean"
},
"parentTaskIdSet": {
"type": "boolean"
},
"categorySet": {
"type": "boolean"
},
"tenantIdSet": {
"type": "boolean"
},
"formKeySet": {
"type": "boolean"
},
"taskIds": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CommentRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"author": {
"type": "string"
},
"message": {
"type": "string"
},
"type": {
"type": "string"
},
"saveProcessInstanceId": {
"type": "boolean"
}
}
},
"CommentResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"author": {
"type": "string"
},
"message": {
"type": "string"
},
"time": {
"type": "string",
"format": "date-time"
},
"taskId": {
"type": "string"
},
"taskUrl": {
"type": "string"
},
"processInstanceId": {
"type": "string"
},
"processInstanceUrl": {
"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"
}
}
},
"DataResponseActivityInstanceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActivityInstanceResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseBatchResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseDeploymentResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeploymentResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseEventSubscriptionResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventSubscriptionResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseExecutionResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExecutionResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseGroupResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseHistoricActivityInstanceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoricActivityInstanceResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseHistoricDetailResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoricDetailResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseHistoricProcessInstanceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoricProcessInstanceResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseHistoricTaskInstanceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoricTaskInstanceResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseHistoricTaskLogEntryResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoricTaskLogEntryResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseHistoricVariableInstanceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoricVariableInstanceResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseHistoryJobResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryJobResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseJobResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseListMapStringObject": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseModelResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseProcessDefinitionResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProcessDefinitionResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseProcessInstanceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProcessInstanceResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseTaskResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseUserResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseVariableInstanceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VariableInstanceResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataSpec": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"xmlRowNumber": {
"type": "integer",
"format": "int32"
},
"xmlColumnNumber": {
"type": "integer",
"format": "int32"
},
"extensionElements": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtensionElement"
}
}
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtensionAttribute"
}
}
},
"name": {
"type": "string"
},
"itemSubjectRef": {
"type": "string"
},
"collection": {
"type": "boolean"
}
}
},
"DataStore": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"xmlRowNumber": {
"type": "integer",
"format": "int32"
},
"xmlColumnNumber": {
"type": "integer",
"format": "int32"
},
"extensionElements": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtensionElement"
}
}
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtensionAttribute"
}
}
},
"name": {
"type": "string"
},
"dataState": {
"type": "string"
},
"itemSubjectRef": {
"type": "string"
}
}
},
"DecisionResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"category": {
"type": "string"
},
"name": {
"type": "string"
},
"key": {
"type": "string"
},
"descr
# --- truncated at 32 KB (133 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flowable/refs/heads/main/json-schema/flowable-bpmn-schema.json