FLflowable
Case Definitions

List of case definitions

For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?categoryLike=acme%25' to match categories starting with 'acme').

get/cmmn-repository/case-definitions

Request

Query parameters

versioninteger

Only return case definitions with the given version.

namestring

Only return case definitions with the given name.

nameLikestring

Only return case definitions with a name like the given name.

nameLikeIgnoreCasestring

Only return case definitions with a name like the given name, ignoring case.

keystring

Only return case definitions with the given key.

keyLikestring

Only return case definitions with a key like the given key.

resourceNamestring

Only return case definitions with the given resource name.

resourceNameLikestring

Only return case definitions with a resource name like the given resource name.

categorystring

Only return case definitions with the given category.

categoryLikestring

Only return case definitions with a category like the given category.

categoryNotEqualsstring

Only return case definitions which do not have the given category.

deploymentIdstring

Only return case definitions which are part of a deployment with the given deployment id.

parentDeploymentIdstring

Only return case definitions which are part of a deployment with the given parent deployment id.

startableByUserstring

Only return case definitions which can be started by the user with the given id.

tenantIdstring

Only return case definitions with the given tenant id.

tenantIdLikestring

Only return case definitions with a tenant id like the given tenant id.

latestboolean

Only return the latest case definition versions. Can only be used together with key and keyLike parameters, using any other parameter will result in a 400-response.

sort'name' | 'id' | 'key' | 'category' | 'deploymentId' | 'version'

Property to sort on, to be used together with the order.

orderstring

The sort order, either 'asc' or 'desc'. Defaults to 'asc'.

startinteger

Index of the first row to fetch. Defaults to 0.

sizeinteger

Number of rows to fetch, starting from start. Defaults to 10.

Response

Indicates request was successful and the case definitions are returned

totalinteger
startinteger
sortstring
orderstring
sizeinteger

Example response

{
  "data": [
    {
      "id": "oneTaskCase:1:4",
      "url": "http://localhost:8182/cmmn-repository/case-definitions/oneTaskCase%3A1%3A4",
      "key": "oneTaskCase",
      "version": 1,
      "name": "The One Task Case",
      "description": "This is a case for testing purposes",
      "tenantId": "null",
      "deploymentId": "2",
      "deploymentUrl": "http://localhost:8081/cmmn-repository/deployments/2",
      "resource": "http://localhost:8182/cmmn-repository/deployments/2/resources/testCase.cmmn",
      "diagramResource": "http://localhost:8182/cmmn-repository/deployments/2/resources/testProcess.png",
      "category": "Examples"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.