This Web service allows you to update an already existing rule. When a rule instance is updated, the old version is deleted and a new instance is created.
name: The unique name for this rule. The maximum name length size is 64 bytes. Quotation marks cannot be used.
description: A description of the rule.
attributes: Attributes for the rule that are specified by keyword and value pairs. For more information on attributes for specified rule types, see Table 1 and Table 2.
deploy: Indicates whether the rule is to be deployed. Valid values are true or false.
The following tables contain lists of keywords and example values for the attributes variable. For additional information on defining rules, see Business Rules.
Table 1 for Visitor Escorting and Items Association contains a list of valid keywords and values. It is important to note that all the keywords are required.
Keyword | Example value | Value description |
---|---|---|
zoneType | 1 | The following are valid values for zoneType:
|
zone | 2 | Depending on zoneType, this value represents either the zone ID or a zone class ID. |
alertActions | 3 | This value is a sum of the following possible
values:
In this example, the resulting value 3 is the sum of the value for a log alert (1) and a display alert (2). |
itemType1 | 3 | Keyword itemType1 corresponds
to the Visitor. Keyword itemType2 corresponds to
the Escort. Possible values can be one of the following:
|
itemType2 | 1 | |
item1 | 1 | Depending on itemType, this value represents either an item ID, a class ID, or a group ID. |
item2 | 4343 | |
additionalParameter1 | 30 | This value is the maximum tolerated distance,
in units, that the visitor can be away from the escort. Note: Currently,
the edge length of the visitor (who is in the container class) determines
the maximum tolerated distance.
|
additionalParameter2 | 400 | This value is the tolerated rule violation time, in seconds. |
For Duration of Stay in Zone, Maximum Items per Zone Threshold, Zone Access Restriction, Zone Exit Restriction, and Man Down Detection, Table 2 contains a list of valid keywords and values for the attributes variable. Only activityPattern is required by all the specified rule types. The additionalParameter1 keyword is required but only valid for Duration of Stay in Zone and Maximum Items per Zone Threshold.
Keyword | Example value | Value description |
---|---|---|
activityPattern | A: | This keyword is required. The activityPattern specifies
the time frame when the rule should be applied. The following is a
list of values for the rule's activity pattern:
|
class1 | 1 | This value represents the class
name to be included or excluded. Class parameters are used to define the actor for a rule. 1 |
exclClass1 | ||
group1 | 3 | This value represents the group
name to be included or excluded. Group parameters are used to define the actor for a rule. 1 |
exclGroup1 | ||
attrName1 | TagID, Label | This value represents the name
of the attribute used for the inclusion or exclusion filter. Attribute name parameters are used to define the actor for a rule. 1 2 |
exclattrName1 | ||
attrOperator1 | endsWith >= contains |
This value represents the operator
used for the inclusion or exclusion filter. The supported operator
values are:
Attribute operator parameters are used to define the actor for a rule. 1 2 |
exclattrOperator1 | ||
attrValue1 | 133 | The attribute value used for the
inclusion or exclusion filter. Attribute value parameters are used to define the actor for a rule. 1 2 |
exclattrValue1 | ||
Zone | 2 | Represents the zone name to be included or excluded. 3 |
exclZone | ||
zoneType | 6 | Represents the zone class name to be included or excluded. 3 |
exclZoneType | ||
alertActions | 3 | This value is a sum of the following possible
values:
In this example, the resulting value 3 is the sum of the value for a log alert (1) and a display alert (2). |
additionalParameter1 | varies depending on the rule | This keyword is required but only valid for
the following rule types:
|
This Web service returns nothing.
(attrName1 AND attrOperator1 AND attrValue1) OR (exclattrName1 AND exclattrOperator1 AND exclattrValue1)