Contents x
    API Output Node
        Contents

        API Output Node

            Article summary

            API Output Node

            The API Output node enables you to push information from Rayven to other applications. It can send either specific fields or the entire JSON content to another system.

            Adding an API Output node to your workflow

            1. First, select your desired solution and navigate to Rayven Workflow.
            2. Select ‘Outputs’ from the left-hand panel.
            3. Find the API Output node and drag it onto the canvas.
            4. Provide input to the API Output node by connecting it to another node
            5. Double click on the API Output node to open its configuration window.

            Configuring your API Output node

            1. First, give your node a Name. Choose something simple that clearly explains its purpose.
            2. If required, enter a Password for the webAPI. 
            3. Rayven will generate a mandatory Pull URL for the webAPI. The end of the URL should contain the Device ID. 
            4. Select Return Data as Received if you want the node to ignore any columns configured. This option will send the JSON data as-is. 
            5. Select the Outbound Payload Formatthe API will receive. Choose from the drop-down options:
              • JSON,
              • XML,
              • CSV.

            Customize output data using columns

            Each Column adds a field to the data accessed by the API node. Add new columns with the '+ Add Value' button and remove columns with the 'X' to the right of each row. To configure a column:

            1. Enter a Data Field Name. The first two columns created have the fixed default values of 'Device' and 'Event Time'. These columns add the device name and time the data reached the API node for the device. For additional columns, the value for Data Field Name should be the field name in the incoming JSON object containing the relevant data.
            2. Add a Display Name. This value should be the variable name displayed in the output (i.e., the JSON key).
            3. Choose your Field Selectionfrom the drop-down options:
              • Workflow Field: Display data from an incoming JSON object.
              • Custom Table Field: Display data from a custom table field. Allows users to select a field from a drop-down list.
              • Date: Display the date a device JSON reached the API node.
              • Device: Display the device name from device management.


            See Also: Adding Devices
            As of Release: 17.11.2021

            What's Next