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

40169ccdec5c

rule-chain-controller

Assign rule chain to edge (assignRuleChainToEdge)

Creates assignment of an existing rule chain to an instance of The Edge. Assignment works in async way - first, notification event pushed to edge service queue on platform. Second, remote edge service will receive a copy of assignment rule chain (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once rule chain will be delivered to edge service, it's going to start processing messages locally.

Only rule chain with type 'EDGE' can be assigned to edge.

Available for users with 'TENANT_ADMIN' authority.

post/api/edge/{edgeId}/ruleChain/{ruleChainId}

Path parameters

edgeIdstring required
ruleChainIdstring required

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": {}
}