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

40169ccdec5c

component-descriptor-controller

Get Component Descriptor (getComponentDescriptorByClazz)

Gets the Component Descriptor object using class name from the path parameters. Each Component Descriptor represents configuration of specific rule node (e.g. 'Save Timeseries' or 'Send Email'.). The Component Descriptors are used by the rule chain Web UI to build the configuration forms for the rule nodes. The Component Descriptors are discovered at runtime by scanning the class path and searching for @RuleNode annotation. Once discovered, the up to date list of descriptors is persisted to the database.

Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.

get/api/component/{componentDescriptorClazz}

Path parameters

componentDescriptorClazzstring required

Component Descriptor class name

Response

OK

createdTimeinteger

Timestamp of the descriptor creation, in milliseconds

type'ENRICHMENT' | 'FILTER' | 'TRANSFORMATION' | 'ACTION' | 'EXTERNAL' | 'FLOW'

Type of the Rule Node

scope'TENANT'

Scope of the Rule Node. Always set to 'TENANT', since no rule chains on the 'SYSTEM' level yet.

clusteringMode'USER_PREFERENCE' | 'ENABLED' | 'SINGLETON'

Clustering mode of the RuleNode. This mode represents the ability to start Rule Node in multiple microservices.

namestring

Name of the Rule Node. Taken from the @RuleNode annotation.

clazzstring

Full name of the Java class that implements the Rule Engine Node interface.

configurationVersioninteger

Rule node configuration version. By default, this value is 0. If the rule node is a versioned node, this value might be greater than 0.

actionsstring

Rule Node Actions. Deprecated. Always null.

hasQueueNameboolean

Indicates that the RuleNode supports queue name configuration.

{"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"
  },
  "createdTime": 1609459200000,
  "scope": "TENANT",
  "clusteringMode": "ENABLED",
  "name": "Custom Rule Node",
  "clazz": "com.mycompany.CustomRuleNode",
  "hasQueueName": true,
  "configurationDescriptor": {}
}