REST V1 (Deprecated)

Know the component and how to use it.

The REST V1 is deprecated and no longer updated. Please refer to the document with the most recent version of the feature: REST V2.

REST V2 makes calls to REST endpoints from a pipeline.

Parameters

Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB).

Parameter	Description	Default Value	Data Type
URL	URL to be called - it may contain parameters following the {:param1} pattern, which will be replaced by the corresponding input message property.		String
Content Type	Configures the Content Type and encoding.		String
Verb	REST call type (GET, POST, and PUT).		String
Account	Account to be used by the component.		String
Connection Timeout	Connection expiration time (in milliseconds).		Integer
Reading Timeout	Maximum time for reading (in milliseconds).		Integer
Stop On Client Error	If activated, the option will generate an error and suspend the pipeline execution.	False	Boolean
Stop On Server Error	If activated, the option will generate an error and suspend the pipeline execution.	False	Boolean
Advanced Settings	Advanced configurations.		Object/Map
Inject JWT	If activated, the option inserts the present JWT into the pipeline call (whether generated by the JWT component or not) in the Authorization header of the REST call.	False	Boolean
Read JWT	If activated, the option puts as return the JWT that is in the internal header Authorization, if it exists.	False	Boolean
Raw Mode	If activated, the option receives or passes a payload without being JSON.	False	Boolean
Allow Insecure Calls To HTTPS Endpoints	When activated, the option allows non-reliable calls to HTTPS endpoints to be made.	False	Boolean
Enable Retries	When activated, the option allows new tries.	False	Boolean
Maximum Number Of Retries Before Giving Up	Maximum number of retries before giving up the call.	3	Integer
Time To Wait Before Each Retry	Maximum time between retries (in milliseconds).	1000	Integer
Compress Body With GZIP	When activated, the option allows the body to be compressed with GZIP.	False	Boolean

Path Parameter

Example

http://test.com/order/$EXPAND{:id,}

Query Parameter

Example

http://test.com/order$QUERY{page=:page,search=:search}\r\n\t\t\t

Messages flow

Input

application/x-www-form-urlencoded

{
	header: {
		"headerA":"valueA",
		"headerB":"valueB"
	},
		url: {
		"urlParam1": "paramValue"
	},
	formData: {
		"field1": "value1",
		"field2": "value2"
	}
}

multipart/form-data

{
	header: {
		"headerA":"valueA",
		"headerB":"valueB"
	},
	url: {
		
	},
	multiPartData: {
		"files": {
		"file_formName" "filename",
		"files_formName[]" ["filename1","filename2"]
	},	"fields": {
		"field1" : "value1",
		"field2" : "value2",
	}
	}
}

The component waits for a message in the following format:

{
	header: {
	"headerA":"valueA",
	"headerB":"valueB"
	},
	url: {
	"urlParam1": "paramValue"
	},
	body: {
	// message to be sent to the endpoint
	}
}

Output

• Successful

{
    status: XXX,
    body: {},
    headers: {}
}

• With error

{
    error: "error message",
    code: XXX,
    body: {},
    headers: {} 
}

In case of some errors, the body and headers will not be available.