Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

rule-chain-controller

Get Rule Chain (getRuleChainById)

Fetch the Rule Chain object based on the provided Rule Chain Id. The rule chain object is lightweight and contains general information about the rule chain. List of rule nodes and their connection is stored in a separate 'metadata' object.

Available for users with 'TENANT_ADMIN' authority.

get/api/ruleChain/{ruleChainId}

Path parameters

ruleChainIdstring required

A string value representing the rule chain id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

Response

OK

createdTimeinteger

Timestamp of the rule chain creation, in milliseconds

namestring required

Rule Chain name

type'CORE' | 'EDGE'

Rule Chain type. 'EDGE' rule chains are processing messages on the edge devices only.

rootboolean

Indicates root rule chain. The root rule chain process messages from all devices and entities by default. User may configure default rule chain per device profile.

debugModeboolean

Reserved for future usage.

versioninteger
{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}
{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "RULE_CHAIN"
  },
  "createdTime": 1609459200000,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "name": "Humidity data processing",
  "type": "A4B72CCDFF33",
  "firstRuleNodeId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "RULE_NODE"
  },
  "configuration": {},
  "additionalInfo": {}
}