Summary

RestQuery is the component that creates HTTP connections. It uses all the configurations from the RestNetwork for it to create an HTTP connection.

When a request is successful, the data is then propagated to the points and artifacts contained in the RestQuery.

From a Networks perspective, RestQuery is the equivalent of a Device in Niagara.

 

Implementation

To create a RestQuery, simply drag the component from the palette or use the Rest Device Manager to add a new RestQuery.

Properties

  • Status: RestQuery status. Can be {ok}, {disabled}, {fault}, {alarm}, {down}, {unackedAlarm}.
  • Enabled: Enables or disables RestQuery. If disabled, this RestQuery does not communicate.
  • Fault Cause: Indicates the RestQuery fault reason.
  • Health: Stores the RestQuery status. Indicates if there is an alarm, loss of communication and the time at which it changed state.
  • Alarm Source Info: Configures the RestQuery alarm.
  • Http Config: Configures the HTTP request. For more details, see the article Http Config.
  • Points: Container for control points. All checkpoints have a RestPointProxyExt to manage their communication.
  • Artifacts: Container for ArtifactDefinition.

Actions

  • Ping: The action launches an HTTP request based on the entire Http Config between the RestNetwork and the RestQuery where the action originates. If the query is successful, then the points are updated with the results of the query.

The action launches the same queries as RestQuery in normal operation. If the Ping fails then RestQuery is misconfigured.