Monitor progress of process instance on BPMN diagram via API

Value Proposition Statement

Render BPMN diagram and monitor the progress of processes in self-developed UI with API endpoint.

User Problem

Currently, Operate API is missing an important data for customers - to provide status of running and finished instances in deployed diagrams and render deployed BPMN diagram based on it. When developers need to build custom UI for internal or external users in their systems and want to provide information about a process status they're unable to do so. Often times this blocks from connecting process with other data to provide a seamless user experience. Summary: Customer cannot build a process visualization - we don't provide sufficient data for that.

User Stories

As a developer, I can fetch data from Operate via API to show status of running or finished process instance to the end-user on a deployed diagram in custom UI application
As a developer, I can check where process instances are on the specific rendered process definition with number of process instance
As a developer, I can display the current state of the instance or the current location of the tokens and highlighting the executed path of the tokens.
- If the call activity or subprocess has an incident state, it's also visible on the parent process instance - like in Operate UI
As a Developer I can read the documentation with examples, how to generate diagram in external service, based on the Operate data and bpmn.js library

Implementation Notes

We should aim to have similar way of using this feature, as we had in C7 -> we should look at C7 REST API while building the concept for this epic.

C7 Example:

The end user should see:

It would make sense to write a blog post, how to monitor progress in the custom UI.

Breakdown

This section links to various sub-issues / -tasks contributing to respective epic phase or phase results where appropriate.

[x] https://github.com/camunda/operate/issues/3946

Discovery phase

Define phase

Design Planning

Reviewed by design: Jan 2023
Designer assigned: No Design Necessary

Implement phase

Validate phase

^{:robot: This issue is automatically synced from: source}

camunda / issues