Processes

Processes - Start Process Instance `POST` processes/start/{processDefinitionKey}

Resource URL	/api/v1/processes/start/{processDefinitionKey}
Response Format	JSON
Requires Authentication	Not specified
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
processDefinitionKey	The key of the process definition to start	Yes	String	N/A
(Request Body)	Process start information	Yes	Object	N/A

Request Body

The request body is a JSON object with the following properties:

Property	Description	Required	Type	Example Value
businessKey	Unique business key for the process	No	String	"order-123"
variables	Key-value pairs of process variables	No	Object	{"user": "john", "amount": 100}

Example Request

curl -X 'POST' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/processes/start/order-process' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
    "businessKey": "order-123",
    "variables": {
        "user": "john",
        "amount": 100
    }
}'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Process started successfully",
  "data": {
    "id": "proc-001",
    "processDefinitionId": "order-process:1:123",
    "processDefinitionName": "Order Process",
    "processDefinitionKey": "order-process",
    "deploymentId": "dep-001",
    "businessKey": "order-123",
    "processVariables": {
      "user": "john",
      "amount": 100
    },
    "suspended": false
  }
}

HTTP Responses

HTTP Code	Message
200	Successful Response
400	Bad Request
404	Not Found
500	Internal Server Error

Processes - Get Process Instance `GET` processes/{processInstanceId}

Resource URL	/api/v1/processes/{processInstanceId}
Response Format	JSON
Requires Authentication	Not specified
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
processInstanceId	The ID of the process instance to retrieve	Yes	String	N/A

Example Request

curl -X 'GET' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/processes/proc-001' \
-H 'accept: */*'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Process instance retrieved successfully",
  "data": {
    "id": "proc-001",
    "processDefinitionId": "order-process:1:123",
    "processDefinitionName": "Order Process",
    "processDefinitionKey": "order-process",
    "deploymentId": "dep-001",
    "businessKey": "order-123",
    "processVariables": {
      "user": "john",
      "amount": 100
    },
    "suspended": false
  }
}

HTTP Responses

HTTP Code	Message
200	Successful Response
400	Bad Request
404	Not Found
500	Internal Server Error

Processes - Get Deployed Processes `GET` processes/deployments

Resource URL	/api/v1/processes/deployments
Response Format	JSON
Requires Authentication	Not specified
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

This endpoint has no query or path parameters.

Example Request

curl -X 'GET' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/processes/deployments' \
-H 'accept: application/json'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Deployed processes retrieved successfully",
  "data": [
    {
      "id": "proc-def-001",
      "name": "Order Process",
      "description": "Handles order processing",
      "key": "order-process",
      "version": 1,
      "deploymentId": "dep-001",
      "suspended": false
    },
    {
      "id": "proc-def-002",
      "name": "Payment Process",
      "description": "Manages payment workflows",
      "key": "payment-process",
      "version": 2,
      "deploymentId": "dep-002",
      "suspended": false
    }
  ]
}

HTTP Responses

HTTP Code	Message
200	Successful Response
400	Bad Request
500	Internal Server Error

Processes - Delete All Deployed Processes `DELETE` processes/deployments

Resource URL	/api/v1/processes/deployments
Response Format	JSON
Requires Authentication	Not specified
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

This endpoint has no query or path parameters.

Example Request

curl -X 'DELETE' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/processes/deployments' \
-H 'accept: */*'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "All deployed processes deleted successfully",
  "data": "Deletion completed"
}

HTTP Responses

HTTP Code	Message
200	Successful Response
400	Bad Request
500	Internal Server Error

Processes - Get Completed Processes `GET` processes/completed

Resource URL	/api/v1/processes/completed
Response Format	JSON
Requires Authentication	Not specified
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

This endpoint has no query or path parameters.

Example Request

curl -X 'GET' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/processes/completed' \
-H 'accept: */*'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Completed processes retrieved successfully",
  "data": [
    {
      "name": "Order Process",
      "id": "proc-001",
      "description": "Order processing workflow",
      "processDefinitionId": "order-process:1:123",
      "deploymentId": "dep-001",
      "processDefinitionName": "Order Process",
      "processDefinitionKey": "order-process",
      "tenantId": "tenant-1",
      "processVariables": {
        "user": "john",
        "amount": 100
      },
      "businessKey": "order-123",
      "startTime": "2025-04-08T10:00:00Z",
      "startUserId": "user1",
      "processDefinitionVersion": 1,
      "superProcessInstanceId": null,
      "deleteReason": null,
      "endTime": "2025-04-08T12:00:00Z",
      "durationInMillis": 7200000,
      "endActivityId": "endEvent",
      "startActivityId": "startEvent"
    }
  ]
}

HTTP Responses

HTTP Code	Message
200	Successful Response
400	Bad Request
500	Internal Server Error

Processes - Get Active Processes `GET` processes/active

Resource URL	/api/v1/processes/active
Response Format	JSON
Requires Authentication	Not specified
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
processDefinitionKey	Filter by process definition key	No	String	N/A

Example Request

curl -X 'GET' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/processes/active?processDefinitionKey=order-process' \
-H 'accept: */*'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Active processes retrieved successfully",
  "data": [
    {
      "id": "proc-001",
      "processDefinitionId": "order-process:1:123",
      "processDefinitionName": "Order Process",
      "processDefinitionKey": "order-process",
      "deploymentId": "dep-001",
      "businessKey": "order-123",
      "processVariables": {
        "user": "john",
        "amount": 100
      },
      "suspended": false
    }
  ]
}

