Execute REST Service Template

The Execute REST Service template allows users to create an alternate language template to execute a REST service and assign the return value to a variable or field. In other words, it is a user customized form of the "execute REST service" template.

Consider the following rule authored in normal Business Language templates:

An example of using the finished assignment rule template in a language rule might be as follows: 

Here is how this template would be defined:

Here are the possible settings on this screen:

Name

Specifies the name of the vocabulary template. The name is used for irSDK access.

Display Name

Name of the template to be displayed in the business language template list.

Menu Group

Menu group under which the template will be listed. The user can choose to add his template to an existing menu group or can create his own menu group.

Scope

The scope of the template availability can be limited to only the context of the previously selected entity by checking "Available in rules and calculations for this entity." The availability can also be extended to those rule elements which have a reference to the previously selected entity by checking "Available in rules and calculations for entities referencing this entity."

Placeholders

The placeholders created in business language are configured here. For a detailed description of placeholders refer to "Configuring Placeholders".

Business Language

Business language to be displayed in the business language editor. Placeholders can be added to the template by enclosing them within $ symbols.

REST Service

REST Operation Specify the name of the REST Operation to use.

Inputs

For each parameter specified by the REST Operation, specify an expression to use.

Name and Type will be automatically populated from the REST Operation. Any function or field that returns the type specified is acceptable.

Assign Return To

Optionally specify a Field or variable to assign the return value of REST call. This value can be mapped into an entity field or collection with a subsequent action.