How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Flowable Case Definitions API

The Case Definitions API from Flowable — 16 operation(s) for case definitions.

Flowable Case Definitions API is one of 64 APIs that Flowable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Case Definitions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 19 operations across 16 paths, and defines 40 schemas. It is described by OpenAPI 3.0.0, at version v1.

Requests are made against a single base URL, /flowable-rest/service.

19 operations 16 paths 40 schemas 1 DELETE12 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1
Base URL
https://your-server/process-api
Authentication
HTTP Basic
Contact
License
Resource Areas
1

Authentication & Security 1

Flowable Case Definitions API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth).

Paths & Operations 19

Across 16 paths, the API surfaces 19 operations — 1 DELETE, 12 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Case Definitions 19
GET
/cmmn-repository/case-definitions
List of case definitions
listCaseDefinitions 20 params → 200400
GET
/cmmn-repository/case-definitions/{caseDefinitionId}
Get a case definition
getCaseDefinition 1 param → 200404
PUT
/cmmn-repository/case-definitions/{caseDefinitionId}
Execute actions for a case definition
executeCaseDefinitionAction 1 param body → 200400404
POST
/cmmn-repository/case-definitions/{caseDefinitionId}/batch-migrate
Batch migrate all instances of case definition
batchMigrateInstancesOfCaseDefinition 1 param body → 200404
POST
/cmmn-repository/case-definitions/{caseDefinitionId}/batch-migrate-historic-instances
Batch migrate all historic instances of case definition
batchMigrateHistoricInstancesOfCaseDefinition 1 param body → 200404
GET
/cmmn-repository/case-definitions/{caseDefinitionId}/decision-tablesdeprecated
List decision tables for a case definition
listCaseDefinitionDecisionTables 1 param → 200404
GET
/cmmn-repository/case-definitions/{caseDefinitionId}/decisions
List decisions for a case definition
listCaseDefinitionDecisions 1 param → 200404
GET
/cmmn-repository/case-definitions/{caseDefinitionId}/form-definitions
List form definitions for a case definition
listCaseDefinitionFormDefinitions 1 param → 200404
GET
/cmmn-repository/case-definitions/{caseDefinitionId}/identitylinks
List candidate starters for a case definition
listCaseDefinitionIdentityLinks 1 param → 200404
POST
/cmmn-repository/case-definitions/{caseDefinitionId}/identitylinks
Add a candidate starter to a case definition
createIdentityLink 1 param body → 201400404
GET
/cmmn-repository/case-definitions/{caseDefinitionId}/identitylinks/{family}/{identityId}
Get a candidate starter from a case definition
getIdentityLink 3 params → 200404
DELETE
/cmmn-repository/case-definitions/{caseDefinitionId}/identitylinks/{family}/{identityId}
Delete a candidate starter from a case definition
deleteIdentityLink 3 params → 204404
GET
/cmmn-repository/case-definitions/{caseDefinitionId}/image
Get a case definition image
getImageResource 1 param → 200404
POST
/cmmn-repository/case-definitions/{caseDefinitionId}/migrate
Migrate all instances of case definition
migrateInstancesOfCaseDefinition 1 param body → 200404
POST
/cmmn-repository/case-definitions/{caseDefinitionId}/migrate-historic-instances
Migrate all historic case instances of case definition
migrateHistoricInstancesOfCaseDefinition 1 param body → 200404
GET
/cmmn-repository/case-definitions/{caseDefinitionId}/model
Get a case definition CMMN model
getCmmnModelResource 1 param → 200404
GET
/cmmn-repository/case-definitions/{caseDefinitionId}/resourcedata
Get a case definition resource content
getProcessDefinitionResource 1 param → 200404
GET
/cmmn-repository/case-definitions/{caseDefinitionId}/start-form
Get a case definition start form
getProcessDefinitionStartForm 1 param → 200404
GET
/document-repository/document-definitions/{documentDefinitionId}/resourcedata
Get a document definition resource content
getDocumentDefinitionResource 1 param → 200404

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are Stage (30 properties), PlanItem (25 properties), CmmnModel (20 properties), Criterion (20 properties). Each schema is shown below with its type and property counts.

TextAnnotation
object
9 properties
Criterion
object
20 properties
Decision
object
10 properties
CaseDefinitionResponse
object
14 properties
PlanItemControl
object
16 properties
CmmnDiEdge
object
11 properties
BaseElement
object
5 properties
ReactivationRule
object
14 properties
FieldExtension
object
8 properties
RestIdentityLink
object
4 properties
FlowableListener
object
15 properties
SentryIfPart
object
8 properties
FormDefinition
object
9 properties
CompletionNeutralRule
object
11 properties
ParentCompletionRule
object
12 properties
SentryOnPart
object
11 properties
RequiredRule
object
11 properties
Sentry
object
15 properties
ScriptInfo
object
8 properties
ReactivateEventListener
object
17 properties
Case
object
17 properties
Stage
object
30 properties
Process
object
10 properties
VariableAggregationDefinitions
object
2 properties
ExtensionAttribute
object
4 properties
Association
object
12 properties
ManualActivationRule
object
11 properties
DataResponseCaseDefinitionResponse
object
6 properties
DmnDecision
object
11 properties
RepetitionRule
object
18 properties
PlanItemDefinition
object
13 properties
PlanFragment
object
18 properties
GraphicInfo
object
12 properties
CaseDefinitionActionRequest
object
2 properties
CmmnModel
object
20 properties
PlanItem
object
25 properties
VariableAggregationDefinition
object
7 properties
Variable
object
4 properties
ExtensionElement
object
10 properties
CaseElement
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

flowable-case-definitions-api-openapi.yml Raw ↑

Other APIs Flowable publishes across the network.

Flowable Access Tokens API
Flowable Accounts API
Flowable Acquire and Execute API
Flowable Batch parts API
Flowable Batches API
Flowable Case Instance Identity Links API
Flowable Case Instance Variables API
Flowable Case Instances API
Flowable Cmmn Engine API
Flowable Contact Filters API
Flowable Content item API
Flowable Content item metadata API
Where this information came from

This is an independent, third-party profile of Flowable Case Definitions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.