Skip to main content Skip to complementary content

Creating a REST Service from a BPM process deployed on Bonita BPM Portal

About this task


  • Bonita BPM Portal is up and running.

  • The process from which you want to create a REST Service has been deployed on Bonita BPM Portal. For details of how to deploy a process on Bonita BPM Portal, see the Bonita documentation.

Once you have selected the From Bonita BPM Portal option in the Create Service From BPM Process wizard, do the following.


  1. In the Process tree structure, select the BPM process from which you want to create a Service.
  2. By default, all the fields corresponding to the variables defined in the BPM process are selected. If required, clear the Name check box of a field, and then choose one of the following options from the Non-request Field Type list field:
    • Custom: to leave an empty value for the field; if needed, you can specify a custom value or expression for the column corresponding to this field in the output table of the first tXMLMap component in the generated Job, to pass custom information to the BPM process, before running the Job to start the Service. This is the default option for a non-request field.

    • Security Token: use this field to pass the Security Token, if any, in the service request to the BPM process.

    • Correlation ID: use this field to pass the correlation ID, if any, in the service request to the BPM process.

  3. Select the REST Service option, and edit the REST configuration if needed.




    URI location where the REST Service will be accessible for requests.

    Uri Pattern

    REST-ful URI that describes the resource.


    Name of the Job that will be created.

  4. Click Finish. The related Job and the metadata are created in the Repository tree view, and the Job is automatically opened on the design workspace.


You can now:

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!