Get a term by its ID

get/terms/{termId}
Internal-Use Only

Returns a term by referencing its ID.

Request Samples

1

Response Samples

1{
2 "creationTimeStamp": "2022-06-23T17:17:25.591Z",
3 "createdBy": "sasuser",
4 "modifiedTimeStamp": "2022-06-23T17:17:25.591Z",
5 "modifiedBy": "sasuser",
6 "id": "5768c0e8-04d1-47d8-b5d4-2e559cc95d22",
7 "links": [
8 {
9 "method": "GET",
10 "rel": "self",
11 "href": "/glossary/terms/5768c0e8-04d1-47d8-b5d4-2e559cc95d22?allowDraft=none",
12 "uri": "/glossary/terms/5768c0e8-04d1-47d8-b5d4-2e559cc95d22?allowDraft=none",
13 "type": "application/vnd.sas.glossary.term"
14 },
15 {
16 "method": "GET",
17 "rel": "up",
18 "href": "/glossary/terms",
19 "uri": "/glossary/terms",
20 "type": "application/vnd.sas.collection",
21 "itemType": "application/vnd.sas.glossary.term"
22 },
23 {
24 "method": "PUT",
25 "rel": "update",
26 "href": "/glossary/terms/5768c0e8-04d1-47d8-b5d4-2e559cc95d22",
27 "uri": "/glossary/terms/5768c0e8-04d1-47d8-b5d4-2e559cc95d22",
28 "type": "application/vnd.sas.glossary.term",
29 "responseType": "application/vnd.sas.glossary.term"
30 },
31 {
32 "method": "DELETE",
33 "rel": "delete",
34 "href": "/glossary/terms/5768c0e8-04d1-47d8-b5d4-2e559cc95d22",
35 "uri": "/glossary/terms/5768c0e8-04d1-47d8-b5d4-2e559cc95d22"
36 }
37 ],
38 "version": 1,
39 "name": "vehicle",
40 "label": "Vehicle",
41 "description": "A term for vehicles",
42 "termTypeId": "9e7410b5-cebd-4830-8723-f0290c45a360",
43 "termTypeLabel": "Default Term Type",
44 "parentId": "7ed5e466-0535-4a7c-8994-46e5b7d347a0",
45 "status": "Published",
46 "definition": "Vehicle Term",
47 "termRevision": 1,
48 "assetCount": 0,
49 "isDraft": false,
50 "attributes": {
51 "state": "NC"
52 }
53}

Path Parameters

NameTypeRequiredDescription
termId
string
true

The ID of the term.

Query Parameters

NameTypeRequiredDescription
allowDraft
string
false

If a draft for this term exists and the user making this request is a member of the Glossary.GlossaryAdministrators group, this parameter determines whether it will be returned instead of the published term. Otherwise, the published term will be returned.

  • "user": The draft will be returned if it was created by the user making this request; otherwise, the published term will be returned.
  • "all": The draft will be returned.
  • "none": The published term will be returned.
Allowed values:
userallnone
Default:
user

Header Parameters

NameTypeRequiredDescription
Accept
string
false

The desired representation for the response.

Allowed values:
application/vnd.sas.glossary.term+jsonapplication/json
Default:
application/vnd.sas.glossary.term+json

Responses

StatusMeaningDescription
200OKThe request succeeded.HeadersSchema
404Not FoundThe specified resource was not found.Schema