Get all rule sets

get/ruleSets

Internal-Use Only

Returns a resource collection of all the rule sets.

Request Samples

Response Samples

200
application/vnd.sas.collection+json
application/vnd.sas.summary+json
1{
2  "name": "ruleSets",
3  "accept": "application/vnd.sas.summary",
4  "start": 0,
5  "count": 1,
6  "items": [
7    {
8      "creationTimeStamp": "2024-06-17T08:13:45.535Z",
9      "modifiedTimeStamp": "2024-06-17T08:14:32.142Z",
10      "createdBy": "sasdemo",
11      "modifiedBy": "sasdemo",
12      "id": "c01375b7-154f-47c8-9e6c-18b27b4be692",
13      "type": "ruleSet",
14      "name": "hmeq_job",
15      "description": "test",
16      "typeDefName": "ruleSet_assignment",
17      "links": [
18        {
19          "method": "GET",
20          "rel": "up",
21          "href": "/businessRules/ruleSets",
22          "uri": "/businessRules/ruleSets",
23          "type": "application/vnd.sas.collection"
24        },
25        {
26          "method": "GET",
27          "rel": "self",
28          "href": "/businessRules/ruleSets/c01375b7-154f-47c8-9e6c-18b27b4be692",
29          "uri": "/businessRules/ruleSets/c01375b7-154f-47c8-9e6c-18b27b4be692",
30          "type": "application/vnd.sas.business.rule.set"
31        },
32        {
33          "method": "GET",
34          "rel": "alternate",
35          "href": "/businessRules/ruleSets/c01375b7-154f-47c8-9e6c-18b27b4be692",
36          "uri": "/businessRules/ruleSets/c01375b7-154f-47c8-9e6c-18b27b4be692",
37          "type": "application/vnd.sas.summary"
38        },
39        {
40          "method": "PUT",
41          "rel": "update",
42          "href": "/businessRules/ruleSets/c01375b7-154f-47c8-9e6c-18b27b4be692",
43          "uri": "/businessRules/ruleSets/c01375b7-154f-47c8-9e6c-18b27b4be692",
44          "type": "application/vnd.sas.business.rule",
45          "responseType": "application/vnd.sas.business.rule"
46        },
47        {
48          "method": "DELETE",
49          "rel": "delete",
50          "href": "/businessRules/ruleSets/c01375b7-154f-47c8-9e6c-18b27b4be692",
51          "uri": "/businessRules/ruleSets/c01375b7-154f-47c8-9e6c-18b27b4be692"
52        },
53        {
54          "method": "GET",
55          "rel": "revisions",
56          "href": "/businessRules/ruleSets/c01375b7-154f-47c8-9e6c-18b27b4be692/revisions",
57          "uri": "/businessRules/ruleSets/c01375b7-154f-47c8-9e6c-18b27b4be692/revisions",
58          "type": "application/vnd.sas.collection",
59          "itemType": "application/vnd.sas.business.rule.set"
60        }
61      ],
62      "version": 2
63    }
64  ],
65  "limit": 10,
66  "version": 2,
67  "links": [
68    {
69      "method": "GET",
70      "rel": "collection",
71      "href": "/businessRules/ruleSets",
72      "uri": "/businessRules/ruleSets",
73      "type": "application/vnd.sas.collection",
74      "itemType": "application/vnd.sas.business.rule.set"
75    },
76    {
77      "method": "GET",
78      "rel": "self",
79      "href": "/businessRules/ruleSets?sortBy=modifiedTimeStamp:descending&start=0&limit=10",
80      "uri": "/businessRules/ruleSets?sortBy=modifiedTimeStamp:descending&start=0&limit=10",
81      "type": "application/vnd.sas.collection",
82      "itemType": "application/vnd.sas.summary"
83    },
84    {
85      "method": "POST",
86      "rel": "createRuleSet",
87      "href": "/businessRules/ruleSets",
88      "uri": "/businessRules/ruleSets",
89      "type": "application/vnd.sas.business.rule.set",
90      "responseType": "application/vnd.sas.business.rule.set"
91    },
92    {
93      "method": "GET",
94      "rel": "getDefaultRuleSetThumbnail",
95      "href": "/businessRules/ruleSets/defaultRuleSetThumbnail.svg",
96      "uri": "/businessRules/ruleSets/defaultRuleSetThumbnail.svg"
97    }
98  ]
99}

Query Parameters

Name	Type	Required	Description
parentFolderUri	string</folders/folders/{parentFolderId}>	false	The folder where the target rule sets are located.
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`.
limit	integer	false	The maximum number of items to return on this page of results. The actual number of returned items might be less if there are no more items in the collection. The default is 10.
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.
start	integer	false	The starting index of the first item on a page. The index is 0-based. The default is 0.

Header Parameters

Name	Type	Required	Description
Accept-Item	string<media-type>	false	Used for selecting the desired item representation. Allowed values: application/vnd.sas.business.rule.set+jsonapplication/vnd.sas.summary+jsonapplication/vnd.sas.dcm.summary+json Default: application/vnd.sas.summary+json

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
406	Not Acceptable	The media type is incompatible. This is usually the case when there is an error, but the error response media type is not compatible with the text/csv media type. The REST client or browser returns this status error instead.		Schema