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

40169ccdec5c

rule-chain-controller

Get Rule Chains (getRuleChains)

Returns a page of Rule Chains owned by tenant. 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.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details.

Available for users with 'TENANT_ADMIN' authority.

get/api/ruleChains

Query parameters

ruleChainIdsstring[] required

A list of rule chain ids, separated by comma ','

pageSizeinteger required

Maximum amount of entities in a one page

pageinteger required

Sequence number of page starting from 0

type'CORE' | 'EDGE'

Rule chain type (CORE or EDGE)

textSearchstring

The case insensitive 'substring' filter based on the rule chain name.

sortProperty'createdTime' | 'name' | 'root'

Property of entity to sort by

sortOrder'ASC' | 'DESC'

Sort order. ASC (ASCENDING) or DESC (DESCENDING)

Response

OK

OR

Example response

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