Pull Data Node

This likely refers to a mechanism for on-demand data retrieval from devices or external sources, where the platform initiates data collection rather than relying on the devices to push data continuously.

What is a Pull Data?

The Pull Data provides users with a straightforward mechanism to interact with API endpoints by facilitating actions such as GET, POST, or PATCH requests. This node empowers users to retrieve data from external sources or send payloads to designated API endpoints within Rayven's workflows. By supporting various HTTP methods, including GET for fetching data, POST for submitting new data, and PATCH for updating existing data, the Pull Data offers flexibility in integrating with diverse APIs and services. Whether it's fetching information from external databases, submitting form data to web applications, or updating records in remote systems, this node streamlines the process of data exchange between the workflow and external endpoints, enhancing the efficiency and versatility of data-driven workflows.

Output

The Pull Data node will return the result from the API called.

How to Use

Implementation

In the Rayven Workflow Builder:

Select Inputs.
Drag the Pull Data node to the canvas.
Double click on the Pull Data node to open the configuration window.

Configuration

Section: General
This section contains basic configuration elements required for any Pull Data node implementation
Field	Requirement	Comments
Node Name	Mandatory	Enter a name for this node. This provides a handle to which you and others can refer, so it should be simple but meaningful and explain the node’s purpose.
API URL	Mandatory	Enter the API URL endpoint to pull data from or push the data to.
HTTP Method	Mandatory	Select a HTTP call method from the dropdown menu GET POST PATCH
Payload Format	Mandatory	Select the payload format from the dropdown menu JSON XML

Section: Advanced Features
Field	Requirement	Comments
Bearer Token	Optional	Provide the token used for API authorization and authentication.
Result To Field	Optional	Provide a new field name to hold the API output which will be appended to the existing payload. If left blank, the input payload will be overwritten by the output of the API call.
Body (for POST or PATCH)	Optional	Provide a JSON object when using POST or PATCH methods. Use <<_deviceid_>> as a placeholder for the Device Code. Use [[Field Name]] as place holder for value in JSON.
POST JSON	Optional	When the node is set to POST, the node can send either the fields set out in the Body (When using Post) field, or it can send the entire JSON payload.
URL Encoded Form	Optional	Use this option if x-www-form-urlencoded is required. When checked, users can input pairs - Name and Value. To add a new pair, click on “+ Add Pair”.

Section: Headers
Field	Requirement	Comments
Header 1	Optional	Multiple headers required for API call can be added by clicking on the ⊕ button.
Key	Optional	Provide header key for the API call.
Value	Optional	Provide header key for the API call.

Section: Cookies
Cookies are used when connecting with external server that demands cookies data as an identification
Field	Requirement	Comments
Cookie 1	Optional	Multiple headers required for API call can be added by clicking on the ⊕ button.
Name	Optional	Provide the cookie key for the API call.
Value	Optional	Provide the cookie value for the API call.

Section: Payload Date Settings
In the case that you would like the timestamp of the data to be based on the data coming from the device, and if the device is coordinated with a time zone, you will need to define the following three fields:
Field	Requirement	Comments
Date Field Name	Optional	Define the name of the date field coming in from your device
Date Format	Optional	Define the format of how the data will be coming through, for example: dd/MM/yyyy HH:mm:ss. If the date is coming through in 24 hour format, the hours need to be in capital letters, (ie. HH:mm:ss)
Timezone	Optional	Define from a drop down list, the time zone that the device is recording the data.

Section: Secure Authentication
Pull Data node supports Basic Authentication and Digest Authentication.
Field	Requirement	Comments
User Name	Optional	The username to access the API.
Password	Optional	The password to access the API.
Digest Auth	Optional	If the checkbox is unchecked, the node will use Basic Authentication. If the checkbox is checked, the node will use Digest Authentication

Activation

Once the node has been configured, click the Activate button and then click Save. The node is ready to call the API configured.