Case Definitions

Get a case definition

get/cmmn-repository/case-definitions/{caseDefinitionId}

Request

Base URL
https://developer-docs.flowable.com/cmmn-api
Auth
HTTP basic
TypeScript
https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api/docs/cmmn-repository/case-definitions/:caseDefinitionId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

caseDefinitionIdstring required

Response

Indicates request was successful and the case definitions are returned

idstring

urlstring

keystring

versioninteger

namestring

descriptionstring

tenantIdstring

deploymentIdstring

deploymentUrlstring

resourcestring

Contains the actual deployed CMMN 1.1 xml.

diagramResourcestring

Contains a graphical representation of the case, null when no diagram is available.

categorystring

graphicalNotationDefinedboolean

Indicates the case definition contains graphical information (CMMN DI).

startFormDefinedboolean

Example response

{
  "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.