flowable / flowable/flowable-engine

[REST API] Return a processBusinessKey field for tasks

Offen
#3,078 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Java
Sterne
9.5k
Forks
2.9k
Ø Merge
7 Std. 8 Min.
Gemergte PRs (30 T.)
2

Beschreibung

**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

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginne damit, die Task-Antwortdarstellungen und die Suche nach Prozessinstanzen nachzuvollziehen, die von runtime/tasks, query/tasks, history/historic-task-instances und query/historic-task-instances verwendet werden. Bestätige, wie businessKey für die Prozessinstanz jeder Task bereitgestellt wird, und überprüfe anschließend, dass alle vier Endpunkte processBusinessKey konsistent zurückgeben.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
api, backend
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.