Tasks

Tasks - Complete a Task `POST` /tasks/complete/{taskId}

Resource URL	/api/v1/tasks/complete/{taskId}
Response Format	JSON
Requires Authentication	Not specified
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
taskId	The ID of the task to complete	Yes	String	N/A

Example Request

curl -X 'POST' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/tasks/complete/task-001' \
-H 'accept: */*'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Task completed successfully",
  "data": {
    "id": "task-001",
    "name": "Review Order",
    "assignee": "user1",
    "processInstanceId": "proc-001",
    "taskDefinitionKey": "review-order",
    "createTime": "2025-04-08T10:00:00Z",
    "dueDate": "2025-04-10T10:00:00Z",
    "priority": 50,
    "owner": null,
    "tenantId": "tenant-1",
    "appVersion": 1,
    "delegationState": null,
    "description": "Review the order details",
    "suspended": false,
    "formKey": null,
    "executionId": "exec-001",
    "businessKey": "order-123",
    "processDefinitionId": "order-process:1:123",
    "claimTime": null,
    "processVariables": {
      "user": "john",
      "amount": 100
    },
    "taskLocalVariables": {},
    "variables": []
  }
}

HTTP Responses

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

Tasks - Complete a Task with Variables `POST` tasks/complete-with-variables/{taskId}

Resource URL	/api/v1/tasks/complete-with-variables/{taskId}
Response Format	JSON
Requires Authentication	Not specified
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
taskId	The ID of the task to complete	Yes	String	N/A
(Request Body)	Variables to submit with task completion	Yes	Object	N/A

Request Body

The request body is a JSON object containing key-value pairs of variables:

Property	Description	Required	Type	Example Value
(Variables)	Key-value pairs of task variables	Yes	Object	{"approved": true, "comments": "Looks good"}

Example Request

curl -X 'POST' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/tasks/complete-with-variables/task-001' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
    "approved": true,
    "comments": "Looks good"
}'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Task completed with variables successfully",
  "data": {
    "id": "task-001",
    "name": "Review Order",
    "assignee": "user1",
    "processInstanceId": "proc-001",
    "taskDefinitionKey": "review-order",
    "createTime": "2025-04-08T10:00:00Z",
    "dueDate": "2025-04-10T10:00:00Z",
    "priority": 50,
    "owner": null,
    "tenantId": "tenant-1",
    "appVersion": 1,
    "delegationState": null,
    "description": "Review the order details",
    "suspended": false,
    "formKey": null,
    "executionId": "exec-001",
    "businessKey": "order-123",
    "processDefinitionId": "order-process:1:123",
    "claimTime": null,
    "processVariables": {
      "user": "john",
      "amount": 100
    },
    "taskLocalVariables": {
      "approved": true,
      "comments": "Looks good"
    },
    "variables": []
  }
}

HTTP Responses

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

Tasks - Tasks of a Process `GET` tasks/{processInstanceId}

Resource URL	/api/v1/tasks/{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 tasks for	Yes	String	N/A

Example Request

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

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Tasks retrieved successfully",
  "data": [
    {
      "id": "task-001",
      "name": "Review Order",
      "assignee": "user1",
      "processInstanceId": "proc-001",
      "taskDefinitionKey": "review-order",
      "createTime": "2025-04-08T10:00:00Z",
      "dueDate": "2025-04-10T10:00:00Z",
      "priority": 50,
      "owner": null,
      "tenantId": "tenant-1",
      "appVersion": 1,
      "delegationState": null,
      "description": "Review the order details",
      "suspended": false,
      "formKey": null,
      "executionId": "exec-001",
      "businessKey": "order-123",
      "processDefinitionId": "order-process:1:123",
      "claimTime": null,
      "processVariables": {
        "user": "john",
        "amount": 100
      },
      "taskLocalVariables": {},
      "variables": []
    }
  ]
}

HTTP Responses

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

Tasks - Form Properties of a Task `GET` tasks/task-form-properties

Resource URL	/api/v1/tasks/task-form-properties
Response Format	JSON
Requires Authentication	Not specified
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
taskId	The ID of the task to retrieve form properties for	Yes	String	N/A

Example Request

curl -X 'GET' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/tasks/task-form-properties?taskId=task-001' \
-H 'accept: */*'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Form properties retrieved successfully",
  "data": [
    {
      "id": "prop-001",
      "name": "approved",
      "type": "boolean",
      "variable": "approved",
      "required": true
    },
    {
      "id": "prop-002",
      "name": "comments",
      "type": "string",
      "variable": "comments",
      "required": false
    }
  ]
}

