Alexei.baranov: Created page with "{{DISPLAYTITLE:i2Rest_POST_data}} Use this object to define parameters of sending request to API endpoint and processing API response {| style="width: 100%; vertical-align:top..."

2020-08-24T08:54:43Z

Created page with "{{DISPLAYTITLE:i2Rest_POST_data}} Use this object to define parameters of sending request to API endpoint and processing API response {| style="width: 100%; vertical-align:top..."

New page

{{DISPLAYTITLE:i2Rest_POST_data}}
Use this object to define parameters of sending request to API endpoint and processing API response
{| style="width: 100%; vertical-align:top; border-collapse:collapse" border="1"
| style="width: 10%; padding: 5px"|'''Field'''
| style="width: 10%; padding: 5px"|'''Type'''
| style="width: 40%; padding: 5px"|'''Description'''
| style="width: 40%; padding: 5px"|'''Default value'''
|-style="vertical-align:top;"
|style="padding: 5px"|api_endpoint
|style="padding: 5px"|string
|style="padding: 5px"|'''REQUIRED. API endpoint'''
Defines URL to send HTTP request
|
|-style="vertical-align:top;"
|style="padding: 5px"|method
|style="padding: 5px"|string
|style="padding: 5px"|'''REQUIRED. HTTP method'''
i2Camunda will use this method when sending HTTP request to the API endpoint<br/>
Valid values:
* *POST
* *GET
* *PUT
* *DEL
|
|-style="vertical-align:top;"
|style="padding: 5px"|body
|style="padding: 5px"|string or object
|style="padding: 5px"|'''REQUIRED. Request's body'''
Request body can be defined as simple string or as object<br/>
* String value will be sent as is. It should be a string in application/json format. Maximum length of body string is 5000 bytes
* When using object, body can contain following properties:
** string - provides body as a string (5000 bytes max)
** or file_variable - defines name of process variable (type File), which contain payload to be sent to API endpoint
** mime_type - type of body content. If not defined, "application/json" will be used for "string" body, for "file_variable" - content type of appropriate File variable<br/>
Examples:<br/>
body: "{\"var1\":\"value1\"}"

body: {
string :"<var1>value1</var1>",
mime_type:"application/xml"
}

body: {
file_variable: "BODY"
}
|
|-style="vertical-align:top;"
|style="padding: 5px"|token
|style="padding: 5px"|string
|style="padding: 5px"|'''OAuth2 authorization token'''
This value will be sent to API endpoint in Authorization:Bearer header
|
|-style="vertical-align:top;"
|style="padding: 5px"|client_id, client_secret
|style="padding: 5px"|string
|style="padding: 5px"|'''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
|
|-style="vertical-align:top;"
|style="padding: 5px"|headers
|style="padding: 5px"|object
|style="padding: 5px"|'''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...
|
|-style="vertical-align:top;"
|style="padding: 5px"|api_response_provided
|style="padding: 5px"|integer
|style="padding: 5px"|'''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")
|
|-style="vertical-align:top;"
|style="padding: 5px"|file_api_response
|style="padding: 5px"|object
|style="padding: 5px"|'''Parameters of File response variable'''
If defined, i2Camunda will save response into File variable with following attributes (required properties of file_api_response object):
* filename
* mimetype
* encoding
The name of File response variable is defined in i2Camunda configuration object (i2camunda_response_file_variable, default - "i2camunda_response_file")
|
|-style="vertical-align:top;"
|style="padding: 5px"|on_error
|style="padding: 5px"|string
|style="padding: 5px"|'''BPMN error code'''
If defined, i2Camunda will raise BPMN error with this code instead of creating incident.
|
|}

I2Camunda i2rest POST data - Revision history

Alexei.baranov: Created page with "{{DISPLAYTITLE:i2Rest_POST_data}} Use this object to define parameters of sending request to API endpoint and processing API response {| style="width: 100%; vertical-align:top..."