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 Metadata object based on the provided Rule Chain Id. The metadata object contains information about the rule nodes and their connections.

Available for users with 'TENANT_ADMIN' authority.

get/api/ruleChain/{ruleChainId}/metadata

Path parameters

ruleChainIdstring required

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

Response

OK

versioninteger

Version of the Rule Chain

firstNodeIndexinteger required

Index of the first rule node in the 'nodes' list

Example response

{
  "ruleChainId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "RULE_CHAIN"
  },
  "nodes": [
    {
      "id": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "RULE_NODE"
      },
      "createdTime": 1609459200000,
      "ruleChainId": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "RULE_CHAIN"
      },
      "type": "com.mycompany.iot.rule.engine.ProcessingNode",
      "name": "Process sensor reading",
      "queueName": "Main",
      "configuration": {},
      "externalId": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "RULE_NODE"
      },
      "additionalInfo": {}
    }
  ],
  "ruleChainConnections": [
    {
      "targetRuleChainId": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "RULE_CHAIN"
      },
      "additionalInfo": {}
    }
  ]
}