A Rule represents an Esper rule. At a minimum a Rule is associated to an Account and must have a name when created.
| name | data type | constraints | description |
|---|---|---|---|
| id | number | required | |
| accountId | number | required | |
| name | string | ||
| description | string | ||
| createdOn | number | ||
| createdBy | number | required | |
| modifiedOn | number | ||
| modifiedBy | number | required | |
| synchronizedOn | number | ||
| enabled | boolean | required | |
| query | string | ||
| ruleActionConfigurations | array of RuleActionConfiguration | ||
| optlock | number | required | The optlock field is used to detect that this entity has not been
modified by someone else. When updating an entity, first do a find to
get the latest version of the entity and note the value of the optlock.
Then in the update operation, set the optlock value to match the value
that you found. If someone else has updated the entity between your
find and update operations, the update will fail and the db/server will
return an error.
See this stackoverflow question for more information on optimistic locking. |
Example
{
"id" : 12345,
"accountId" : 12345,
"name" : "...",
"description" : "...",
"createdOn" : 12345,
"createdBy" : 12345,
"modifiedOn" : 12345,
"modifiedBy" : 12345,
"synchronizedOn" : 12345,
"enabled" : true,
"query" : "...",
"ruleActionConfigurations" : [ {
"name" : "...",
"parameters" : {
"parameter" : [ { }, { } ]
}
}, {
"name" : "...",
"parameters" : {
"parameter" : [ { }, { } ]
}
} ],
"optlock" : 12345
}