REST services invocation considerations
From Business Process Management, BPM and Workflow Automation Wiki | BizAgi BPMS
Contents |
REST services invocation considerations
Considerations
When setting up REST services invocations in your Bizagi processes, the following topics should be taken into consideration:
1. Using HTTP basic authentication
You may include credentials if the REST Service requires authentication. These credentials involve: username, password and a domain (optional) for basic HTTP authentication. This information is typed for the interface configuration presented in the Systems module.
2. Interface values per environment
You may manage your REST service interface configuration anytime, should this service change its server. Through administration of interfaces, you may edit the Base URL's domain or the credentials used for authentication (domain, username and password). This can be done from the Management Console directly for each of your project's environment as well (Test or Production).
3. Interfaces administration
Whenever the Base URL of a REST service invocation is edited from the Interfaces wizard (development environment), Bizagi will treat this change as follows:
- If the domain part of the Base URL is edited, then this will be managed as a minor change involving the server providing this service, but not as a new interface (this means that a different mapping configuration is not required).
- If the part following the domain of the Base URL is edited, then this will be managed as a new interface configuration (different from the previous one). This requires going over the mapping to review that the corresponding parameters are configured.
- Any edition in the service URL will be managed as a new interface configuration (different from the previous one). This goes according to the validation in the Systems module in which you may not edit the service URL for a REST service interface, and similar to the afore mentioned, it requires going over the mapping configuration.
4. Sending information (content-type)
Bizagi sends out the content for the REST services invocation as content-type: "text/xml" (applies for POST and PUT HTTP methods). This information is already included within the REST invocation header.
5. URL maximum length
REST services requests are usually restricted by the URL character-length limit supported by browsers (http://www.boutell.com/newfaq/misc/urllength.html). The lower character-length limit in browsers is set by Internet Explorer (approximated to 2000 characters), to which Bizagi will apply this invocation restriction. This means that the sum of the Base URL and service URL for your REST service invocation cannot exceed 2000 characters.
6. Response format (XML)
Most all sites publishing resources as REST services, offer these services' response in both XML or JSON format. While working with REST services in Bizagi, ensure that you choose and consume this response information in the XML format.
Related Articles
<comments />
