Get a list of rules
GET {{baseUrl}}/rules?filter=<string>&size=<integer>&page=<integer>
Get rules according to the provided query parameters.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
filter | string | Filter as JSON object with supported fields assetType (string), active (boolean). Including the field assetType with a valid asset type as value will filter all rules for this asset type. Including the field active with a boolean value will filter active or inactive rules. | |
size | string | The maximum number of rules returned on each page. Defaults to 20 rules per page if parameter is not provided. Maximum value is limited to 200. | |
page | string | Zero based index of requested page. Page 0 is returned by default if parameter is not provided. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"_embedded":{"rules":[{"ruleId":"580a52f638394c8ab35f22f03556a7ed","assetType":"myiottenant.GearBox","assetIds":["9f81490428644ff995b0e3590f21ef57","76a1388fee23496bacac9bc378aa65fe"],"name":"Gear box temperature \u003e 85°C","description":"Raise warning if gear box temperature exceeds 85°C","active":false,"lastChangedActive":"2022-05-30T05:38:16.438Z","creator":"\u003cName of user that has initially created the rule\u003e","created":"\u003cDate and time of rule creation\u003e","editor":"\u003cName of user that has last updated the rule configuration\u003e","edited":"\u003cDate and time of last rule update\u003e","etag":"4b4283c1ba936b7ed38ba4dd936d79e4","evaluations":[{"property":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"condition":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"hysteresisAbsolute":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"debouncingTime":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"threshold":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lowerLimitThreshold":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"upperLimitThreshold":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"property":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"condition":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"hysteresisAbsolute":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"debouncingTime":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"threshold":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lowerLimitThreshold":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"upperLimitThreshold":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"actions":{"email":{"active":false,"address":"user1@example.com;user2@example.com"},"notifier":{"active":false},"status":{"active":false,"severity":1752540.6259412318},"event":{"severity":-60684786.38740462,"limitInterval":{"active":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}},"conditionMet":{"status":false,"timestamp":"2022-01-25T11:57:54.833+01:00"}},{"ruleId":"580a52f638394c8ab35f22f03556a7ed","assetType":"myiottenant.GearBox","assetIds":["9f81490428644ff995b0e3590f21ef57","76a1388fee23496bacac9bc378aa65fe"],"name":"Gear box temperature \u003e 85°C","description":"Raise warning if gear box temperature exceeds 85°C","active":false,"lastChangedActive":"2022-05-30T05:38:16.438Z","creator":"\u003cName of user that has initially created the rule\u003e","created":"\u003cDate and time of rule creation\u003e","editor":"\u003cName of user that has last updated the rule configuration\u003e","edited":"\u003cDate and time of last rule update\u003e","etag":"4b4283c1ba936b7ed38ba4dd936d79e4","evaluations":[{"property":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"condition":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"hysteresisAbsolute":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"debouncingTime":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"threshold":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lowerLimitThreshold":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"upperLimitThreshold":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"property":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"condition":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"hysteresisAbsolute":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"debouncingTime":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"threshold":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lowerLimitThreshold":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"upperLimitThreshold":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"actions":{"email":{"active":false,"address":"user1@example.com;user2@example.com"},"notifier":{"active":true},"status":{"active":true,"severity":-16219939.57076624},"event":{"severity":-56105528.2897907,"limitInterval":{"active":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}},"conditionMet":{"status":true,"timestamp":"2022-01-25T11:57:54.833+01:00"}}]},"_links":{"self":{"href":"http://myiottenant.mindsphere.io/api/rulesmanagement/v4/rules?page=2\u0026size=4"},"first":{"href":"http://myiottenant.mindsphere.io/api/rulesmanagement/v4/rules?page=0\u0026size=4"},"prev":{"href":"http://myiottenant.mindsphere.io/api/rulesmanagement/v4/rules?page=1\u0026size=4"},"next":{"href":"http://myiottenant.mindsphere.io/api/rulesmanagement/v4/rules?page=3\u0026size=4"},"last":{"href":"http://myiottenant.mindsphere.io/api/rulesmanagement/v4/rules?page=15\u0026size=4"}},"quota":{"active":31,"total":50,"limitActive":70},"page":{"number":2,"size":4,"totalPages":16,"totalElements":61},"message":"Rules read"}