Index | Prev | Next

Http Client (httpClient-HttpClient)

This component is a standalone client, which you may use for making individual connections to single endpoints. You may use any type of request (GET/POST/PUT) with several configurations, such as parameters, headers and message body.
Figure 19.   Http Client properties
Image

To access, drag this component to a location in the station, then double-click it in the station.

In addition to the standard properties (Enabled and Health), this component provides these properties.

Property Value Description
Out text
Provides a current value, facets and status.
  • The value depends on the type of control point.
  • Facets, which define how the value displays, including the value’s number of decimal places, engineering units, or text descriptors for Boolean/enum states.
  • The current status of the data item, meaning the health and validity of the value. Status is specified by a combination of status flags, such as fault, overridden, alarm, and so on. If no status flag is set, status is considered normal and reports {ok}.
Address additional properties
Defines the address of the endpoint to which this client sends requests.

For property descriptions refer to “Address (httpClient-HttpAddress)”.
Method drop-down list
Selects a request method from:

GET: is used to request data from a specified resource.

POST: is used to send data to a server to create/update a resource. The data sent to the server with POST is stored in the request body of the HTTP request.

PUT: is used to send data to a server to create/update a resource. The difference between the POST and PUT request is that the PUT request are unchanged.

Headers additional properties
Contains additional information about an HTTP request or response sent between a client and server.

For property descriptions refer to “Headers (httpClient-HttpHeaders)”.
Parameters additional properties
Contains key/value pair parameters for the request.

For property descriptions refer to “Parameters (httpClient-HttpParameters)”.
Http Tuning Policy additional properties Configures network rules for evaluating both write requests to writable proxy points as well as the acceptable freshness of read requests.

For property descriptions refer to “Http Tuning Policy (httpClient-HttpStandaloneTuningPolicy)”.
Authenticator additional properties
Configures the authentication method.

For property descriptions refer to “Authenticator (httpClient-HttpAuthenticator)”.
Transport additional properties
Configures the underlying transport layer.

For property descriptions refer to “Transport (httpClient-HttpTransport)”.
Request Body additional properties
Configures the request body content.

For property descriptions refer to “Request Body (httpClient-HttpRequestBody)”.

Actions

  • Send sends the selected request.
  • Clear Last Result clears the previous result.
  • Add More adds more clients.

Related Links

  • Components (Parent Topic)

    • Index | Prev | Next