flowable / flowable/flowable-engine

[REST API] Return a processBusinessKey field for tasks

Open
#3,078 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
9.5k
Forks
2.9k
Avg merge
7h 8m
Merged PRs (30d)
2

Description

**Problem**

When retrieving a task from the REST API, we sometimes want to easily associate this task with the business object related to the process the task is associated to. This means retrieving the "businessKey" value associated to the task's process instance.

Today, you must perform two API calls to retrieve this "businessKey" value:

1. Retrieve the task with the `query/tasks` or `runtime/tasks` API endpoint
2. Retrieve the businessKey using the `processInstanceId` value returned in 1 and the `runtime/process-instances` API endpoint

It'd be easier if we could do this with one API call only.

**Potential solution**

Return a `processBusinessKey` field when returning task objects, containing the value of the `businessKey` field of the task's process instance.

This would impact the following API endpoints:

- runtime/tasks
- query/tasks
- history/historic-task-instances
- query/historic-task-instances

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.