Get a list of all treatment definitions

get/definitions

Internal-Use Only

Returns a resource collection of all treatment definitions.

Request Samples

Response Samples

200
application/vnd.sas.collection+json
application/vnd.sas.summary+json
1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "collection",
6      "href": "/treatmentDefinitions/definitions",
7      "uri": "/treatmentDefinitions/definitions",
8      "type": "application/vnd.sas.collection",
9      "itemType": "application/vnd.sas.treatment.definition"
10    },
11    {
12      "method": "GET",
13      "rel": "self",
14      "href": "/treatmentDefinitions/definitions?sortBy=name&start=2&limit=1",
15      "uri": "/treatmentDefinitions/definitions?sortBy=name&start=2&limit=1",
16      "type": "application/vnd.sas.collection",
17      "itemType": "application/vnd.sas.summary"
18    },
19    {
20      "method": "GET",
21      "rel": "first",
22      "href": "/treatmentDefinitions/definitions?sortBy=name&start=0&limit=1",
23      "uri": "/treatmentDefinitions/definitions?sortBy=name&start=0&limit=1",
24      "type": "application/vnd.sas.collection",
25      "itemType": "application/vnd.sas.summary"
26    },
27    {
28      "method": "GET",
29      "rel": "prev",
30      "href": "/treatmentDefinitions/definitions?sortBy=name&start=1&limit=1",
31      "uri": "/treatmentDefinitions/definitions?sortBy=name&start=1&limit=1",
32      "type": "application/vnd.sas.collection",
33      "itemType": "application/vnd.sas.summary"
34    },
35    {
36      "method": "GET",
37      "rel": "next",
38      "href": "/treatmentDefinitions/definitions?sortBy=name&start=3&limit=1",
39      "uri": "/treatmentDefinitions/definitions?sortBy=name&start=3&limit=1",
40      "type": "application/vnd.sas.collection",
41      "itemType": "application/vnd.sas.summary"
42    },
43    {
44      "method": "POST",
45      "rel": "create",
46      "href": "/treatmentDefinitions/definitions",
47      "uri": "/treatmentDefinitions/definitions",
48      "type": "application/vnd.sas.vnd.sas.treatment.definition",
49      "responseType": "application/vnd.sas.treatment.definition"
50    }
51  ],
52  "name": "treatmentDefinitions",
53  "accept": "application/vnd.sas.summary",
54  "start": 2,
55  "count": 5,
56  "items": [
57    {
58      "creationTimeStamp": "2021-09-15T18:45:05.406Z",
59      "modifiedTimeStamp": "2021-09-15T18:45:05.406Z",
60      "createdBy": "sasdemo",
61      "modifiedBy": "sasdemo",
62      "id": "da85cd3c-7c7a-437c-acac-eca2819c9a6d",
63      "type": "treatmentDefinition",
64      "name": "My Treatment Definition",
65      "links": [
66        {
67          "method": "GET",
68          "rel": "up",
69          "href": "/treatmentDefinitions/definitions",
70          "uri": "/treatmentDefinitions/definitions",
71          "type": "application/vnd.sas.collection"
72        },
73        {
74          "method": "GET",
75          "rel": "self",
76          "href": "/treatmentDefinitions/definitions/da85cd3c-7c7a-437c-acac-eca2819c9a6d",
77          "uri": "/treatmentDefinitions/definitions/da85cd3c-7c7a-437c-acac-eca2819c9a6d",
78          "type": "application/vnd.sas.treatment.definition"
79        },
80        {
81          "method": "GET",
82          "rel": "alternate",
83          "href": "/treatmentDefinitions/definitions/da85cd3c-7c7a-437c-acac-eca2819c9a6d",
84          "uri": "/treatmentDefinitions/definitions/da85cd3c-7c7a-437c-acac-eca2819c9a6d",
85          "type": "application/vnd.sas.summary"
86        },
87        {
88          "method": "DELETE",
89          "rel": "delete",
90          "href": "/treatmentDefinitions/definitions/da85cd3c-7c7a-437c-acac-eca2819c9a6d",
91          "uri": "/treatmentDefinitions/definitions/da85cd3c-7c7a-437c-acac-eca2819c9a6d"
92        },
93        {
94          "method": "PUT",
95          "rel": "update",
96          "href": "/treatmentDefinitions/definitions/da85cd3c-7c7a-437c-acac-eca2819c9a6d",
97          "uri": "/treatmentDefinitions/definitions/da85cd3c-7c7a-437c-acac-eca2819c9a6d",
98          "type": "application/vnd.sas.treatment.definition",
99          "responseType": "application/vnd.sas.treatment.definition"
100        },
101        {
102          "method": "GET",
103          "rel": "revisions",
104          "href": "/treatmentDefinitions/definitions/da85cd3c-7c7a-437c-acac-eca2819c9a6d/revisions",
105          "uri": "/treatmentDefinitions/definitions/da85cd3c-7c7a-437c-acac-eca2819c9a6d/revisions",
106          "type": "application/vnd.sas.collection"
107        }
108      ],
109      "version": 2
110    }
111  ],
112  "limit": 1,
113  "version": 2
114}

Query Parameters

Name	Type	Required	Description
parentFolderUri	string</folders/folders/{parentFolderId}>	false	The folder where the target treatment definitions are located. Examples: "/folders/folders/@public"
filter	string<filter-criteria>	false	The criteria for filtering the treatment definitions. See Filtering in REST APIs. Examples: "gt(modifiedTimeStamp, '2021-05-03T15:38:45.654Z')"
limit	integer	false	The maximum number of items to return in this page of results. The actual number of returned items might be less if the collection has been exhausted. Default: 10 Examples: 500
sortBy	string<sort-criteria>	false	The criteria for sorting the treatment definitions. See Sorting in REST APIs. Examples: "modifiedTimeStamp:descending"
start	integer	false	The starting index of the first item in a page. The index is 0-based. Default: 0 Examples: 100

Header Parameters

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

Responses

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