Use intuitive and consistent experience via a single, unified Camunda 8 API to query process data
User Problem
Customers perceive complexity when working with Camunda 8, handling multiple available API technologies - REST, gRPC, as well as the deprecated GraphQL API. There is no single C8 API. Users have to mix and match various APIs (Tasklist, Operate, Zeebe) to implement their use case.
As our APIs are fragmented, each component follows a different standard to build API i.e. request and response formats are different. Authentication, authorization and tenancy is implemented differently as well.
It's unclear for new users, which API to use and they have to explore the schema of different components' endpoints by themselves.
Operate FE uses an internal API that has more data than the public API. It's confusing for users and they are forced to use Operate internal API as the public one misses some information.
Release Notes
You can now use the unified Camunda 8 REST API to solve different automation use cases that previously required to use of different components' APIs. Easily find process data in a single API.
User Stories
As a developer, I can use C8 API to query data that were previously in Operate API
As a Developer, I'm sure all endpoints use the same schema for request and response
As a Developer, I can find all endpoints available for use and documentation in an OpenAPI schema and text-based documentation at docs.camunda.io. I can find information about all endpoints, which consist of the:
A clear description of what the endpoint is about
Name, type, and description of each parameter, including whether it’s optional or required
All possible responses, including expected\/possible error codes and their descriptions
Any deprecated endpoints should be identified
Models or schemas
As a Developer, I can use officially supported SDKs and API tools to explore and interact with migrated endpoints. Specifically, I can use the:
Value Proposition Statement
Use intuitive and consistent experience via a single, unified Camunda 8 API to query process data
User Problem
Customers perceive complexity when working with Camunda 8, handling multiple available API technologies - REST, gRPC, as well as the deprecated GraphQL API. There is no single C8 API. Users have to mix and match various APIs (Tasklist, Operate, Zeebe) to implement their use case.
As our APIs are fragmented, each component follows a different standard to build API i.e. request and response formats are different. Authentication, authorization and tenancy is implemented differently as well.
It's unclear for new users, which API to use and they have to explore the schema of different components' endpoints by themselves.
Operate FE uses an internal API that has more data than the public API. It's confusing for users and they are forced to use Operate internal API as the public one misses some information.
Release Notes
You can now use the unified Camunda 8 REST API to solve different automation use cases that previously required to use of different components' APIs. Easily find process data in a single API.
User Stories
Implementation Notes
POST .../v2/resource/searchPOSTendpoints. Only real-time (Zeebe) endpoints areGET:robot: This issue is automatically synced from: source