Get terms

get/terms

Internal-Use Only

Returns a list of terms. The items are sorted by name by default. The properties that can be used as filter and sort criteria are:

id
name
label
description
createdBy
creationTimeStamp
modifiedBy
modifiedTimeStamp
termTypeId
parentId

Request Samples

Response Samples

200
application/vnd.sas.collection+json
1{
2  "version": 2,
3  "accept": "application/vnd.sas.glossary.term",
4  "count": 2,
5  "start": 0,
6  "limit": 10,
7  "name": "terms",
8  "items": [
9    {
10      "creationTimeStamp": "2022-09-23T07:32:24.065Z",
11      "modifiedTimeStamp": "2022-09-23T07:32:24.065Z",
12      "id": "b0cbbd32-fbc1-4f1b-b98c-8bd7a9c9f180",
13      "links": [
14        {
15          "method": "GET",
16          "rel": "self",
17          "href": "/glossary/terms/b0cbbd32-fbc1-4f1b-b98c-8bd7a9c9f180",
18          "uri": "/glossary/terms/b0cbbd32-fbc1-4f1b-b98c-8bd7a9c9f180",
19          "type": "application/vnd.sas.glossary.term"
20        },
21        {
22          "method": "GET",
23          "rel": "up",
24          "href": "/glossary/terms",
25          "uri": "/glossary/terms",
26          "type": "application/vnd.sas.collection",
27          "itemType": "application/vnd.sas.glossary.term"
28        },
29        {
30          "method": "PUT",
31          "rel": "update",
32          "href": "/glossary/terms/b0cbbd32-fbc1-4f1b-b98c-8bd7a9c9f180",
33          "uri": "/glossary/terms/b0cbbd32-fbc1-4f1b-b98c-8bd7a9c9f180",
34          "type": "application/vnd.sas.glossary.term",
35          "responseType": "application/vnd.sas.glossary.term"
36        },
37        {
38          "method": "DELETE",
39          "rel": "delete",
40          "href": "/glossary/terms/b0cbbd32-fbc1-4f1b-b98c-8bd7a9c9f180",
41          "uri": "/glossary/terms/b0cbbd32-fbc1-4f1b-b98c-8bd7a9c9f180"
42        }
43      ],
44      "version": 1,
45      "name": "vehicle",
46      "label": "Vehicle",
47      "description": "A term for vehicle",
48      "status": "Published",
49      "termTypeId": "9e7410b5-cebd-4830-8723-f0290c45a360",
50      "termTypeLabel": "Default Term Type",
51      "definition": "Vehicle Term",
52      "termRevision": 1,
53      "isDraft": false
54    },
55    {
56      "creationTimeStamp": "2022-09-23T07:32:24.065Z",
57      "modifiedTimeStamp": "2022-09-23T07:32:24.065Z",
58      "id": "77869195-3fb3-4044-820e-056047eff8bf",
59      "links": [
60        {
61          "method": "GET",
62          "rel": "self",
63          "href": "/glossary/terms/77869195-3fb3-4044-820e-056047eff8bf",
64          "uri": "/glossary/terms/77869195-3fb3-4044-820e-056047eff8bf",
65          "type": "application/vnd.sas.glossary.term"
66        },
67        {
68          "method": "GET",
69          "rel": "up",
70          "href": "/glossary/terms",
71          "uri": "/glossary/terms",
72          "type": "application/vnd.sas.collection",
73          "itemType": "application/vnd.sas.glossary.term"
74        },
75        {
76          "method": "PUT",
77          "rel": "update",
78          "href": "/glossary/terms/77869195-3fb3-4044-820e-056047eff8bf",
79          "uri": "/glossary/terms/77869195-3fb3-4044-820e-056047eff8bf",
80          "type": "application/vnd.sas.glossary.term",
81          "responseType": "application/vnd.sas.glossary.term"
82        },
83        {
84          "method": "DELETE",
85          "rel": "delete",
86          "href": "/glossary/terms/77869195-3fb3-4044-820e-056047eff8bf",
87          "uri": "/glossary/terms/77869195-3fb3-4044-820e-056047eff8bf"
88        }
89      ],
90      "version": 1,
91      "name": "sedan",
92      "label": "Sedan",
93      "description": "Term for sedans",
94      "status": "Published",
95      "termTypeId": "9e7410b5-cebd-4830-8723-f0290c45a360",
96      "termTypeLabel": "Default Term Type",
97      "parentId": "b0cbbd32-fbc1-4f1b-b98c-8bd7a9c9f180",
98      "definition": "Sedan Term",
99      "termRevision": 1,
100      "isDraft": false
101    }
102  ],
103  "links": [
104    {
105      "method": "GET",
106      "rel": "self",
107      "href": "/glossary/terms?start=0&limit=10&sortBy=name",
108      "uri": "/glossary/terms?start=0&limit=10&sortBy=name",
109      "type": "application/vnd.sas.collection",
110      "itemType": "application/vnd.sas.glossary.term"
111    },
112    {
113      "method": "GET",
114      "rel": "collection",
115      "href": "/glossary/terms",
116      "uri": "/glossary/terms",
117      "type": "application/vnd.sas.collection",
118      "itemType": "application/vnd.sas.glossary.term"
119    },
120    {
121      "method": "GET",
122      "rel": "up",
123      "href": "/glossary",
124      "uri": "/glossary",
125      "type": "application/vnd.sas.api"
126    },
127    {
128      "method": "POST",
129      "rel": "create",
130      "href": "/glossary/terms",
131      "uri": "/glossary/terms",
132      "type": "application/vnd.sas.glossary.term",
133      "responseType": "application/vnd.sas.glossary.term"
134    }
135  ]
136}

Query Parameters

Name	Type	Required	Description
allowDrafts	string	false	This parameter allows drafts to be returned with the list of terms, provided the user making this request is a member of the Glossary.GlossaryAdministrators group. If a draft for a term exists and drafts are allowed, then the draft will be returned instead of the published term. "user": Only drafts created by the current user will be included. "all": All drafts will be included. "none": Only published terms will be returned. Allowed values: userallnone Default: user
filter	string<filter-criteria>	false	Filter criteria for returned objects. See Filtering in REST APIs.
limit	integer	false	Maximum number of objects to return. Defaults to 10.
sortBy	string<sort-criteria>	false	Sort criteria for returned objects. See Sorting in REST APIs.
start	integer	false	The zero-based offset of first object to return. Defaults to 0.

Header Parameters

Name	Type	Required	Description
Accept	string	false	The desired representation for the response. Allowed values: application/vnd.sas.collection+jsonapplication/json Default: application/vnd.sas.collection+json
Accept-Item	string	false	The desired item representation for collections. Allowed values: application/vnd.sas.glossary.term+jsonapplication/json Default: application/vnd.sas.glossary.term+json

Responses

Status	Meaning	Description
200	OK	OK.	Headers	Schema
404	Not Found	The Glossary service is not available.		Schema