Array of supported Action types Array of current Action configurations Array of Actions to be configured on service provider Array of configured Actions with service provider assigned unique identifiers Array of tokens referencing existing Action configurations to be removed Array of Action configurations to update the existing action configurations Array of current Action Trigger configurations Action Triggers to be configured Returns configured Action Triggers with service provider assigned unique identifers Array of Action Trigger configurations to be updated. Array of tokens referencing existing Action Trigger configurations to be removed Describes the configuration parameters of an action. Action configuration parameter descriptions Action type name SupportedActions data structure lists the available action types that service provider supports. For each action type, data structure contains the action configuration parameters. Lists the location of all schemas that are referenced in the supported actions. If the action descriptions reference data types in the ONVIF schema file,the ONVIF schema file MUST be explicitly listed. List of actions supported by Action Engine Service provider. Action Engine Capabilities data structure contains the maximum number of supported actions and number of actions in use for generic as well as specific action types Limits for each action type The maximum number of trigger configurations that the service provider can concurrently support The maximum number of actions that the service provider can concurrently support ActionTypeLimits data structure contains maximum and current usage information for a specific action type in the service provider Action Type For the specific action type, the maximum number of actions that could be concurrently supported by the service provider For the specific action type, the number of actions in use by the service provider Action Configuration data type contains the configuration settings of action configuration parameters, service requester given action Name, and service provider supported action type value Action configuration parameter settings. User given name. Denotes the action type. Action data type contains the configuration settings of one action instance and service provider assigned unique identifier for this action configuration. Action configuration contains action type, user given action name, and configuratin parameter settings. Unique Action identifier that service provider assigned to the action configuration. Action Trigger configuration data type contains mandatory Topic Expression (Section Topic Filter in [Core Specification]), optional Message content expression (Section Message Content Filter in [Core Specification]), and set of actions to be triggered. Topic expression, for example, to trigger only for relays. Trigger based on event topic. Content expression, for example, to trigger only when the relay value is on. Trigger based on content data in event. Reference to actions to be triggered when the conditions are satisfied. Action Trigger data type contains the service provider assigned unique identifier for the configuration and action trigger configuration data. Action Trigger Configuration Action Trigger Configuration Unique Action Trigger identifier that service provider assigned to the action trigger configuration. SMTP EMail Server configuration POP EMail Server configuration Credentials configuration Destination SMTP Address configuration Destination POP Server Address configuration IP Address IP Address format type such as IPv4 or IPv6 Username Password Username-password Email server authentication mode Configuration for E-mail TO Configuration for E-mail CC Whether content of E-mail message contains event data MediaSource profile reference token Destination HTTP Server configuration Destination HTTP Server address configuration User Credentials configuration for destination HTTP Server URI for POST Message destination HTTP/HTTPS protocol selection (default is http) User credentials HTTP Authentication Method Destination HTTP Server IP Address IPv4 or IPv6 Port Number if different from 80 MediaSource reference when the media is attached to POST message Configuration for POST Message content Whether include event into POST message Whether attach media into POST message FTP Action destination configuration FTP Server IP Address Upload Directory Path User credentials confguration for target FTP Server User Credentials FTP Server IP Address IPv4 or IPv6 Port Number Name of file Suffix of file Upload Images action configuration Upload files action configuration Type of FTP Upload action Upload Image action; how long? Upload Image action; sample interval? Upload Image action; name of destination file Name of source file Name of destination file SMS Provider's URL Username and password Sender's e-mail address Text Message Length of recording time before the triggering event Recording after alarm recording duration Record duration Recording frame rate Whether Audio recording on/off Recording configuration The service provider returns the supported action types.
The response returns a list of Action Descriptions according to the Action Description Language.
The response also contains a list of URLs that provide the location of the schema files. These schema files describe the types and elements used in the Action Descriptions. If action descriptions reference types or elements of the ONVIF schema file, the ONVIF schema file shall be explicitly listed.
The service provider returns currently installed Actions. The create action operation adds actions to configuration. The create action operation is atomic. If a service provider can not create all of requested actions, the service provider responds with a fault message. The delete operation deletes actions. The delete action operation is atomic. If a service provider can not delete all of requested actions, the service provider responds with a fault message. The modify action operation modifies action configurations.
The modify action operation is atomic. If a service provider can not modify all of requested action configurations, the service provider responds with a fault message.
All action parameters, except the action type, can be modified. The service provider shall return InvalidAction error if the request attempts to change the action type with modify action request.
The get capabilities operation returns the Action Engine capabilities The service provider returns existing action triggers Creates action triggers. The create action triggers operation is atomic. If a service provider can not create all of requested action triggers, the service provider responds with a fault message. Deletes action triggers. The delete action triggers operation is atomic. If a service provider can not delete all of requested action triggers, the service provider responds with a fault message. Modifies existing action triggers. The modify action triggers operation is atomic. If a service provider can not modify all of requested action trigger configurations, the service provider responds with a fault message.