API Reference: Processes

Process Endpoints

List Processes

Retrieve all processes in a tenant.

Endpoint: GET /tenant/{tenantId}/processes

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	The unique tenant ID

Response:

[
	{
		"id": "b8c9d0e1-f2a3-4567-bcd8-901234567890",
		"displayName": "Order to Cash",
		"treeNodeType": "Process",
		"treeParentId": null,
		"designerModelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
		"createdAt": "2024-03-01T09:00:00Z",
		"updatedAt": "2024-03-15T16:30:00Z"
	}
]

---

Create Process

Create a new process in a tenant.

Endpoint: POST /tenant/{tenantId}/processes

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	The unique tenant ID

Request Body:

{
	"displayName": "My New Process",
	"treeNodeType": "Process",
	"treeParentId": null
}

Field	Type	Required	Description
displayName	string	Yes	Process name
treeNodeType	string	No	Must be Process (default) or TreeGroup
treeParentId	string	No	Parent folder ID for organizing processes

Response: Returns the created process object.

---

Get Process

Retrieve details about a specific process.

Endpoint: GET /tenant/{tenantId}/processes/{processId}

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	The unique tenant ID
processId	string	path	Yes	The unique identifier of the process

Response:

{
	"id": "b8c9d0e1-f2a3-4567-bcd8-901234567890",
	"displayName": "Order to Cash",
	"treeNodeType": "Process",
	"treeParentId": null,
	"designerModelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
	"createdAt": "2024-03-01T09:00:00Z",
	"updatedAt": "2024-03-15T16:30:00Z"
}

---

Update Process

Update a process (rename or move to a different folder).

Endpoint: PUT /tenant/{tenantId}/processes/{processId}

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	The unique tenant ID
processId	string	path	Yes	The unique identifier of the process

Request Body:

{
	"displayName": "Updated Process Name",
	"treeParentId": "d0e1f2a3-b4c5-6789-def0-123456789012"
}

Field	Type	Required	Description
displayName	string	No	New process name
treeParentId	string	No	New parent folder ID

Response: Returns the updated process object.

---

Delete Process

Delete a process and its associated data.

Endpoint: DELETE /tenant/{tenantId}/processes/{processId}

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	The unique tenant ID
processId	string	path	Yes	The unique identifier of the process

Response:

{
	"success": true
}

---

Upload BPMN

Upload a BPMN XML file to define or update a process model.

Endpoint: PUT /tenant/{tenantId}/processes/{processId}/bpmn

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	The unique tenant ID
processId	string	path	Yes	The unique identifier of the process

Request Body:

{
	"bpmnXml": "<?xml version="1.0" encoding="UTF-8\"?>..."
}

Field	Type	Required	Description
bpmnXml	string	Yes	The BPMN 2.0 XML content as a string

Response: Returns the updated process object with the new model.

---

Process Data Mapping Endpoints

Data mappings connect data tables to processes, allowing you to visualize and analyze your event log data on a process model.

List Process Mappings

Retrieve all data mappings for a process.

Endpoint: GET /tenant/{tenantId}/processes/{processId}/mappings

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	The unique tenant ID
processId	string	path	Yes	The unique identifier of the process

Response:

[
	{
		"id": "e1f2a3b4-c5d6-7890-efa1-234567890123",
		"modelId": "c9d0e1f2-a3b4-5678-cde9-012345678901",
		"dataTableId": "a7b8c9d0-e1f2-3456-abc7-890123456789",
		"displayName": "Sales Data 2024",
		"color": { "id": "data-1" },
		"showByDefault": true,
		"createdAt": "2024-03-10T11:00:00Z"
	}
]

---

Create Process Mapping

Map a data table to a process.

Endpoint: POST /tenant/{tenantId}/processes/{processId}/mappings

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	The unique tenant ID
processId	string	path	Yes	The unique identifier of the process

Request Body:

{
	"dataTableId": "a7b8c9d0-e1f2-3456-abc7-890123456789",
	"displayName": "Sales Data 2024",
	"color": { "id": "data-1" },
	"showByDefault": true
}

Field	Type	Required	Description
dataTableId	string	Yes	ID of the datatable to map
displayName	string	No	Display name for the mapping
color	object	No	Color object with id field (data-1 through data-11)
showByDefault	boolean	No	Whether to show by default (default: true)

Response: Returns the created mapping object.

---

Update Process Mapping

Update an existing data mapping’s display settings.

Endpoint: PUT /tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	The unique tenant ID
processId	string	path	Yes	The unique identifier of the process
mappingId	string	path	Yes	The unique identifier of the mapping

Request Body:

{
	"displayName": "Updated Name",
	"color": { "id": "data-2" },
	"showByDefault": false
}

Field	Type	Required	Description
displayName	string	No	New display name
color	object	No	Color object with id field (data-1 through data-11)
showByDefault	boolean	No	New default visibility

Response: Returns the updated mapping object.

---

Delete Process Mapping

Remove a data mapping from a process.

Endpoint: DELETE /tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	The unique tenant ID
processId	string	path	Yes	The unique identifier of the process
mappingId	string	path	Yes	The unique identifier of the mapping

Response:

{
	"success": true
}