HTTP Responses

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

Tasks - All Statuses of a Process `GET` tasks/statuses

Resource URL	/api/v1/tasks/statuses
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 statuses for	Yes	String	N/A

Example Request

curl -X 'GET' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/tasks/statuses?processInstanceId=proc-001' \
-H 'accept: */*'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Statuses retrieved successfully",
  "data": [
    {
      "id": "startEvent",
      "name": "Start",
      "type": "startEvent"
    },
    {
      "id": "review-order",
      "name": "Review Order",
      "type": "userTask"
    },
    {
      "id": "endEvent",
      "name": "End",
      "type": "endEvent"
    }
  ]
}

HTTP Responses

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

Tasks - Next Possible Tasks of the Process `GET` tasks/next-possible-tasks

Resource URL	/api/v1/tasks/next-possible-tasks
Response Format	JSON
Requires Authentication	Not specified
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
currentTaskId	The ID of the current task to find next possible tasks for	Yes	String	N/A

Example Request

curl -X 'GET' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/tasks/next-possible-tasks?currentTaskId=task-001' \
-H 'accept: */*'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Next possible tasks retrieved successfully",
  "data": [
    {
      "id": "task-002",
      "name": "Approve Order",
      "documentation": "Approve the order after review",
      "extensionElements": {},
      "attributes": {},
      "condition": null
    },
    {
      "id": "task-003",
      "name": "Reject Order",
      "documentation": "Reject the order if issues found",
      "extensionElements": {},
      "attributes": {},
      "condition": null
    }
  ]
}

HTTP Responses

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

Tasks - Historic Activities of a Process `GET` tasks/historic-activities

Resource URL	/api/v1/tasks/historic-activities
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 historic activities for	Yes	String	N/A

Example Request

curl -X 'GET' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/tasks/historic-activities?processInstanceId=proc-001' \
-H 'accept: */*'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Historic activities retrieved successfully",
  "data": [
    {
      "id": "act-001",
      "processDefinitionId": "order-process:1:123",
      "activityName": "Start",
      "processInstanceId": "proc-001",
      "tenantId": "tenant-1",
      "assignee": null,
      "executionId": "exec-001",
      "startTime": "2025-04-08T10:00:00Z",
      "activityId": "startEvent",
      "taskId": null,
      "deleteReason": null,
      "activityType": "startEvent",
      "calledProcessInstanceId": null,
      "endTime": "2025-04-08T10:01:00Z",
      "durationInMillis": 60000,
      "time": "2025-04-08T10:00:00Z"
    },
    {
      "id": "act-002",
      "processDefinitionId": "order-process:1:123",
      "activityName": "Review Order",
      "processInstanceId": "proc-001",
      "tenantId": "tenant-1",
      "assignee": "user1",
      "executionId": "exec-001",
      "startTime": "2025-04-08T10:01:00Z",
      "activityId": "review-order",
      "taskId": "task-001",
      "deleteReason": null,
      "activityType": "userTask",
      "calledProcessInstanceId": null,
      "endTime": "2025-04-08T10:15:00Z",
      "durationInMillis": 840000,
      "time": "2025-04-08T10:01:00Z"
    }
  ]
}

HTTP Responses

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

Tasks - Current Tasks of a Process `GET` tasks/current

Resource URL	/api/v1/tasks/current
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 current tasks for	Yes	String	N/A

Example Request

curl -X 'GET' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/tasks/current?processInstanceId=proc-001' \
-H 'accept: */*'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Current tasks retrieved successfully",
  "data": [
    {
      "id": "task-001",
      "name": "Review Order",
      "assignee": "user1",
      "processInstanceId": "proc-001",
      "taskDefinitionKey": "review-order",
      "createTime": "2025-04-08T10:00:00Z",
      "dueDate": "2025-04-10T10:00:00Z",
      "priority": 50,
      "owner": null,
      "tenantId": "tenant-1",
      "appVersion": 1,
      "delegationState": null,
      "description": "Review the order details",
      "suspended": false,
      "formKey": null,
      "executionId": "exec-001",
      "businessKey": "order-123",
      "processDefinitionId": "order-process:1:123",
      "claimTime": null,
      "processVariables": {
        "user": "john",
        "amount": 100
      },
      "taskLocalVariables": {},
      "variables": []
    }
  ]
}

