Get CMMN XML
Retrieves the CMMN XML of a case definition.
Method
GET /case-definition/{id}/xml
GET /case-definition/key/{key}/xml
(returns the XML for the latest version of the case definition which belongs to no tenant)
GET /case-definition/key/{key}/tenant-id/{tenant-id}/xml
(returns the XML for the latest version of the case definition for tenant)
Parameters
Path Parameters
Name | Description |
---|---|
id | The id of the case definition. |
key | The key of the case definition (the latest version thereof) to be retrieved. |
tenant-id | The id of the tenant the case definition belongs to. |
Result
A JSON object containing the id of the case definition and the CMMN XML.
Name | Value | Description |
---|---|---|
id | String | The id of the case definition. |
cmmnXml | String | An escaped XML string containing the XML that this case definition was deployed with. Carriage returns, line feeds and quotation marks are escaped. |
Response Codes
Code | Media type | Description |
---|---|---|
200 | application/json | Request successful. |
404 | application/json | Case definition with given id or key does not exist. See the Introduction for the error response format. |
Example
Request
GET /case-definition/aCaseDefinitionId/xml
GET /case-definition/key/aCaseDefinitionKey/xml
Response
{
"id":"aCaseDefinitionId",
"cmmnXml":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<definitions xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
...
<humanTask id=\"aHumanTask\" name=\"A HumanTask\">\r\n
..."
}