C8 equivalent of C7 REST API

Camunda 8 Topics
1

Hi,

On C7 I was able to interact with the REST API to extract data and effect an instance. For example: I had the ability to get the data of a timer and trigger it. Could anyone please advice how to do this in C8 (8.5)? REST API doesn’t seem to have that capability. Is it only through Zeebe grpc?

2

Hi Pedro.

Thanks for your question. Please note, that we currently harmonize the REST API with 8.8 - so you should check there - as this will be extended compared to 8.5: Overview | Camunda 8 Docs. We want all functionality be available via REST which will also be the primary API technology - so you should not be forced to go to gRPC anywhere…

We also just kick of a project to document the before/after REST methods - but that might still need a bit to generate visible results.

What exact REST method are you searching for?

BEst
Bernd

3

Hi @BerndRuecker,

Thank you for reply. I can’t remember the name from the top of my head, but basically I’m looking for a combination of methods to retrieve tasks, sub processes, message events, and timers from a process instance and have the ability to alter them. For example, like I said in my original post, have the ability to get a timer and trigger it.

When at BP3 I worked in a pet project to create a sort of BPMN Assert library in node.js by leveraging the REST API of C7 and I was looking to do something similar in my current company but for C8. Having this is kind of useful when testing a process application.

Thanks again :slight_smile:

4

Hi Pedro.

We currently work on a Mapping Table for C7 to C8 REST API. We drafted this prototype to sketch the format we have in mind. What do you think of this?

https://camunda-community-hub.github.io/camunda-7-to-8-code-conversion/

It is filled from the two existing OpenAPI specifications plus a manual mapping which we just started to draft ourselves (hence the many “to be defined” in the table).

We sketched only three methods for the moment as an example:

  • GET /authorization
  • GET /process-definition
  • GET /process-instance

WDYT - would that be helpful?
Any other early feedback or thoughts?

Thanks
Bernd

5

Hi Bernd,

I like this mapping table. For C7 to C8 migrations something like this would be very helpful to find the resource and how it changed. For those that don’t have equivalent I think it would be valuable to have an explanation or the alternative. And a link to the swagger documentation :wink:

Appreciate the early peek into this :smiley: