Connector.restCall
Last updated
Last updated
Performs a rest API call using a Rest Connector.
| Name | Description | Input Type | Default | Options | Required |
|---|---|---|---|---|---|
Cookies of the API call. Will contain a single object, or a list of one (1) or more objects which consist of:
The path to the selected file. Will contain a single object, or a list of one (1) or more objects which consist of:
The action performed if this function runs successfully.
The action performed if this function runs successfully.
Coming Soon.
Coming Soon.
Coming Soon.
Coming Soon.
| Key | Description | Input Type | Required |
|---|---|---|---|
| Key | Description | Input Type | Required |
|---|---|---|---|
| Description | Output Type |
|---|---|
| Key | Description | Output Type |
|---|---|---|
| Description | Output Type |
|---|---|
| Key | Description | Output Type |
|---|---|---|
| Description | Output Type |
|---|---|
| Key | Description | Output Type |
|---|---|---|
connector
The Rest Connector to be used.
Text
-
-
Yes
path
The additional path to append to the connector's url.
Text
-
-
No
method
The http request method.
Text
Get
Get, Patch, Put, Post, Delete
No
query
The query string for the endpoint.
Object
-
-
No
callType
The content type of the API.
Text
Raw
Form_Data, X_WWW_Form_URL_Encoded, Raw, Binary, JSON
No
headers
The query string for the endpoint.
Object
-
-
No
cookies
The cookies of the API call.
Object / List
-
-
No
resultType
The preferred result to return.
Text
String_UTF8
String_UTF8, Byte_Array
No
body
The body to pass along in the call.
Object / Text
-
-
No
attachment
The path to the selected file.
Object / List
-
-
No
extra
The stored value that is passed to all the callbacks.
Any
-
-
No
name
Name of the cookie.
Text
No
value
Contains the value of the cookie.
Text
Yes
name
Optional name. If not specified, file name will be used.
Text
No
value
Contains the direct file path of the attachments.
Text
Yes
Returns the formatted information.
Object
success
Boolean value to denote whether the function was executed successfully.
Text
message
The message to print.
Text
data
Any additional message or data to print.
Text
Returns an object with the information of the API call.
Object
statusCode
The status code of the API call.
Number
result
The result of the API call.
Text
cookies
The cookies of the API call.
Object
Returns an object with the information of the API call.
Object
statusCode
The status code of the API call.
Number
errorMessage
The error message for unsuccessful API call.
Text