Home

Rest Web Service Consumer

by Voodoo Editor
2 years ago
811 Views
0 Comments

Table of Contents


Rest Web Service Consumer

…

    • General Information

ParameterDescription

Name The name of rest web service consumer step. (Compulsory)
Description The description of step. (Not Compulsory)
    • Region

ParameterDescription

Related Flow Image The using image during this step. (Compulsory)
    • Action

This field plays a role in configuring the configuration settings for the related rest service.
Parameters are like below;

ParameterDescription

Endpoint This parameter is the relevant link connection parameter for data exchange to be used in rest service consumption.
Method It is the required method(GET, POST, PUT, UPDATE etc.) parameter for rest service usage.
Input This field is used to specify the parameters that will be used when calling the service. The parameter(s) can be defined with appropriate key-value pairs.

There are three input types: Key (constant), Value (dynamically enterable), Type (constant).

Path Parameters

    • Key

The Key Value targets a specific resource within the URL. For example, in the URL https://example.com/api/users/2, the users keyword specifies the resource type, and 2 represents a specific user.
(Example URL Key Value = users)

    • Value

The Value value represents a specific resource within the URL. For example, in the URL /users/2, the 2 value specifies the user ID.
(Example URL Value Value = 2)

Query Parameters

    • Key

The Key Value starts with a ? mark at the end of the URL, and key-value pairs are separated by &. For example, in the URL https://example.com/api/users?user_id=2&status=active, the user_id key specifies the user’s identity, and the status key specifies the user’s status.
(Example URL Key Value = user_id, status)

    • Value

The Value Value specifies certain data at the end of the URL. For example, in the URL https://example.com/api/users?user_id=2&status=active, the 2 and active values respectively specify the user ID and status.
(Example URL Value Value = 2, active)
Output Area: Data Source Adhering to the endpoint part of the service, it is the parameter that sets the information in which data source area the data that comes as a result of the input parameters will be stored.
Output Area: Data Field It is the parameter that sets the information in which data field the data coming from the rest service will be stored in the data source.
    • Time Settings

ParameterDescription

Maximum Step Duration The maximum time to the end of completion. (Compulsory)
Wait Duration After Operation The wait time to pass next step.(Compulsory)
    • Scenario Flow

ParameterDescription

Step Routing Method Indicates the step flow type. (Compulsory)

Ordered The flow type to continue sequentially.
Condition Based The flow type to continue conditionally.

    • Step To Run On Success

This step turns to another step on success. You can choose End to terminate the scenario step.

    • Step To Run On Fail

This step turns to another step on fail. You can choose End to terminate the scenario step.
Share on Pinterest