REST action

The action is used for publish output message into a RESTful API.

Property name Optional Description
method true The HTTP method for the RESTful API. It is a case insensitive string whose value is among “get”, “post”, “put”, “patch”, “delete” and “head”. The default value is “get”.
url false The RESTful API endpoint, such as https://www.example.com/api/dummy
bodyType true The type of the body. Currently, these types are supported: “none”, “json”, “text”, “html”, “xml”, “javascript” and “form”. For “get” and “head”, no body is required so the default value is “none”. For other http methods, the default value is “json” For “html”, “xml” and “javascript”, the dataTemplate must be carefully set up to make sure the format is correct.
timeout true The timeout (milliseconds) for a HTTP request, defaults to 5000 ms
headers true The additional headers to be set for the HTTP request.
debugResp true Control if print the response information into the console. If set it to true, then print response; If set to false, then skip print log. The default is false.
insecureSkipVerify true Control if to skip the certification verification. If it is set to true, then skip certification verification; Otherwise, verify the certification. The default value is true.

::: v-pre REST service usually requires a specific data format. That can be imposed by the common sink property dataTemplate. Please check the data template. Below is a sample configuration for connecting to Edgex Foundry core command. The dataTemplate {{.key}} means it will print out the value of key, that is result[key]. So the template here is to select only field key in the result and change the field name to newKey. sendSingle is another common property. Set to true means that if the result is an array, each element will be sent individually. :::

  1.     {
  2.       "rest": {
  3.         "url": "http://127.0.0.1:59882/api/v1/device/cc622d99-f835-4e94-b5cb-b1eff8699dc4/command/51fce08a-ae19-4bce-b431-b9f363bba705",       
  4.         "method": "post",
  5.         "dataTemplate": "\"newKey\":\"{{.key}}\"",
  6.         "sendSingle": true
  7.       }
  8.     }

Visualization mode

Use visualization create rules SQL and Actions

Text mode

Use text json create rules SQL and Actions

Example for taosdb rest：

  1. {"id": "rest1",
  2.   "sql": "SELECT tele[0]-\u003eTag00001 AS temperature, tele[0]-\u003eTag00002 AS humidity FROM neuron", 
  3.   "actions": [
  4.     {
  5.       "rest": {
  6.         "bodyType": "text",
  7.         "dataTemplate": "insert into mqtt.kuiper values (now, {{.temperature}}, {{.humidity}})", 
  8.         "debugResp": true,
  9.         "headers": {"Authorization": "Basic cm9vdDp0YW9zZGF0YQ=="},
  10.         "method": "POST",
  11.         "sendSingle": true,
  12.         "url": "http://xxx.xxx.xxx.xxx:6041/rest/sql"
  13.       }
  14.     }
  15.   ]
  16. }