REST connectors

Bonita native REST connectors allow to connect Bonita processes to any third-party with REST APIs.

Overview

The available REST connectors are:

HEAD: Use the HEAD HTTP verb to requests the metadata of a third-party resource in the form of headers
GET: Use the GET HTTP verb to retrieve resources from a third-party
DELETE: Use the DELETE HTTP verb to delete resources on a third-party
POST: Use the POST HTTP verb to create a resource on a third-party
POST FILE: Use the POST HTTP verb to upload files to a third-party
PUT: Use the PUT HTTP verb to update a third-party resource
PUT FILE: Use the PUT HTTP verb to update files to a third-party
PATCH: Use the PATCH HTTP verb to make partial changes to a third-party resource

REST connectors support SSL and proxy settings.

Connector Basic Parameters

Parameter name	Required information
URL	The REST service URL that identifies the resource
Content Type	The content type used in the payload: application/json, application/octet-stream, application/xml, application/x-www-form-urlencoded, text/html, text/plain, plain/xml
Charset	The charset used in the payload (by default UTF-8)
Payload	There are two ways to authenticate with a Json token (highly recommended) or with a P12 file
Document	For the PUT FILE and POST FILE connectors, the file to upload or update
Headers	The HTTP headers to be sent with the request. It is also possible to send predefined Bonita context headers such as task Id, case Id, process definition Id…

Parameter name

Required information

URL

The REST service URL that identifies the resource

Content Type

The content type used in the payload: application/json, application/octet-stream, application/xml, application/x-www-form-urlencoded, text/html, text/plain, plain/xml

Charset

The charset used in the payload (by default UTF-8)

Payload

There are two ways to authenticate with a Json token (highly recommended) or with a P12 file

Document

For the PUT FILE and POST FILE connectors, the file to upload or update

Headers

The HTTP headers to be sent with the request. It is also possible to send predefined Bonita context headers such as task Id, case Id, process definition Id…

Error Management

It is possible to make the connector fail on 5xx or 4xx response status codes (with exclusion on specific codes).

The request can also be replayed several times when it fails on 5xx or any other specific response status codes. The retry mechanism and configuration are the same as for the whole BPM engine works.