HTTP Asset Connection

Supported Providers

• ValueProvider

  • read ✔️

  • write ✔️

• OperationProvider ✔️

• SubscriptionProvider ✔️ (via polling)

Configuration Parameters

Asset Connection

Name	Allowed Value	Description
baseUrl	String	Base URL of the HTTP server, e.g. http://example.com
username	String	optional username for connecting to the HTTP server
password	String	optional password for connecting to the HTTP server

Value Provider

Name	Allowed Value	Description
format	JSON|XML	content format of payload
path	String	Path for the HTTP request, relative to the baseUrl of the connection
query	String	optional additional information how to extract actual value from received messages, depends on format, e.g. for JSON this is a JSON Path expression
template	String	optional template used to format payload when sending via HTTP
writeMethod	GET|PUT|POST	optional HTTP method to use when writing a value to HTTP, default: PUT

Example

{
	"format": "JSON",
	"path": "/foo",
	"query": "$.foo",
	"template": "{\"foo\" : \"${value}\"}",
	"writeMethod": "POST"
}

Operation Provider

Name	Allowed Value	Description
format	JSON|XML	content format of payload
path	String	Path for the HTTP request, relative to the baseUrl of the connection
method	PUT|POST	optional HTTP method to use, default: POST
template	String	optional template used to format payload when sending via HTTP
queries	Map	optional Map of result variable idShorts and corresponding query expressions to fetch them from returned value, query expressions depend on format, e.g for JSON these are JSON Path expressions

Example

Operation with input parameters in1 and in2 and output parameters out1 and out2

{
	"format": "JSON",
	"path": "/foo/execute",
	"method": "POST",	
	"template": "{\"input1\" : \"${in1}\", \"input2\" : \"${in2}\"}",
	"queries": {
		"out1": "$.output1",
		"out2": "$.output2"
	}
}

Subscription Provider

Name	Allowed Value	Description
path	String	Path for the HTTP request, relative to the baseUrl of the connection
interval	long	optional Interval to poll the server for changes (in ms), default: 100
method	GET|PUT|POST	optional HTTP method to use, default: GET
payload	String	optional Static content to send which each request

Example

{
	"path": "/foo",
	"interval": "500",
	"method": "GET",
	"template": "{\"foo\" : \"bar\"}"
}