Skip to main content
GET
/
process-definition
/
key
/
{key}
/
xml
Get XML
curl --request GET \
  --url http://{host}:{port}/{contextPath}/process-definition/key/{key}/xml \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "anProcessDefinitionId",
  "bpmn20Xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<definitions\n                         xmlns=\"http://www.omg.org/spec/BPMN/20100524/MODEL\"\n                         xmlns:camunda=\"http://camunda.org/schema/1.0/bpmn\"\n                         targetNamespace=\"Examples\">\n                         <process id=\"oneTaskProcess\" isExecutable=\"true\">\n                           <startEvent id=\"theStart\" />\n                           <sequenceFlow id=\"flow1\" sourceRef=\"theStart\" targetRef=\"theEnd\" />\n                           <endEvent id=\"theEnd\" />\n                         </process>\n                       </definitions>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
key
string
required

The key of the process definition (the latest version thereof) whose XML should be retrieved.

Response

Request successful.

​
id
string | null

The id of the process definition.

​
bpmn20Xml
string | null

An escaped XML string containing the XML that this definition was deployed with. Carriage returns, line feeds and quotation marks are escaped.