HTTP Responses

HTTP Code	Message
200	Successful Response
400	Bad Request
500	Internal Server Error

Processes - Get Processes with Business Key `GET` processes/active/{businessKey}

Resource URL	/api/v1/processes/active/{businessKey}
Response Format	JSON
Requires Authentication	Not specified
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
businessKey	The business key to filter active processes	Yes	String	N/A

Example Request

curl -X 'GET' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/processes/active/order-123' \
-H 'accept: */*'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Active processes with business key retrieved successfully",
  "data": [
    {
      "id": "proc-001",
      "processDefinitionId": "order-process:1:123",
      "processDefinitionName": "Order Process",
      "processDefinitionKey": "order-process",
      "deploymentId": "dep-001",
      "businessKey": "order-123",
      "processVariables": {
        "user": "john",
        "amount": 100
      },
      "suspended": false
    }
  ]
}

HTTP Responses

HTTP Code	Message
200	Successful Response
400	Bad Request
404	Not Found
500	Internal Server Error

Processes - Delete a Process Instance `DELETE` processes/instance/{processInstanceId}

Resource URL	/api/v1/processes/instance/{processInstanceId}
Response Format	JSON
Requires Authentication	Not specified
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
processInstanceId	The ID of the process instance to delete	Yes	String	N/A
(Request Body)	Reason for deletion	Yes	String	N/A

Request Body

The request body is a simple string providing the reason for deletion:

Property	Description	Required	Type	Example Value
(Body)	Reason for deleting the process instance	Yes	String	"No longer needed"

Example Request

curl -X 'DELETE' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/processes/instance/proc-001' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '"No longer needed"'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Process instance deleted successfully",
  "data": "proc-001 deleted"
}

HTTP Responses

HTTP Code	Message
200	Successful Response
400	Bad Request
404	Not Found
500	Internal Server Error

Processes - Delete a Deployed Process `DELETE` processes/deployments/{deploymentId}

Resource URL	/api/v1/processes/deployments/{deploymentId}
Response Format	JSON
Requires Authentication	Not specified
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
deploymentId	The ID of the deployment to delete	Yes	String	N/A

Example Request

curl -X 'DELETE' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/processes/deployments/dep-001' \
-H 'accept: */*'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Deployed process deleted successfully",
  "data": "dep-001 deleted"
}

HTTP Responses

HTTP Code	Message
200	Successful Response
400	Bad Request
404	Not Found
500	Internal Server Error

Processes

Processes - Start Process Instance POST processes/start/{processDefinitionKey}

HTTP Responses

Processes - Get Process Instance GET processes/{processInstanceId}

HTTP Responses

Processes - Get Deployed Processes GET processes/deployments

HTTP Responses

Processes - Delete All Deployed Processes DELETE processes/deployments

HTTP Responses

Processes - Get Completed Processes GET processes/completed

HTTP Responses

Processes - Get Active Processes GET processes/active

HTTP Responses

Processes - Get Processes with Business Key GET processes/active/{businessKey}

HTTP Responses

Processes - Delete a Process Instance DELETE processes/instance/{processInstanceId}

HTTP Responses

Processes - Delete a Deployed Process DELETE processes/deployments/{deploymentId}

HTTP Responses

On this page

Processes - Start Process Instance `POST` processes/start/{processDefinitionKey}

Processes - Get Process Instance `GET` processes/{processInstanceId}

Processes - Get Deployed Processes `GET` processes/deployments

Processes - Delete All Deployed Processes `DELETE` processes/deployments

Processes - Get Completed Processes `GET` processes/completed

Processes - Get Active Processes `GET` processes/active

Processes - Get Processes with Business Key `GET` processes/active/{businessKey}

Processes - Delete a Process Instance `DELETE` processes/instance/{processInstanceId}

Processes - Delete a Deployed Process `DELETE` processes/deployments/{deploymentId}