RestCallbackQuery

Summary

RestCallBackQuery is a component which receives its requests though a RestCallBackServlet. The selected servlet will propagate its received requests to this component which will then propagate them to its descendant points and artifacts.

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 to a RestNetwork or use the Rest Device Manager to add a new RestQuery and select an existing callback servlet in the CallBackConfig slot.

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.
• CallBackConfig: Servlet which will be the source of the requests propagated to this components points and artifacts
• ResponseFilter:  SFormat allowing to filter the received responses. If left empty, all the received responses will be propagated
• Artifacts: Container for ArtifactDefinition.