{ "opencollection": "1.0.0", "info": { "name": "ThingsBoard Admin admin-controller rule-engine-controller API", "version": "4.3.0.3DEMO" }, "items": [ { "info": { "name": "rule-engine-controller", "type": "folder" }, "items": [ { "info": { "name": "Push Entity Message to the Rule Engine (handleRuleEngineRequest)", "type": "http" }, "http": { "method": "POST", "url": "https://demo.thingsboard.io/api/rule-engine/:entityType/:entityId", "params": [ { "name": "entityType", "value": "", "type": "path", "description": "A string value representing the entity type. For example, 'DEVICE'" }, { "name": "entityId", "value": "", "type": "path", "description": "A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates the Message with type 'REST_API_REQUEST' and payload taken from the request body. Uses specified Entity Id as the Rule Engine message originator. This method allows you to extend the regular platform API with the power of Rule Engine. You may use default and custom rule nodes to handle the message. The generated message contains two important metadata fields:\n\n * **'serviceId'** to identify the platform server that received the request;\n * **'requestUUID'** to identify the request and ro" }, { "info": { "name": "Push Entity Message with Timeout to the Rule Engine (handleRuleEngineRequest)", "type": "http" }, "http": { "method": "POST", "url": "https://demo.thingsboard.io/api/rule-engine/:entityType/:entityId/:timeout", "params": [ { "name": "entityType", "value": "", "type": "path", "description": "A string value representing the entity type. For example, 'DEVICE'" }, { "name": "entityId", "value": "", "type": "path", "description": "A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "name": "timeout", "value": "", "type": "path", "description": "Timeout to process the request in milliseconds" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates the Message with type 'REST_API_REQUEST' and payload taken from the request body. Uses specified Entity Id as the Rule Engine message originator. This method allows you to extend the regular platform API with the power of Rule Engine. You may use default and custom rule nodes to handle the message. The generated message contains two important metadata fields:\n\n * **'serviceId'** to identify the platform server that received the request;\n * **'requestUUID'** to identify the request and ro" }, { "info": { "name": "Push Entity Message with Timeout and Specified Queue to the Rule Engine (handleRuleEngineRequest)", "type": "http" }, "http": { "method": "POST", "url": "https://demo.thingsboard.io/api/rule-engine/:entityType/:entityId/:queueName/:timeout", "params": [ { "name": "entityType", "value": "", "type": "path", "description": "A string value representing the entity type. For example, 'DEVICE'" }, { "name": "entityId", "value": "", "type": "path", "description": "A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "name": "queueName", "value": "", "type": "path", "description": "Queue name to process the request in the rule engine" }, { "name": "timeout", "value": "", "type": "path", "description": "Timeout to process the request in milliseconds" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates the Message with type 'REST_API_REQUEST' and payload taken from the request body. Uses specified Entity Id as the Rule Engine message originator. This method allows you to extend the regular platform API with the power of Rule Engine. You may use default and custom rule nodes to handle the message. The generated message contains two important metadata fields:\n\n * **'serviceId'** to identify the platform server that received the request;\n * **'requestUUID'** to identify the request and ro" }, { "info": { "name": "Push User Message to the Rule Engine (handleRuleEngineRequest)", "type": "http" }, "http": { "method": "POST", "url": "https://demo.thingsboard.io/api/rule-engine/", "body": { "type": "json", "data": "{}" } }, "docs": "Creates the Message with type 'REST_API_REQUEST' and payload taken from the request body. Uses current User Id ( the one which credentials is used to perform the request) as the Rule Engine message originator. This method allows you to extend the regular platform API with the power of Rule Engine. You may use default and custom rule nodes to handle the message. The generated message contains two important metadata fields:\n\n * **'serviceId'** to identify the platform server that received the requ" } ] } ], "bundled": true }