Skip to content

ActionEngine

ActionEngine service implementation.

ActionEngine

Bases: ONVIFService

0.0.1 2.2

ActionEngine service client.

Property Details
First introduced ONVIF 2.2 (September 2012)
Binding name ActionEngineBinding (ver10/actionengine.wsdl)
Operations actionengine.wsdl
Spec ActionEngine

GetServiceCapabilities 

GetServiceCapabilities()

The get capabilities operation returns the Action Engine capabilities.

Output
  • Capabilities [ActionEngineCapabilities]
    • MaximumTriggers - optional; [positiveInteger]
      The maximum number of trigger configurations that the service provider can concurrently support
    • MaximumActions - optional; [positiveInteger]
      The maximum number of actions that the service provider can concurrently support
    • ActionCapabilities - optional, unbounded; [ActionTypeLimits]
      Limits for each action type
      • Type - required; [QName]
        Action Type
      • Maximum - required; [positiveInteger]
        For the specific action type, the maximum number of actions that could be concurrently supported by the service provider
      • InUse - optional; [nonNegativeInteger]
        For the specific action type, the number of actions in use by the service provider
    • Extension - optional; [ActionEngineCapabilitiesExtension]

GetSupportedActions 

GetSupportedActions()

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.

Output
  • SupportedActions [SupportedActions]
    Array of supported Action types
    • ActionContentSchemaLocation - optional, unbounded; [anyURI]
      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.
    • ActionDescription - optional, unbounded; [ActionConfigDescription]
      List of actions supported by Action Engine Service provider.
      • Name - required; [QName]
        Action type name
      • ParameterDescription [ItemListDescription]
        Action configuration parameter descriptions
        • Name - required; [string]
          Item name. Must be unique within a list.
        • Type - required; [QName]
        • Name - required; [string]
          Item name. Must be unique within a list.
        • Type - required; [QName]
          The type of the item. The Type must reference a defined type.
        • SimpleItemDescription - optional, unbounded; [complexType]
          Description of a simple item. The type must be of category simpleType (xs:string, xs:integer, xs:float, ...).
          • Name - required; [string]
            Item name. Must be unique within a list.
          • Type - required; [QName]
        • ElementItemDescription - optional, unbounded; [complexType]
          Description of a complex type. The Type must reference a defined type.
          • Name - required; [string]
            Item name. Must be unique within a list.
          • Type - required; [QName]
            The type of the item. The Type must reference a defined type.
        • Extension - optional; [ItemListDescriptionExtension]
    • Extension - optional; [SupportedActionsExtension]

GetActions 

GetActions()

The service provider returns currently installed Actions.

Output
  • Action - optional, unbounded; [Action]
    Array of current Action configurations
    • Token - required; [ReferenceToken]
      Unique Action identifier that service provider assigned to the action configuration.
    • Configuration [ActionConfiguration]
      Action configuration contains action type, user given action name, and configuratin parameter settings.
      • Name - required; [string]
        User given name.
      • Type - required; [QName]
        Denotes the action type.
      • Parameters [ItemList]
        Action configuration parameter settings.
        • Name - required; [string]
          Item name.
        • Value - required; [anySimpleType]
          Item value. The type is defined in the corresponding description.
        • Name - required; [string]
          Item name.
        • SimpleItem - optional, unbounded; [complexType]
          Value name pair as defined by the corresponding description.
          • Name - required; [string]
            Item name.
          • Value - required; [anySimpleType]
            Item value. The type is defined in the corresponding description.
        • ElementItem - optional, unbounded; [complexType]
          Complex value structure.
          • Name - required; [string]
            Item name.
        • Extension - optional; [ItemListExtension]

CreateActions 

CreateActions(Action)

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.

Input
  • Action - unbounded; [ActionConfiguration]
    Array of Actions to be configured on service provider
    • Name - required; [string]
      User given name.
    • Type - required; [QName]
      Denotes the action type.
    • Parameters [ItemList]
      Action configuration parameter settings.
      • Name - required; [string]
        Item name.
      • Value - required; [anySimpleType]
        Item value. The type is defined in the corresponding description.
      • Name - required; [string]
        Item name.
      • SimpleItem - optional, unbounded; [complexType]
        Value name pair as defined by the corresponding description.
        • Name - required; [string]
          Item name.
        • Value - required; [anySimpleType]
          Item value. The type is defined in the corresponding description.
      • ElementItem - optional, unbounded; [complexType]
        Complex value structure.
        • Name - required; [string]
          Item name.
      • Extension - optional; [ItemListExtension]
Output
  • Action - optional, unbounded; [Action]
    Array of configured Actions with service provider assigned unique identifiers
    • Token - required; [ReferenceToken]
      Unique Action identifier that service provider assigned to the action configuration.
    • Configuration [ActionConfiguration]
      Action configuration contains action type, user given action name, and configuratin parameter settings.
      • Name - required; [string]
        User given name.
      • Type - required; [QName]
        Denotes the action type.
      • Parameters [ItemList]
        Action configuration parameter settings.
        • Name - required; [string]
          Item name.
        • Value - required; [anySimpleType]
          Item value. The type is defined in the corresponding description.
        • Name - required; [string]
          Item name.
        • SimpleItem - optional, unbounded; [complexType]
          Value name pair as defined by the corresponding description.
          • Name - required; [string]
            Item name.
          • Value - required; [anySimpleType]
            Item value. The type is defined in the corresponding description.
        • ElementItem - optional, unbounded; [complexType]
          Complex value structure.
          • Name - required; [string]
            Item name.
        • Extension - optional; [ItemListExtension]

