Get a list of rules

GET {{baseUrl}}/rules?filter=<string>&size=<integer>&page=<integer>

Get rules according to the provided query parameters.

Request Params

KeyDatatypeRequiredDescription
filterstringFilter 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.
sizestringThe 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.
pagestringZero based index of requested page. Page 0 is returned by default if parameter is not provided.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;_embedded&quot;:{&quot;rules&quot;:[{&quot;ruleId&quot;:&quot;580a52f638394c8ab35f22f03556a7ed&quot;,&quot;assetType&quot;:&quot;myiottenant.GearBox&quot;,&quot;assetIds&quot;:[&quot;9f81490428644ff995b0e3590f21ef57&quot;,&quot;76a1388fee23496bacac9bc378aa65fe&quot;],&quot;name&quot;:&quot;Gear box temperature \u003e 85°C&quot;,&quot;description&quot;:&quot;Raise warning if gear box temperature exceeds 85°C&quot;,&quot;active&quot;:false,&quot;lastChangedActive&quot;:&quot;2022-05-30T05:38:16.438Z&quot;,&quot;creator&quot;:&quot;\u003cName of user that has initially created the rule\u003e&quot;,&quot;created&quot;:&quot;\u003cDate and time of rule creation\u003e&quot;,&quot;editor&quot;:&quot;\u003cName of user that has last updated the rule configuration\u003e&quot;,&quot;edited&quot;:&quot;\u003cDate and time of last rule update\u003e&quot;,&quot;etag&quot;:&quot;4b4283c1ba936b7ed38ba4dd936d79e4&quot;,&quot;evaluations&quot;:[{&quot;property&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;condition&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;hysteresisAbsolute&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;debouncingTime&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;threshold&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;lowerLimitThreshold&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;upperLimitThreshold&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},{&quot;property&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;condition&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;hysteresisAbsolute&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;debouncingTime&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;threshold&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;lowerLimitThreshold&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;upperLimitThreshold&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}],&quot;actions&quot;:{&quot;email&quot;:{&quot;active&quot;:false,&quot;address&quot;:&quot;user1@example.com;user2@example.com&quot;},&quot;notifier&quot;:{&quot;active&quot;:false},&quot;status&quot;:{&quot;active&quot;:false,&quot;severity&quot;:1752540.6259412318},&quot;event&quot;:{&quot;severity&quot;:-60684786.38740462,&quot;limitInterval&quot;:{&quot;active&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;value&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}}},&quot;conditionMet&quot;:{&quot;status&quot;:false,&quot;timestamp&quot;:&quot;2022-01-25T11:57:54.833+01:00&quot;}},{&quot;ruleId&quot;:&quot;580a52f638394c8ab35f22f03556a7ed&quot;,&quot;assetType&quot;:&quot;myiottenant.GearBox&quot;,&quot;assetIds&quot;:[&quot;9f81490428644ff995b0e3590f21ef57&quot;,&quot;76a1388fee23496bacac9bc378aa65fe&quot;],&quot;name&quot;:&quot;Gear box temperature \u003e 85°C&quot;,&quot;description&quot;:&quot;Raise warning if gear box temperature exceeds 85°C&quot;,&quot;active&quot;:false,&quot;lastChangedActive&quot;:&quot;2022-05-30T05:38:16.438Z&quot;,&quot;creator&quot;:&quot;\u003cName of user that has initially created the rule\u003e&quot;,&quot;created&quot;:&quot;\u003cDate and time of rule creation\u003e&quot;,&quot;editor&quot;:&quot;\u003cName of user that has last updated the rule configuration\u003e&quot;,&quot;edited&quot;:&quot;\u003cDate and time of last rule update\u003e&quot;,&quot;etag&quot;:&quot;4b4283c1ba936b7ed38ba4dd936d79e4&quot;,&quot;evaluations&quot;:[{&quot;property&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;condition&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;hysteresisAbsolute&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;debouncingTime&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;threshold&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;lowerLimitThreshold&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;upperLimitThreshold&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}},{&quot;property&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;condition&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;hysteresisAbsolute&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;debouncingTime&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;threshold&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;lowerLimitThreshold&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;upperLimitThreshold&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}],&quot;actions&quot;:{&quot;email&quot;:{&quot;active&quot;:false,&quot;address&quot;:&quot;user1@example.com;user2@example.com&quot;},&quot;notifier&quot;:{&quot;active&quot;:true},&quot;status&quot;:{&quot;active&quot;:true,&quot;severity&quot;:-16219939.57076624},&quot;event&quot;:{&quot;severity&quot;:-56105528.2897907,&quot;limitInterval&quot;:{&quot;active&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;value&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}}},&quot;conditionMet&quot;:{&quot;status&quot;:true,&quot;timestamp&quot;:&quot;2022-01-25T11:57:54.833+01:00&quot;}}]},&quot;_links&quot;:{&quot;self&quot;:{&quot;href&quot;:&quot;http://myiottenant.mindsphere.io/api/rulesmanagement/v4/rules?page=2\u0026size=4&quot;},&quot;first&quot;:{&quot;href&quot;:&quot;http://myiottenant.mindsphere.io/api/rulesmanagement/v4/rules?page=0\u0026size=4&quot;},&quot;prev&quot;:{&quot;href&quot;:&quot;http://myiottenant.mindsphere.io/api/rulesmanagement/v4/rules?page=1\u0026size=4&quot;},&quot;next&quot;:{&quot;href&quot;:&quot;http://myiottenant.mindsphere.io/api/rulesmanagement/v4/rules?page=3\u0026size=4&quot;},&quot;last&quot;:{&quot;href&quot;:&quot;http://myiottenant.mindsphere.io/api/rulesmanagement/v4/rules?page=15\u0026size=4&quot;}},&quot;quota&quot;:{&quot;active&quot;:31,&quot;total&quot;:50,&quot;limitActive&quot;:70},&quot;page&quot;:{&quot;number&quot;:2,&quot;size&quot;:4,&quot;totalPages&quot;:16,&quot;totalElements&quot;:61},&quot;message&quot;:&quot;Rules read&quot;}