i2Rest_POST_data
Use this object to define parameters of sending request to API endpoint and processing API response
Field | Type | Description | Default value |
api_endpoint | string | REQUIRED. API endpoint
Defines URL to send HTTP request |
|
method | string | REQUIRED. HTTP method
i2Camunda will use this method when sending HTTP request to the API endpoint
|
|
body | string or object | REQUIRED. Request's body
Request body can be defined as simple string or as object
Examples: body: "{\"var1\":\"value1\"}" body: { string :"<var1>value1</var1>", mime_type:"application/xml" } body: { file_variable: "BODY" } |
|
token | string | OAuth2 authorization token
This value will be sent to API endpoint in Authorization:Bearer header |
|
client_id, client_secret | string | Client's ID and password
These values will be added to query part of API endpoint. Use these values to define client's ID and password |
|
headers | object | Additional request headers
This object is used to define additional headers of HTTP request to API endpoint. Headers object should be defined in the following form: header1: value1, header2: value2, ...etc... |
|
api_response_provided | integer | Size of allowed response
Maximum size of response that will be stored in response variable. If greater than zero, i2Camunda will save API response body to string response variable. The name of string response variable is defined in i2Camunda configuration object (i2camunda_response_file_variable, default - "i2camunda_response") |
|
file_api_response | object | Parameters of File response variable
If defined, i2Camunda will save response into File variable with following attributes (required properties of file_api_response object):
The name of File response variable is defined in i2Camunda configuration object (i2camunda_response_file_variable, default - "i2camunda_response_file") |
|
on_error | string | BPMN error code
If defined, i2Camunda will raise BPMN error with this code instead of creating incident. |