Get all rules

get/rules
Internal-Use Only
Returns all rules based on a query for all rule sets.
Request Samples

Response Samples

200
application/vnd.sas.collection+json
1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "self",
6      "href": "/businessRules/rules?start=0&limit=10",
7      "uri": "/businessRules/rules?start=0&limit=10",
8      "type": "application/vnd.sas.collection",
9      "itemType": "application/vnd.sas.business.rule.query.result"
10    },
11    {
12      "method": "GET",
13      "rel": "collection",
14      "href": "/businessRules/rules",
15      "uri": "/businessRules/rules",
16      "type": "application/vnd.sas.collection",
17      "itemType": "application/vnd.sas.business.rule.query.result"
18    },
19    {
20      "method": "GET",
21      "rel": "next",
22      "href": "/businessRules/rules?start=10&limit=10",
23      "uri": "/businessRules/rules?start=10&limit=10",
24      "type": "application/vnd.sas.collection",
25      "itemType": "application/vnd.sas.business.rule.query.result"
26    },
27    {
28      "method": "GET",
29      "rel": "last",
30      "href": "/businessRules/rules?start=8&limit=10",
31      "uri": "/businessRules/rules?start=8&limit=10",
32      "type": "application/vnd.sas.collection",
33      "itemType": "application/vnd.sas.business.rule.query.result"
34    },
35    {
36      "method": "GET",
37      "rel": "up",
38      "href": "/businessRules",
39      "uri": "/businessRules",
40      "type": "application/vnd.sas.api"
41    }
42  ],
43  "name": "items",
44  "start": 0,
45  "count": 18,
46  "items": [
47    {
48      "creationTimeStamp": "2024-07-03T07:27:29.720Z",
49      "modifiedTimeStamp": "2024-07-03T07:27:29.806Z",
50      "createdBy": "sasdemo",
51      "modifiedBy": "sasdemo",
52      "id": "41c8f74d-8ef1-4afa-b9cc-77431730ee54",
53      "name": "aaduke_15aug11_11_43_43_01_2",
54      "conditional": "if",
55      "ruleFiredTrackingEnabled": true,
56      "status": "valid",
57      "description": "Signal Tech Support contact when defect DEFERed",
58      "conditionExpressions": [
59        "EVENT LIKE '%DEFER;%'",
60        "ITSIDS LIKE '% DUKES, AARON;%'"
61      ],
62      "actionExpressions": [
63        "MATCHEDRULE = 'aaduke_15aug11_11_43_43_01_2'"
64      ],
65      "ruleSet": {
66        "creationTimeStamp": "2024-07-03T07:27:29.501Z",
67        "modifiedTimeStamp": "2024-07-03T07:27:29.668Z",
68        "createdBy": "sasdemo",
69        "modifiedBy": "sasdemo",
70        "id": "045af860-5dde-4fd5-8009-1694cf3eb461",
71        "name": "Subscriptions_A",
72        "ruleSetType": "assignment",
73        "description": "Signals of a Defects user",
74        "majorRevision": 1,
75        "minorRevision": 0,
76        "checkout": false,
77        "locked": false,
78        "version": 6,
79        "signature": [
80          {
81            "creationTimeStamp": "2024-07-03T07:27:29.720Z",
82            "modifiedTimeStamp": "2024-07-03T07:27:29.720Z",
83            "createdBy": "sasdemo",
84            "modifiedBy": "sasdemo",
85            "id": "282711d0-fb39-4c1c-a5a5-f0dfb2ec60a2",
86            "name": "EVENT",
87            "dataType": "string",
88            "direction": "inOut",
89            "generateDataGridColumns": false
90          },
91          {
92            "creationTimeStamp": "2024-07-03T07:27:29.727Z",
93            "modifiedTimeStamp": "2024-07-03T07:27:29.727Z",
94            "createdBy": "sasdemo",
95            "modifiedBy": "sasdemo",
96            "id": "8558d37a-1291-47db-b5e7-f1f402cb7620",
97            "name": "ITSIDS",
98            "dataType": "string",
99            "direction": "inOut",
100            "generateDataGridColumns": false
101          },
102          {
103            "creationTimeStamp": "2024-07-03T07:27:29.730Z",
104            "modifiedTimeStamp": "2024-07-03T07:27:29.730Z",
105            "createdBy": "sasdemo",
106            "modifiedBy": "sasdemo",
107            "id": "8e54c16f-1eb8-47f4-b3a1-4cf940f28cc6",
108            "name": "MATCHEDRULE",
109            "dataType": "string",
110            "direction": "output",
111            "generateDataGridColumns": false
112          }
113        ]
114      },
115      "links": [
116        {
117          "method": "GET",
118          "rel": "self",
119          "href": "/businessRules/ruleSets/045af860-5dde-4fd5-8009-1694cf3eb461/revisions/946b72f0-c9fa-487d-930a-8eec2b790498/rules/41c8f74d-8ef1-4afa-b9cc-77431730ee54",
120          "uri": "/businessRules/ruleSets/045af860-5dde-4fd5-8009-1694cf3eb461/revisions/946b72f0-c9fa-487d-930a-8eec2b790498/rules/41c8f74d-8ef1-4afa-b9cc-77431730ee54",
121          "type": "application/vnd.sas.business.rule"
122        },
123        {
124          "method": "GET",
125          "rel": "parent",
126          "href": "/businessRules/ruleSets/045af860-5dde-4fd5-8009-1694cf3eb461/revisions/946b72f0-c9fa-487d-930a-8eec2b790498",
127          "uri": "/businessRules/ruleSets/045af860-5dde-4fd5-8009-1694cf3eb461/revisions/946b72f0-c9fa-487d-930a-8eec2b790498",
128          "type": "application/vnd.sas.business.rule.set"
129        },
130        {
131          "method": "GET",
132          "rel": "up",
133          "href": "/businessRules/ruleSets/045af860-5dde-4fd5-8009-1694cf3eb461/revisions/946b72f0-c9fa-487d-930a-8eec2b790498/rules",
134          "uri": "/businessRules/ruleSets/045af860-5dde-4fd5-8009-1694cf3eb461/revisions/946b72f0-c9fa-487d-930a-8eec2b790498/rules",
135          "type": "application/vnd.sas.collection",
136          "itemType": "application/vnd.sas.business.rule"
137        }
138      ],
139      "version": 1
140    },
141    {
142      "creationTimeStamp": "2024-04-22T01:06:10.315Z",
143      "modifiedTimeStamp": "2024-04-22T01:06:10.478Z",
144      "createdBy": "sasdemo",
145      "modifiedBy": "sasdemo",
146      "id": "a117eddb-4635-450b-a9e6-68763fcef53d",
147      "name": "Default_rule_1",
148      "conditional": "if",
149      "ruleFiredTrackingEnabled": true,
150      "status": "valid",
151      "conditionExpressions": [
152        "Job = 'Other'"
153      ],
154      "actionExpressions": [],
155      "ruleSet": {
156        "creationTimeStamp": "2024-04-22T01:05:35.220Z",
157        "modifiedTimeStamp": "2024-04-22T01:06:09.915Z",
158        "createdBy": "sasdemo",
159        "modifiedBy": "sasdemo",
160        "id": "1a673658-1330-4959-9843-bca4ef1dbd6c",
161        "name": "hmeq_job_filter",
162        "ruleSetType": "filtering",
163        "description": "",
164        "majorRevision": 1,
165        "minorRevision": 0,
166        "checkout": false,
167        "locked": false,
168        "version": 6,
169        "signature": [
170          {
171            "creationTimeStamp": "2024-04-22T01:06:09.869Z",
172            "modifiedTimeStamp": "2024-04-22T01:06:09.869Z",
173            "createdBy": "sasdemo",
174            "modifiedBy": "sasdemo",
175            "id": "95688a0d-e53a-4fa1-8eb5-7bef18ce2ca8",
176            "name": "Job",
177            "dataType": "string",
178            "direction": "inOut",
179            "description": "",
180            "generateDataGridColumns": false
181          }
182        ]
183      },
184      "links": [
185        {
186          "method": "GET",
187          "rel": "self",
188          "href": "/businessRules/ruleSets/1a673658-1330-4959-9843-bca4ef1dbd6c/revisions/0d781fdf-d162-4ab3-9a0b-8f378638b706/rules/a117eddb-4635-450b-a9e6-68763fcef53d",
189          "uri": "/businessRules/ruleSets/1a673658-1330-4959-9843-bca4ef1dbd6c/revisions/0d781fdf-d162-4ab3-9a0b-8f378638b706/rules/a117eddb-4635-450b-a9e6-68763fcef53d",
190          "type": "application/vnd.sas.business.rule"
191        },
192        {
193          "method": "GET",
194          "rel": "parent",
195          "href": "/businessRules/ruleSets/1a673658-1330-4959-9843-bca4ef1dbd6c/revisions/0d781fdf-d162-4ab3-9a0b-8f378638b706",
196          "uri": "/businessRules/ruleSets/1a673658-1330-4959-9843-bca4ef1dbd6c/revisions/0d781fdf-d162-4ab3-9a0b-8f378638b706",
197          "type": "application/vnd.sas.business.rule.set"
198        },
199        {
200          "method": "GET",
201          "rel": "up",
202          "href": "/businessRules/ruleSets/1a673658-1330-4959-9843-bca4ef1dbd6c/revisions/0d781fdf-d162-4ab3-9a0b-8f378638b706/rules",
203          "uri": "/businessRules/ruleSets/1a673658-1330-4959-9843-bca4ef1dbd6c/revisions/0d781fdf-d162-4ab3-9a0b-8f378638b706/rules",
204          "type": "application/vnd.sas.collection",
205          "itemType": "application/vnd.sas.business.rule"
206        }
207      ],
208      "version": 1
209    },
210    {
211      "creationTimeStamp": "2024-04-26T01:27:16.163Z",
212      "modifiedTimeStamp": "2024-04-26T01:27:16.225Z",
213      "createdBy": "sasdemo",
214      "modifiedBy": "sasdemo",
215      "id": "044bf48e-5585-4a38-a022-5fd329715f1e",
216      "name": "Default_rule_1",
217      "conditional": "if",
218      "ruleFiredTrackingEnabled": true,
219      "status": "valid",
220      "description": "",
221      "conditionExpressions": [
222        "risk >= 1.0"
223      ],
224      "actionExpressions": [
225        "risk = 1.0"
226      ],
227      "ruleSet": {
228        "creationTimeStamp": "2024-04-26T01:27:16.045Z",
229        "modifiedTimeStamp": "2024-04-26T01:27:16.121Z",
230        "createdBy": "sasdemo",
231        "modifiedBy": "sasdemo",
232        "id": "81ac6952-ac0d-408b-91ad-54717a65ebb1",
233        "name": "InverseClage",
234        "ruleSetType": "assignment",
235        "majorRevision": 1,
236        "minorRevision": 0,
237        "checkout": false,
238        "locked": false,
239        "version": 6,
240        "signature": [
241          {
242            "creationTimeStamp": "2024-04-26T01:27:16.109Z",
243            "modifiedTimeStamp": "2024-04-26T01:27:16.109Z",
244            "createdBy": "sasdemo",
245            "modifiedBy": "sasdemo",
246            "id": "346734f6-c073-4db4-a71e-9eb4156f34ba",
247            "name": "CLAGE",
248            "dataType": "decimal",
249            "direction": "inOut",
250            "generateDataGridColumns": false
251          },
252          {
253            "creationTimeStamp": "2024-04-26T01:27:16.112Z",
254            "modifiedTimeStamp": "2024-04-26T01:27:16.112Z",
255            "createdBy": "sasdemo",
256            "modifiedBy": "sasdemo",
257            "id": "1959f25e-9ec2-4c93-db10-1cc32a9876c6",
258            "name": "risk",
259            "dataType": "decimal",
260            "direction": "output",
261            "description": "",
262            "generateDataGridColumns": false
263          }
264        ]
265      },
266      "links": [
267        {
268          "method": "GET",
269          "rel": "self",
270          "href": "/businessRules/ruleSets/81ac6952-ac0d-408b-91ad-54717a65ebb1/revisions/8427e43d-7383-4d12-8908-08a8f2d43074/rules/044bf48e-5585-4a38-a022-5fd329715f1e",
271          "uri": "/businessRules/ruleSets/81ac6952-ac0d-408b-91ad-54717a65ebb1/revisions/8427e43d-7383-4d12-8908-08a8f2d43074/rules/044bf48e-5585-4a38-a022-5fd329715f1e",
272          "type": "application/vnd.sas.business.rule"
273        },
274        {
275          "method": "GET",
276          "rel": "parent",
277          "href": "/businessRules/ruleSets/81ac6952-ac0d-408b-91ad-54717a65ebb1/revisions/8427e43d-7383-4d12-8908-08a8f2d43074",
278          "uri": "/businessRules/ruleSets/81ac6952-ac0d-408b-91ad-54717a65ebb1/revisions/8427e43d-7383-4d12-8908-08a8f2d43074",
279          "type": "application/vnd.sas.business.rule.set"
280        },
281        {
282          "method": "GET",
283          "rel": "up",
284          "href": "/businessRules/ruleSets/81ac6952-ac0d-408b-91ad-54717a65ebb1/revisions/8427e43d-7383-4d12-8908-08a8f2d43074/rules",
285          "uri": "/businessRules/ruleSets/81ac6952-ac0d-408b-91ad-54717a65ebb1/revisions/8427e43d-7383-4d12-8908-08a8f2d43074/rules",
286          "type": "application/vnd.sas.collection",
287          "itemType": "application/vnd.sas.business.rule"
288        }
289      ],
290      "version": 1
291    }
292  ],
293  "limit": 10,
294  "version": 2
295}
Query Parameters

Name	Type	Required	Description
filter	string<filter-criteria>	false	An expression for filtering the collection. Valid expressions include eq(member,"string"). Allowed members are `id`, `name`, `description`, `modifiedTimeStamp`, `creationTimeStamp`, `modifiedBy`, and `createdBy`. Examples: "gt(modifiedTimeStamp, '2024-05-03T15:38:49.654Z')"
limit	integer	false	The number of items to return on each page. Examples: 100
sortBy	string<sort-criteria>	false	The criteria for sorting the rule sets. Valid `sortBy` parameters include sortBy=id:descending. Allowed members are `id`, `name`, `description`, `modifiedTimeStamp`, `creationTimeStamp`, `modifiedBy`, and `createdBy`. Examples: "modifiedTimeStamp:descending"
start	integer	false	The starting index of the first item on a page. The index is 0-based. The default is 0. Examples: 1
Responses

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.		Schema