"Copy to" Actions

Parameter

Description

Template engine

Encode, Velocity

To see examples of velocity functions, please see an article: Functions and Variables

HTTP URL

Request URL that can be processed by the external server. For example:

http://httpbin.org/post

HTTP Method

GET, POST, PATCH, PUT, DELETE

Authenticate With Connected Service

Enables authentication by selected connected service.

Currently the 2 types of the authenticating connected service types are available:

- OAuth2 connected service

- HTTP Request Headers

Connected service

Select authenticating connected service

Content Type

Type of the content to be sent by POST or PUT request methods.

• application/json 

• application/x-www-form-urlencoded

• multipart/form-data

Multipart File Parameters

Available when "multipart/form-data" is selected in the Content type selectbox. This allows to configure support of multipart file upload in requests sent in HTTP action.

The Source Holder drop down allows to select the Media file holder as a source of file for the request. Both original and custom media holders configured in the module will be available for selection.

Please, note!

Selecting custom media holder as a file source will not work on new item creation or upload of the new file(s), as previews will not be generated before the action will be triggered which means that the file will not be sent.

File Output Name input field allows to specify an alternative filename so that it can be used as a unique key when integrating with 3rd party applications.If the property is empty - original filename is used.

Formulas to concatenate file name from few fields are supported.

To see examples of velocity functions, please see an article: Functions and Variables

As an example:

• if "Velocity" template engine is selected ${CurrentItem.fieldValue('Name')}-$CurrentItem.getId() formula allows to insert value from "Name" field and itemId in filename 

NOTE:

file name is allowed to use for both single and multiple file field

• For single file field or multi-file field with limit of 1 the specified variables are used

• For multi-file field with limit greater than 1 {number} suffix is added to file name

Request Body

Used when application/json content type is selected. Specify the valid JSON here. It is possible to use placeholders inside the JSON, so you can send the specific item's data to the server. For example:

{
  "id": 6290,
  "name": "TestName"
}

Note!
For "Delete"-type actions, the following syntax should be used to fetch field values:

$CurrentItem.changes().oldValue(yourFieldId)

Request Parameters

Used when application/x-www-form-urlencoded content type is selected. You can create the pairs "Name-Value" which will be sent as encoded form data. It is possible to use placeholders inside the parameter value

Request Headers

Allows adding the "Name-Value" pairs  which will be sent as request headers on action triggering. It is possible to use placeholders inside the parameter value.

Map Response Data

Allows mapping the JSON response to encode fields of the item.

"Skip Empty Response" checkbox

It allows to control whether empty JSON pointer are returned as warnings or ok to reduce noise on logs

• When TRUE it should treat empty responses as OK in logs

• When FALSE it should continue to treat empty responses as a warning in logs

As per version 11.0.0 the following field types are supported in response mapping:

• text

• date (date, week, month, datetime) - site locale/TZ applied

• options (single select fields only)

• module links (single and multiple only by option ID)

• integer - site locale/TZ applied

• decimal - site locale/TZ applied

As per version 11.3.0 the following additional field types are supported in response mapping:

• Single file fields as response values (11.3.0)

• Multi file fields as response values (11.3.0)

It is possible to map the response value to a singe file or multi file field both on existing record ( Update ) and on new record ( Create ).

Media Converters can be used for Single file field only.

If Version Control is enabled a new version is created each time item is updated. Currently this is only available for Single file fieds.

The Mapping works for both 'Encode' and 'Velocity' as Template engine.

When file name is not specified on the 'Configuration' field in the Action, then original file name is used as returned by API call.

• Mapping multiselect fields with string values (11.3.0)

This enabled the option to set multi-module link fields by string values

Checkbox in Configuration for to select 'Map Id' or 'Map Value', is only shown when Field type is ModuleData or CheckBox or MultiSelect or SelectBox or RadioBox or Status.

Example of the Request Body for above:

{ "ClientsMulti": ["Client 1","Client 2","Client3"],
"checkbox": ["ch1","ch2","ch3"]
}

Keywords in Response Path:

Using the mapping, it will be easy to check the request status and receive the data. It is possible to use such keywords in Response Path:

• statusCode — HTTP status code of the response;

• headers. — inserts value of the specified response header parameter;

• body — inserts the entire response body to the mapped field;

Parameters:

Starting from version 17:

• $.param1  or $['param1'] — inserts the value of the specified parameter in the JSON body From version 17.0.0 onward

Version 9.95.0 - 16.0.5:

• /  — inserts the value of the specified parameter in the JSON body. For versions earlier than 17.0.0

• //— inserts the value of the nested parameter from the inner response object in the JSON body 

Before version 9.95.0:

• • For versions earlier than 9.95.0 - body.

• • For versions earlier than 9.95.0 - body..inserts the value of the nested parameter from the inner response object in the JSON body.

Response Path in versions 16 and earlier:

e.g.  /fields/1/options/0/value

Response Path from version 17 onward:

e.g. $.fields[1].options[0].valueOR $['fields'][1]['options][0]['value

Example

Having the response:

Status: 200 OK
Date: Tue, 30 Apr 2019 09:24:26 GMT
Content-Type: application/json;charset=UTF-8
[
  {
    "id": 1,
    "name": "Leanne Graham",
    "username": "Bret",
    "email": "Sincere@april.biz",
    "address": {
      "street": "Kulas Light"
    },
    "phone": "1-770-736-8031 x56442",
    "company": {
      "name": "Romaguera-Crona"
    }
  },
  {
    "id": 2,
    "name": "Ervin Howell",
    "username": "Antonette",
    "email": "Shanna@melissa.tv",
    "address": {
      "street": "Victor Plains"
    },
    "phone": "010-692-6593 x09125",
    "company": {
      "name": "Deckow-Crist"
    }
  }
]

From Version 17 onward:
We can fetch the data to the fields using Response Path keywords. In the current example they will return:

• $[0].name or $[0]['name'] → Leanne Graham

• $[1].name or $[1]['name'] → Ervin Howell

• $[-1].name or $[-1]['name'] → Ervin Howell (-1 = last element)

• $[1].address.street or $[1]['address']['street'] → Victor Plains

The dot-separated notations are preferable and recommended for usage for properties with simple names.

But notations with brackets are safer (for example with property names with dots, or names that contain a lot of characters.

It is now possible to extract a property from the last object of json array using the[-1] in the path (when the number of objects in the array is unknown).

For more details go to the documentation (version 17 and later).

Versions 9.95-16.0.5:
We can fetch the data to the fields using Response Path keywords. In the current example they will return:

• statusCode →  200

• headers.date → "Fri, 03 May 2019 12:23:32 GMT"

• /0/name   →  Leanne Graham

• /1/name  →  Ervin Howell

• /1/address/street → Victor Plains

Note! Value will not be copied to the target field if Response Path contains character '#', because it's referenced value is the root of the document.

For more details go to the documentation (version 16 or earlier).

Notifications will be sent after HTTP Copy

Field contains a list of Notifications Rules with Sub-Type 'Copy to HTTP Action' created on the site. For more details go to the documentation.