REST

Element

Function

The REST element can only be found inside an Integration element and is used in an EPC model to exchange data with a foreign system via REST protocol.

Connection

Predecessor: None
Successor: Function

Example

In the ACME User Database the ACME Corp. manages client addresses. A client's address shall be retrieved for the bidding process. During the process step Retrieving user data the ACME User Request formulated in the REST element is transferred to the ACME User Database. The database's answer is saved in the container.

Name

Name of the element within modeling.

ID

The read-only field contains the model ID of the element. Designers can use the ID for example in the search to link the element in other models.

Description

A commentary field for the modeler. Its content is invisible to users and its sole purpose is internal documentation.

Hashtags

Possibility to insert your own key terms . The leading hashtag sign # (hash) will be inserted automatically. Use the spacebar to insert multiple hashtags:

One hashtag may be issued for multiple elements:

URL Additions

This field defines the action to be executed by the REST system.

Example: Creating a new user

Instead of using a simple string, you can also enter a value to be evaluated.
Example: Retrieving a single user record

HTTP Method

Choose the corresponding HTTP method matching your REST action from the drop-down menu. The following methods are available:

MIME Type

Choose the corresponding MIME type matching your REST interface from the drop-down menu. The following types are available:

List of  Parameters

Contains the list of parameters to be transferred.

Example: A character string, an e-mail address and the age are to be transferred.

Header Fields

Here you may allocate explicit header fields, for example cookies, tokens etc.

Example: In the header field, credentials for authentication are saved.

Field Name in Container

Assign a name under which the server answer is saved in the container. If the Field Name in Container remains empty, integration.result will be used.

Without further modeling the data is volatile, meaning it has been deposited in the container, but not saved. For further information see Saving and Deleting Instances.