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 Instances API

The Case Instances API from Flowable — 9 operation(s) for case instances.

Flowable Case Instances 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 Instances. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 9 paths, and defines 11 schemas. It is described by OpenAPI 3.0.0, at version v1.

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

12 operations 9 paths 11 schemas 2 DELETE4 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 Instances API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth).

Paths & Operations 12

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

Case Instances 12
POST
/cmmn-query/case-instances
Query case instances
queryCaseInstances body → 200400
GET
/cmmn-runtime/case-instances
List case instances
listCaseInstances 45 params → 200400
POST
/cmmn-runtime/case-instances
Start a case instance
createCaseInstance body → 201400
POST
/cmmn-runtime/case-instances/delete
Post action request to delete/terminate a bulk of case instances
bulkDeleteCaseInstances body → 204404
GET
/cmmn-runtime/case-instances/{caseInstanceId}
Get a case instance
getCaseInstance 1 param → 200404
PUT
/cmmn-runtime/case-instances/{caseInstanceId}
Update case instance properties or execute an action on a case instance (body needs to contain an 'action' property for the latter).
updateCaseInstance 1 param body → 200204400404
DELETE
/cmmn-runtime/case-instances/{caseInstanceId}
Terminate a case instance
terminateCaseInstance 1 param → 204404
POST
/cmmn-runtime/case-instances/{caseInstanceId}/change-state
Change the state of a case instance
changePlanItemState 1 param body → 200404
DELETE
/cmmn-runtime/case-instances/{caseInstanceId}/delete
Delete a case instance
deleteCaseInstance 1 param → 204404
GET
/cmmn-runtime/case-instances/{caseInstanceId}/diagram
Get diagram for a case instance
getCaseInstanceDiagram 1 param → 200400404
POST
/cmmn-runtime/case-instances/{caseInstanceId}/migrate
Migrate case instance
migrateCaseInstance 1 param body → 200404409
GET
/cmmn-runtime/case-instances/{caseInstanceId}/stage-overview
getStageOverview 1 param → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are CaseInstanceQueryRequest (54 properties), CaseInstanceResponse (21 properties), CaseInstanceCreateRequest (11 properties), ChangePlanItemStateRequest (8 properties). Each schema is shown below with its type and property counts.

StageResponse
object
5 properties
ChangePlanItemStateRequest
object
8 properties
BulkDeleteInstancesRestActionRequest
object
2 properties
CaseInstanceUpdateRequest
object
3 properties
PlanItemDefinitionWithTargetIdsRequest
object
3 properties
RestVariable
object
5 properties
CaseInstanceQueryRequest
object
54 properties
DataResponseCaseInstanceResponse
object
6 properties
CaseInstanceCreateRequest
object
Only one of caseDefinitionId or caseDefinitionKey can be used in the request body
11 properties
CaseInstanceResponse
object
21 properties
QueryVariable
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

flowable-case-instances-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 Definitions API
Flowable Case Instance Identity Links API
Flowable Case Instance Variables 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 Instances 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.