DeleteActions 

DeleteActions(Token)

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.

Input
  • Token - unbounded; [ReferenceToken]
    Array of tokens referencing existing Action configurations to be removed
    Maximum length: 64

ModifyActions 

ModifyActions(Action)

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.

Input
  • Action - unbounded; [Action]
    Array of Action configurations to update the existing action configurations
    • Token - required; [ReferenceToken]
      Unique Action identifier that service provider assigned to the action configuration.
    • Configuration [ActionConfiguration]
      Action configuration contains action type, user given action name, and configuratin parameter settings.
      • Name - required; [string]
        User given name.
      • Type - required; [QName]
        Denotes the action type.
      • Parameters [ItemList]
        Action configuration parameter settings.
        • Name - required; [string]
          Item name.
        • Value - required; [anySimpleType]
          Item value. The type is defined in the corresponding description.
        • Name - required; [string]
          Item name.
        • SimpleItem - optional, unbounded; [complexType]
          Value name pair as defined by the corresponding description.
          • Name - required; [string]
            Item name.
          • Value - required; [anySimpleType]
            Item value. The type is defined in the corresponding description.
        • ElementItem - optional, unbounded; [complexType]
          Complex value structure.
          • Name - required; [string]
            Item name.
        • Extension - optional; [ItemListExtension]

GetActionTriggers 

GetActionTriggers()

The service provider returns existing action triggers.

Output
  • ActionTrigger - optional, unbounded; [ActionTrigger]
    Array of current Action Trigger configurations
    • Token - required; [ReferenceToken]
      Unique Action Trigger identifier that service provider assigned to the action trigger configuration.
    • Configuration [ActionTriggerConfiguration]
      Action Trigger Configuration
      • TopicExpression [TopicExpressionType]
        Topic expression, for example, to trigger only for relays. Trigger based on event topic.
        • Dialect - required; [anyURI]
      • ContentExpression - optional; [QueryExpressionType]
        Content expression, for example, to trigger only when the relay value is on. Trigger based on content data in event.
        • Dialect - required; [anyURI]
      • ActionToken - optional, unbounded; [ReferenceToken]
        Reference to actions to be triggered when the conditions are satisfied.
        Maximum length: 64
      • Extension - optional; [ActionTriggerConfigurationExtension]

CreateActionTriggers 

CreateActionTriggers(ActionTrigger)

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.

Input
  • ActionTrigger - unbounded; [ActionTriggerConfiguration]
    Action Triggers to be configured
    • TopicExpression [TopicExpressionType]
      Topic expression, for example, to trigger only for relays. Trigger based on event topic.
      • Dialect - required; [anyURI]
    • ContentExpression - optional; [QueryExpressionType]
      Content expression, for example, to trigger only when the relay value is on. Trigger based on content data in event.
      • Dialect - required; [anyURI]
    • ActionToken - optional, unbounded; [ReferenceToken]
      Reference to actions to be triggered when the conditions are satisfied.
      Maximum length: 64
    • Extension - optional; [ActionTriggerConfigurationExtension]
Output
  • ActionTrigger - optional, unbounded; [ActionTrigger]
    Returns configured Action Triggers with service provider assigned unique identifers
    • Token - required; [ReferenceToken]
      Unique Action Trigger identifier that service provider assigned to the action trigger configuration.
    • Configuration [ActionTriggerConfiguration]
      Action Trigger Configuration
      • TopicExpression [TopicExpressionType]
        Topic expression, for example, to trigger only for relays. Trigger based on event topic.
        • Dialect - required; [anyURI]
      • ContentExpression - optional; [QueryExpressionType]
        Content expression, for example, to trigger only when the relay value is on. Trigger based on content data in event.
        • Dialect - required; [anyURI]
      • ActionToken - optional, unbounded; [ReferenceToken]
        Reference to actions to be triggered when the conditions are satisfied.
        Maximum length: 64
      • Extension - optional; [ActionTriggerConfigurationExtension]

DeleteActionTriggers 

DeleteActionTriggers(Token)

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.

Input
  • Token - unbounded; [ReferenceToken]
    Array of tokens referencing existing Action Trigger configurations to be removed
    Maximum length: 64

ModifyActionTriggers 

ModifyActionTriggers(ActionTrigger)

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.

Input
  • ActionTrigger - unbounded; [ActionTrigger]
    Array of Action Trigger configurations to be updated.
    • Token - required; [ReferenceToken]
      Unique Action Trigger identifier that service provider assigned to the action trigger configuration.
    • Configuration [ActionTriggerConfiguration]
      Action Trigger Configuration
      • TopicExpression [TopicExpressionType]
        Topic expression, for example, to trigger only for relays. Trigger based on event topic.
        • Dialect - required; [anyURI]
      • ContentExpression - optional; [QueryExpressionType]
        Content expression, for example, to trigger only when the relay value is on. Trigger based on content data in event.
        • Dialect - required; [anyURI]
      • ActionToken - optional, unbounded; [ReferenceToken]
        Reference to actions to be triggered when the conditions are satisfied.
        Maximum length: 64
      • Extension - optional; [ActionTriggerConfigurationExtension]