What is a HTTP Action?

Image Added

HTTP actions performs perform HTTP(S) requests to external APIs and returns return the response.

A HTTP action has two outputs. One input request will generate one output record, which will be sent on either the out or error output. A HTTP request will be triggered for each input record and generate one output record.

The response from the server (headers and body) will be treated as the result record, with the input attributes added as passthrough fields.

Creating HTTP Actions

1. Click and drag the 

   Insert excerpt
   _http _http nopanel true

    icon from the toolbar onto the canvas
2. Enter a name for the HTTP action, then select Create Action
3. In the HTTP action 

   Insert excerpt
   _property_settings _property_settings nopanel true

    on the right, populate the following details:

An Output Attributes section will be available on the http action editor. This will work the same way as the calculate and extractor nodes operation.

The result record will be structured equivalently to the following JSON document (there is no requirement to actually generate a JSON string to produce the document, just conceptually this is what the string would look like and JEP should operate as if it had come from the equivalent string.

• Result fields

  • body: the response body as a string (string)

  • url: the url the request was sent to (string)

  • status: the returned status code as an in (getCode()) (int)

  • status message: the returns status message (getReasonPhase()) (string)

  • status family: the returned status code family (100, 200, 300, 400, 500) (int)

  • error: true if internalError is true, or the error expression (or default expression) returned true (TrueFalse)

  • transmissionError: true if the error was generated internally by PhixFlow (e.g. a pseudo response for connection timed out etc) (TrueFalse)

  • headers: a map of header names → array of values ( headerName : [value1, value2]} (Structured Data)

The output attributes will default to have:

• status: _result.status

• status_message : _result.status_message

• contentType: _result.headers.”Content-Type”

• body _ result.body

Worked Example

4. 

5. Hover over the 

Output Connection Points

A HTTP action has two outputs. A HTTP request will be triggered for each input record and generate one output record, which will be sent on either the out or error output. 

The response from the server (headers and body) will be treated as the result record.

The output records contain the attributes specified by the output connection point. Successful records are passed down the out connection point and records containing an error are passed down the error connection point. The structure of the records by default are as follows:

Image Added

• • See below example where an Actionflow HTTP action is calling a PhixFlow API Endpoint

Headers

Headers are typically used to specify information for the request, such as character sets, session tokens or passwords. Headers can reference Secret Key Details, see below, using the syntax ${_datasource.SecretKey}

For example,

• Name: Authorization
• Expression: ${_datasource.MyKey}

Secret Key Details

Secret Keys allow sensitive data, such as passwords or security tokens, to be encrypted and stored in the PhixFlow Database. See Secret Key and Local Secret.

Image Added

Running HTTP Actions

Individual

Worked Example

Example

Shop Shipping Screen

Shop Shipping Popup Screen

Add an Actionflow to the button that is triggered by the button click

You may notice that right-clicking the button does not display the option to add an Actionflow. The Actionflow must be created using an event handler. See 2.01 Connecting Actionflows to Events.

HTTP Action Setup

1. Map across all attributes

Save Action and Open Screen Action Setup

Image Added