Request API documentation for jBPM 5.2 REST interface

[stmarci]

Greetings!

Our company is planning to use jBPM 5.2 in one of our projects and would like to use the available REST interface for interacting with running process intances from a 3rd party application.

Suppose that the IP address of the server is a loopbak address, the following URL should point to the rest interface of the jbpm console:

http://localhost:8080/gwt-console-server

When clicking on the list of resources I think there should be a list of the avaialble REST methods, but there aren't any:

http://localhost:8080/gwt-console-server/rs/server/resources

I would like to know where can I find a comprehensive documentation for interacting with the running process instances through RESTful services. Although I found the annotated classes in grepcode, I think there should be a documentation somewhere describing the various parameters and options.

Thank you for your time and your help in advance,

Márton

[npereira]

Hi Marton,

The list you are searching it in the following address, for jBPM5.2:

http://localhost:8080/gwt-console-server/rs/server/resources/jbpm

It is just a list of REST services that can execute. Although, I must say it is not 100% accurate. (but if I'm wrong someone can correct me!)

For example,

The delete operation is stated as, /gwt-console-server/rs/engine/deployment/{id}/delete

but in reality is /gwt-console-server/rs/process/instance/{id}/delete

I don't know about official documentation, but what I'm using is debuging through the gwt-console! It uses the REST interface and at the bottom has a messages console that will tell you all the calls it is doing!

But I have learned that you have a couple of jira issues to address this:

https://issues.jboss.org/browse/JBPM-3577

https://issues.jboss.org/browse/JBPM-3212

[stmarci]

Thank you very much for this information!

I will take a look at the message console if I encounter a missing service!

I wish you the best,

Márton