HTTP Responses

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

Tasks - Completed Tasks of a Process `GET` tasks/completed

Resource URL	/api/v1/tasks/completed
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 completed tasks for	Yes	String	N/A

Example Request

curl -X 'GET' \
'http://activity-be-chicago-dev.braegen.ai/api/v1/tasks/completed?processInstanceId=proc-001' \
-H 'accept: */*'

Example Response

{
  "isError": false,
  "statusCode": "200",
  "message": "Completed tasks retrieved successfully",
  "data": [
    {
      "id": "task-001",
      "name": "Review Order",
      "assignee": "user1",
      "processInstanceId": "proc-001",
      "taskDefinitionKey": "review-order",
      "createTime": "2025-04-08T10:00:00Z",
      "dueDate": "2025-04-10T10:00:00Z",
      "claimTime": "2025-04-08T10:05:00Z",
      "startTime": "2025-04-08T10:00:00Z",
      "endTime": "2025-04-08T10:15:00Z",
      "durationInMillis": 900000,
      "workTimeInMillis": 600000,
      "priority": 50,
      "owner": null,
      "description": "Review the order details",
      "processDefinitionId": "order-process:1:123",
      "category": null,
      "formKey": null,
      "tenantId": "tenant-1",
      "parentTaskId": null,
      "executionId": "exec-001",
      "businessKey": "order-123",
      "processVariables": {
        "user": "john",
        "amount": 100
      },
      "taskLocalVariables": {
        "approved": true
      },
      "deleteReason": null,
      "time": "2025-04-08T10:00:00Z"
    }
  ]
}

HTTP Responses

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

Tasks

Tasks - Complete a Task POST /tasks/complete/{taskId}

HTTP Responses

Tasks - Complete a Task with Variables POST tasks/complete-with-variables/{taskId}

HTTP Responses

Tasks - Tasks of a Process GET tasks/{processInstanceId}

HTTP Responses

Tasks - Form Properties of a Task GET tasks/task-form-properties

HTTP Responses

Tasks - All Statuses of a Process GET tasks/statuses

HTTP Responses

Tasks - Next Possible Tasks of the Process GET tasks/next-possible-tasks

HTTP Responses

Tasks - Historic Activities of a Process GET tasks/historic-activities

HTTP Responses

Tasks - Current Tasks of a Process GET tasks/current

HTTP Responses

Tasks - Completed Tasks of a Process GET tasks/completed

HTTP Responses

On this page

Tasks - Complete a Task `POST` /tasks/complete/{taskId}

Tasks - Complete a Task with Variables `POST` tasks/complete-with-variables/{taskId}

Tasks - Tasks of a Process `GET` tasks/{processInstanceId}

Tasks - Form Properties of a Task `GET` tasks/task-form-properties

Tasks - All Statuses of a Process `GET` tasks/statuses

Tasks - Next Possible Tasks of the Process `GET` tasks/next-possible-tasks

Tasks - Historic Activities of a Process `GET` tasks/historic-activities

Tasks - Current Tasks of a Process `GET` tasks/current

Tasks - Completed Tasks of a Process `GET` tasks/completed