REST API

overview rest api integration enables an edge system to connect with restful api supported communication outbound (publish data from edge to rest server ) yes inbound (subscribe data from rest server to edge) no configurations variable detail required name enter a name for the connector yes method http methods in rest apis get, post, put, and delete yes endpoint endpoints are the entry points to interact with the api yes headers a request header is an http header that can be used in an http request to provide information about the request context yes params url parameters (query strings) additional information for a given url no mapping data from a payload could be mapped into a custom one example {"from" "to"} where "from" is a key from predefined payload, and "to" is a key from destination payload no parallel publish count parallel publish count indicates how many data streams or data items are being sent from the edge system to a central system or cloud simultaneously yes insecure skip verify insecureskipverify controls whether a client verifies the server's certificate chain and host name select to disable verification no oauth2 token endpoint token endpoint url yes oauth2 client secret oauth2 client secret key yes oauth2 client id client id yes oauth2 scope scope (comma separated value) yes throttling limit set a limit on the number of outbound messages per second if sending data to a server that has restrictions on the rate of incoming messages, this ensures that no messages are lost no persistent storage if enabled, messages in the outbound queue are stored on disk if there are interruptions in connection or power loss, messages will be retained and eventually sent when the connection is restored no queue mode select the sequence of data transfer fifo or lifo selecting fifo (first in first out) will send the earliest message first selecting lifo (last in first out) will send the latest message first no