Create a term

post/terms

Internal-Use Only

Creates a term with the given content.

Request Samples

application/json
1

Response Samples

201
application/json
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}

Query Parameters

Name	Type	Required	Description
publish	boolean	false	The desired publish state. If true, the term will be created as a published term, otherwise, it will be created as a draft. Defaults to false. Default: false

Header Parameters

Name	Type	Required	Description
Content-Type	string	true	The representation in the request body. Allowed values: application/vnd.sas.glossary.term+jsonapplication/json
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

Request Body

Information about a term

Name	Type	Required	Description
id	string	false	The unique identity of this term. Immutable after creation.
name	string	true	The name of the term; the maximum length is 100. The name must be unique (case-insensitive) among all terms and drafts that share the same parentId. Also, a term must not have the same name as its parent. Backslashes are not allowed.
label	string	false	A label for the term; the maximum length is 100.
description	string	false	A description for the term; the maximum length is 1000.
termTypeId	string	true	ID of the term type. Immutable after creation.
parentId	string	false	ID of the parent term. This is immutable for drafts of published terms.
definition	string	false	A definition for the term.
isDraft	boolean	false	A value to determine if the term is a draft.
attributes	object	false	A map of key/value pairs representing attributes for the term; the keys are strings and the values are objects.

Responses

Status	Meaning	Description
201	Created	Created. The term has been created.	Headers	Schema
400	Bad Request	Bad request (the request is not well-formed).		Schema
403	Forbidden	The user does not have permission to complete this request.		Schema
409	Conflict	A conflict has occurred; usually this means that the term name is already in use.		Schema