Flowable · Schema
Flowable CMMN API Schemas
JSON Schema definitions extracted from the Flowable CMMN OpenAPI specification
BPMBusiness Process ManagementWorkflowBPMNCMMNDMNProcess AutomationCase ManagementOpen SourceREST API
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Flowable CMMN API Schemas",
"description": "JSON Schema definitions extracted from the Flowable CMMN OpenAPI specification",
"definitions": {
"Association": {
"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"
}
}
},
"documentationTextFormat": {
"type": "string"
},
"documentation": {
"type": "string"
},
"sourceRef": {
"type": "string"
},
"sourceElement": {
"$ref": "#/components/schemas/BaseElement"
},
"targetRef": {
"type": "string"
},
"targetElement": {
"$ref": "#/components/schemas/BaseElement"
},
"transitionEvent": {
"type": "string"
}
}
},
"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"
}
}
}
}
},
"BulkDeleteInstancesRestActionRequest": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"instanceIds": {
"type": "array",
"items": {
"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"
}
}
}
},
"Case": {
"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"
}
}
},
"documentationTextFormat": {
"type": "string"
},
"documentation": {
"type": "string"
},
"name": {
"type": "string"
},
"initiatorVariableName": {
"type": "string"
},
"planModel": {
"$ref": "#/components/schemas/Stage"
},
"startEventType": {
"type": "string"
},
"candidateStarterUsers": {
"type": "array",
"items": {
"type": "string"
}
},
"candidateStarterGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"async": {
"type": "boolean"
},
"allCaseElements": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/CaseElement"
}
},
"lifecycleListeners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowableListener"
}
},
"reactivateEventListener": {
"$ref": "#/components/schemas/ReactivateEventListener"
}
}
},
"CaseDefinitionActionRequest": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"category": {
"type": "string"
}
}
},
"CaseDefinitionResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "oneTaskCase:1:4"
},
"url": {
"type": "string",
"example": "http://localhost:8182/cmmn-repository/case-definitions/oneTaskCase%3A1%3A4"
},
"key": {
"type": "string",
"example": "oneTaskCase"
},
"version": {
"type": "integer",
"format": "int32",
"example": 1
},
"name": {
"type": "string",
"example": "The One Task Case"
},
"description": {
"type": "string",
"example": "This is a case for testing purposes"
},
"tenantId": {
"type": "string",
"example": "null"
},
"deploymentId": {
"type": "string",
"example": "2"
},
"deploymentUrl": {
"type": "string",
"example": "http://localhost:8081/cmmn-repository/deployments/2"
},
"resource": {
"type": "string",
"example": "http://localhost:8182/cmmn-repository/deployments/2/resources/testCase.cmmn",
"description": "Contains the actual deployed CMMN 1.1 xml."
},
"diagramResource": {
"type": "string",
"example": "http://localhost:8182/cmmn-repository/deployments/2/resources/testProcess.png",
"description": "Contains a graphical representation of the case, null when no diagram is available."
},
"category": {
"type": "string",
"example": "Examples"
},
"graphicalNotationDefined": {
"type": "boolean",
"description": "Indicates the case definition contains graphical information (CMMN DI)."
},
"startFormDefined": {
"type": "boolean"
}
}
},
"CaseElement": {
"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"
}
}
},
"documentationTextFormat": {
"type": "string"
},
"documentation": {
"type": "string"
},
"name": {
"type": "string"
},
"parent": {
"$ref": "#/components/schemas/PlanFragment"
},
"parentStage": {
"$ref": "#/components/schemas/Stage"
}
}
},
"CaseInstanceCreateRequest": {
"type": "object",
"properties": {
"caseDefinitionId": {
"type": "string",
"example": "oneTaskCase:1:158"
},
"caseDefinitionKey": {
"type": "string",
"example": "oneTaskCase"
},
"name": {
"type": "string",
"example": "My case name"
},
"businessKey": {
"type": "string",
"example": "myBusinessKey"
},
"variables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RestVariable"
}
},
"transientVariables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RestVariable"
}
},
"startFormVariables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RestVariable"
}
},
"outcome": {
"type": "string"
},
"tenantId": {
"type": "string",
"example": "tenant1"
},
"overrideDefinitionTenantId": {
"type": "string",
"example": "overrideTenant1"
},
"returnVariables": {
"type": "boolean"
}
},
"description": "Only one of caseDefinitionId or caseDefinitionKey can be used in the request body"
},
"CaseInstanceQueryRequest": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"format": "int32"
},
"size": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"caseInstanceId": {
"type": "string"
},
"caseInstanceIds": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"caseDefinitionId": {
"type": "string"
},
"caseDefinitionKey": {
"type": "string"
},
"caseDefinitionKeyLike": {
"type": "string"
},
"caseDefinitionKeyLikeIgnoreCase": {
"type": "string"
},
"caseDefinitionKeys": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"excludeCaseDefinitionKeys": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"caseDefinitionCategory": {
"type": "string"
},
"caseDefinitionCategoryLike": {
"type": "string"
},
"caseDefinitionCategoryLikeIgnoreCase": {
"type": "string"
},
"caseDefinitionName": {
"type": "string"
},
"caseDefinitionNameLike": {
"type": "string"
},
"caseDefinitionNameLikeIgnoreCase": {
"type": "string"
},
"caseBusinessKey": {
"type": "string"
},
"caseInstanceName": {
"type": "string"
},
"caseInstanceNameLike": {
"type": "string"
},
"caseInstanceNameLikeIgnoreCase": {
"type": "string"
},
"caseInstanceRootScopeId": {
"type": "string"
},
"caseInstanceParentScopeId": {
"type": "string"
},
"caseInstanceBusinessKey": {
"type": "string"
},
"caseInstanceBusinessKeyLike": {
"type": "string"
},
"caseInstanceBusinessKeyLikeIgnoreCase": {
"type": "string"
},
"caseInstanceBusinessStatus": {
"type": "string"
},
"caseInstanceBusinessStatusLike": {
"type": "string"
},
"caseInstanceBusinessStatusLikeIgnoreCase": {
"type": "string"
},
"caseInstanceParentId": {
"type": "string"
},
"caseInstanceStartedBy": {
"type": "string"
},
"caseInstanceStartedBefore": {
"type": "string",
"format": "date-time"
},
"caseInstanceStartedAfter": {
"type": "string",
"format": "date-time"
},
"caseInstanceState": {
"type": "string"
},
"involvedUser": {
"type": "string"
},
"caseInstanceCallbackId": {
"type": "string"
},
"caseInstanceCallbackIds": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"caseInstanceCallbackType": {
"type": "string"
},
"parentCaseInstanceId": {
"type": "string"
},
"caseInstanceReferenceId": {
"type": "string"
},
"caseInstanceReferenceType": {
"type": "string"
},
"caseInstanceLastReactivatedBy": {
"type": "string"
},
"caseInstanceLastReactivatedBefore": {
"type": "string",
"format": "date-time"
},
"caseInstanceLastReactivatedAfter": {
"type": "string",
"format": "date-time"
},
"includeCaseVariables": {
"type": "boolean"
},
"includeCaseVariablesNames": {
"type": "array",
"items": {
"type": "string"
}
},
"variables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryVariable"
}
},
"activePlanItemDefinitionId": {
"type": "string"
},
"activePlanItemDefinitionIds": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"tenantId": {
"type": "string"
},
"tenantIdLike": {
"type": "string"
},
"tenantIdLikeIgnoreCase": {
"type": "string"
},
"withoutTenantId": {
"type": "boolean"
}
}
},
"CaseInstanceQueryResource": {
"type": "object"
},
"CaseInstanceResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "187"
},
"name": {
"type": "string",
"example": "processName"
},
"url": {
"type": "string",
"example": "http://localhost:8182/cmmn-repository/case-definitions/caseOne%3A1%3A4"
},
"businessKey": {
"type": "string",
"example": "myBusinessKey"
},
"businessStatus": {
"type": "string",
"example": "myBusinessStatus"
},
"startTime": {
"type": "string",
"format": "date-time",
"example": "2019-04-17T10:17:43.902+0000"
},
"startUserId": {
"type": "string",
"example": "aUserId"
},
"state": {
"type": "string",
"example": "active"
},
"ended": {
"type": "boolean"
},
"caseDefinitionId": {
"type": "string",
"example": "oneTaskCase:1:158"
},
"caseDefinitionUrl": {
"type": "string",
"example": "http://localhost:8182/cmmn-repository/case-definitions/caseOne%3A1%3A4"
},
"caseDefinitionName": {
"type": "string",
"example": "aCaseDefinitionName"
},
"caseDefinitionDescription": {
"type": "string",
"example": "A case definition description"
},
"parentId": {
"type": "string",
"example": "123"
},
"callbackId": {
"type": "string",
"example": "123"
},
"callbackType": {
"type": "string",
"example": "cmmn-1.1-to-cmmn-1.1-child-case"
},
"referenceId": {
"type": "string",
"example": "123"
},
"referenceType": {
"type": "string",
"example": "event-to-cmmn-1.1-case"
},
"variables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RestVariable"
}
},
"tenantId": {
"type": "string",
"example": "null"
},
"completed": {
"type": "boolean"
}
}
},
"CaseInstanceUpdateRequest": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"name": {
"type": "string"
},
"businessKey": {
"type": "string"
}
}
},
"CaseInstanceVariableCollectionResource": {
"type": "object"
},
"CaseInstanceVariableResource": {
"type": "object"
},
"ChangePlanItemStateRequest": {
"type": "object",
"properties": {
"activatePlanItemDefinitionIds": {
"type": "array",
"description": "plan item definition ids to be activated",
"items": {
"type": "string"
}
},
"moveToAvailablePlanItemDefinitionIds": {
"type": "array",
"description": "plan item definition ids to be moved to available state",
"items": {
"type": "string"
}
},
"terminatePlanItemDefinitionIds": {
"type": "array",
"description": "plan item definition ids to be terminated",
"items": {
"type": "string"
}
},
"addWaitingForRepetitionPlanItemDefinitionIds": {
"type": "array",
"description": "add waiting for repetition to provided plan item definition ids",
"items": {
"type": "string"
}
},
"removeWaitingForRepetitionPlanItemDefinitionIds": {
"type": "array",
"description": "remove waiting for repetition to provided plan item definition ids",
"items": {
"type": "string"
}
},
"changePlanItemIds": {
"type": "object",
"description": "map an existing plan item id to new plan item id, this should not be necessary in general, but could be needed when plan item ids change between case definition versions.",
"additionalProperties": {
"type": "string"
}
},
"changePlanItemIdsWithDefinitionId": {
"type": "object",
"description": "map an existing plan item id to new plan item id with the plan item definition id, this should not be necessary in general, but could be needed when plan item ids change between case definition versions.",
"additionalProperties": {
"type": "string"
}
},
"changePlanItemDefinitionsWithNewTargetIds": {
"type": "array",
"description": "map an existing plan item id to a new plan item id and plan item definition id, this should not be necessary in general, but could be needed when plan item ids change between case definition versions.",
"items": {
"$ref": "#/components/schemas/PlanItemDefinitionWithTargetIdsRequest"
}
}
}
},
"CmmnDeploymentResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "10"
},
"name": {
"type": "string",
"example": "flowable-examples.bar"
},
"deploymentTime": {
"type": "string",
"format": "date-time",
"example": "2010-10-13T14:54:26.750+02:00"
},
"category": {
"type": "string",
"example": "examples"
},
"parentDeploymentId": {
"type": "string",
"example": "12"
},
"url": {
"type": "string",
"example": "http://localhost:8081/flowable-rest/service/cmmn-repository/deployments/10"
},
"tenantId": {
"type": "string"
}
}
},
"CmmnDiEdge": {
"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"
}
}
},
"cmmnElementRef": {
"type": "string"
},
"targetCmmnElementRef": {
"type": "string"
},
"sourceDockerInfo": {
"$ref": "#/components/schemas/GraphicInfo"
},
"targetDockerInfo": {
"$ref": "#/components/schemas/GraphicInfo"
},
"waypoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphicInfo"
}
},
"labelGraphicInfo": {
"$ref": "#/components/schemas/GraphicInfo"
}
}
},
"CmmnModel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"targetNamespace": {
"type": "string"
},
"expressionLanguage": {
"type": "string"
},
"exporter": {
"type": "string"
},
"exporterVersion": {
"type": "string"
},
"author": {
"type": "string"
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"definitionsAttributes": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtensionAttribute"
}
}
},
"cases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Case"
}
},
"processes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Process"
}
},
"decisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Decision"
}
},
"associations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Association"
}
},
"textAnnotations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TextAnnotation"
}
},
"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/CmmnDiEdge"
}
},
"namespaces": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"primaryCase": {
"$ref": "#/components/schemas/Case"
}
}
},
"CompletionNeutralRule": {
"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"
}
}
},
"documentationTextFormat": {
"type": "string"
},
"documentation": {
"type": "string"
},
"name": {
"type": "string"
},
"parent": {
"$ref": "#/components/schemas/PlanFragment"
},
"condition": {
"type": "string"
},
"parentStage": {
"$ref": "#/components/schemas/Stage"
}
}
},
"Criterion": {
"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"
}
}
},
"documentationTextFormat": {
"type": "string"
},
"documentation": {
"type": "string"
},
"name": {
"type": "string"
},
"parent": {
"$ref": "#/components/schemas/PlanFragment"
},
"technicalId": {
"type": "string"
},
"sentryRef": {
"type": "string"
},
"sentry": {
"$ref": "#/components/schemas/Sentry"
},
"attachedToRefId": {
"type": "string"
},
"exitType": {
"type": "string"
},
"exitEventType": {
"type": "string"
},
"incomingAssociations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Association"
}
},
"outgoingAssociations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Association"
}
},
"entryCriterion": {
"type": "boolean"
},
"exitCriterion": {
"type": "boolean"
},
"parentStage": {
"$ref": "#/components/schemas/Stage"
}
}
},
"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"
}
}
},
"DataResponseCaseDefinitionResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CaseDefinitionResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseCaseInstanceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CaseInstanceResponse"
}
},
"total": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "integer",
"format": "int32"
},
"sort": {
"type": "string"
},
"order": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"DataResponseCmmnDeploymentResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CmmnDeploymentResponse"
}
},
"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"
}
}
},
"DataResponseHistoricCaseInstanceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/compo
# --- truncated at 32 KB (131 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flowable/refs/heads/main/json-schema/flowable-cmmn-schema.json