ConfigRule

Sample shape for ConfigRule.

Sample shape for ConfigRule.

Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response.

{
  "name": "Example name",
  "description": "Example description.",
  "active": false,
  "owner": "<content-owner>",
  "ownerId": "<owner_id>",
  "trigger": "<rule-trigger>",
  "triggerEvent": "<rule-trigger-event>",
  "triggerInterval": "example",
  "container": [
    "example"
  ],
  "conditionGroup": [
    "<config-condition-group>"
  ],
  "actionValue": [
    "<config-rule-action-value>"
  ],
  "actionEndpoint": [
    "<config-rule-action-endpoint>"
  ]
}

Fields

Field	Type	Required	Notes
entity	string • nullable	Server-set	Set by the server. Read-only on writes.
name	string	Required
description	string	Optional
active	boolean	Optional
owner	ContentOwner	Optional
ownerId	string	Optional
trigger	RuleTrigger	Optional
triggerEvent	RuleTriggerEvent	Optional
triggerInterval	string	Optional
container	array<string>	Optional
conditionGroup	array<ConfigConditionGroup>	Optional
actionValue	array<ConfigRuleActionValue>	Optional
actionEndpoint	array<ConfigRuleActionEndpoint>	Optional
tenantId	string	Server-set	Set by the server. Read-only on writes.
id	string	Server-set	Set by the server. Read-only on writes.
created	string (date-time)	Server-set	Set by the server. Read-only on writes.
createdBy	string	Server-set	Set by the server. Read-only on writes.
updated	string (date-time)	Server-set	Set by the server. Read-only on writes.
updatedBy	string	Server-set	Set by the server. Read-only on writes.
deleted	boolean	Server-set	Set by the server. Read-only on writes.

Used by

Request body

• POST /api/rule
• PUT /api/rule

Response body

• GET /api/rule/{id}
• GET /api/rule

CLI

ekso rule — see the command branches page for available verbs. Body for create / update verbs typically passed via --data @file.json matching the sample JSON above.