Get Rule

GET 
/rulesets/:rulesetId/rules/:ruleId

Returns a rule in a ruleset; available as an Add-On Module

Request

Path Parameters

rulesetId stringrequired

Ruleset Identifier

ruleId stringrequired

Rule Identifier

Query Parameters

siteId string

Site Identifier

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

rule

object

ruleId string

Workflow to start on matching of conditions

priority number

Rule priority

description string

Ruleset description

workflowId string

Workflow to start on matching of conditions

status RulesetStatus (string)

Status of the Ruleset

Possible values: [ACTIVE, INACTIVE]

conditions

object

must

object[]

List of rule conditions

Array [

attribute RuleConditionAttribute (string)

Rule condition attribute (deprecated, use Criterion)

Possible values: [TEXT, CONTENT_TYPE, BARCODE, FIELD, ATTRIBUTE]

criterion RuleConditionCriterion (string)

Rule condition attribute

Possible values: [TEXT, CONTENT_TYPE, BARCODE, FIELD, ATTRIBUTE]

attributeKey string

Rule attribute key (only required for ATTRIBUTE criterion)

fieldName string

Rule field name (only required for FIELD criterion)

value string

Rule condition value

operation RuleConditionOperation (string)

Rule condition attribute

Possible values: [EQ, CONTAINS]

]

Example (from schema)

{
  "rule": {
    "ruleId": "string",
    "priority": 0,
    "description": "string",
    "workflowId": "string",
    "status": "ACTIVE",
    "conditions": {
      "must": [
        {
          "attribute": "TEXT",
          "criterion": "TEXT",
          "attributeKey": "string",
          "fieldName": "string",
          "value": "string",
          "operation": "EQ"
        }
      ]
    }
  }
}

Loading...