Create a term type
post/termTypes
Creates a term type with the given content.
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": "b1744b2b-b984-4454-8b65-f09873708caf",7 "links": [8 {9 "method": "GET",10 "rel": "self",11 "href": "/glossary/termTypes/b1744b2b-b984-4454-8b65-f09873708caf",12 "uri": "/glossary/termTypes/b1744b2b-b984-4454-8b65-f09873708caf",13 "type": "application/vnd.sas.glossary.term.type"14 },15 {16 "method": "GET",17 "rel": "up",18 "href": "/glossary/termTypes",19 "uri": "/glossary/termTypes",20 "type": "application/vnd.sas.collection",21 "itemType": "application/vnd.sas.glossary.term.type.summary"22 },23 {24 "method": "DELETE",25 "rel": "delete",26 "href": "/glossary/termTypes/b1744b2b-b984-4454-8b65-f09873708caf",27 "uri": "/glossary/termTypes/b1744b2b-b984-4454-8b65-f09873708caf"28 },29 {30 "method": "PUT",31 "rel": "update",32 "href": "/glossary/termTypes/b1744b2b-b984-4454-8b65-f09873708caf",33 "uri": "/glossary/termTypes/b1744b2b-b984-4454-8b65-f09873708caf",34 "type": "application/vnd.sas.glossary.term.type",35 "responseType": "application/vnd.sas.glossary.term.type"36 },37 {38 "method": "GET",39 "rel": "alternate",40 "href": "/glossary/termTypes/b1744b2b-b984-4454-8b65-f09873708caf",41 "uri": "/glossary/termTypes/b1744b2b-b984-4454-8b65-f09873708caf",42 "type": "application/vnd.sas.glossary.term.type.summary"43 }44 ],45 "version": 1,46 "name": "New Term Type",47 "label": "Term Type",48 "description": "A new term type",49 "usageCount": 0,50 "attributeCount": 0,51 "attributes": [52 {53 "name": "singleLineTextAttribute",54 "label": "A single-line text attribute",55 "description": "This is a description of the attribute. Single-line text attributes can be up to 4000 characters long and cannot contain newline characters.",56 "required": true,57 "type": "single-line",58 "defaultValue": "This is an example of a single-line text attribute."59 },60 {61 "name": "multiLineTextAttribute",62 "label": "A multi-line text attribute",63 "description": "Multi-line text attributes can be up to 4000 characters. Newline characters are allowed.",64 "type": "multi-line",65 "defaultValue": "This is an example of a multi-line text attribute\\nwith\\nnewline\\ncharacters."66 },67 {68 "name": "booleanAttribute",69 "label": "A boolean attribute",70 "description": "Boolean attributes can be either \"true\" or \"false\"",71 "type": "boolean",72 "defaultValue": "true"73 },74 {75 "name": "dateAttribute",76 "label": "A date attribute",77 "description": "Date attributes should be specified with the format \"YYYY-MM-DD\"",78 "type": "date",79 "defaultValue": "2024-02-12"80 },81 {82 "name": "timeAttribute",83 "label": "A time attribute",84 "description": "Time attributes should be specified with the format \"hh:mm:ssZ\"",85 "type": "time",86 "defaultValue": "10:23:45Z"87 },88 {89 "name": "dateTimeAttribute",90 "label": "A date-time attribute",91 "description": "Date-time attributes should be specified with the format \"YYYY-MM-DDThh:mm:ssZ\"",92 "type": "date-time",93 "defaultValue": "2024-02-12T10:23:45Z"94 },95 {96 "name": "singleSelectAttribute",97 "label": "A single-select attribute",98 "description": "Single-select attributes must specify at least one item in the \"items\" field",99 "type": "single-select",100 "items": [101 "Item 1",102 "Item 2",103 "Item 3"104 ],105 "defaultValue": "Item 1"106 },107 {108 "name": "multiSelectAttribute",109 "label": "A multi-select attribute",110 "description": "Multi-select attributes must specify at least one item in the \"items\" field",111 "type": "multi-select",112 "items": [113 "Item 1",114 "Item 2",115 "Item 3"116 ],117 "defaultValue": "Item 1,Item 3"118 }119 ]120}
Name | Type | Required | Description |
---|---|---|---|
Content-Type | string | true | The representation in the request body. Allowed values: application/vnd.sas.glossary.term.type+jsonapplication/json |
Accept | string | false | The desired representation for the response. Allowed values: application/vnd.sas.glossary.term.type+jsonapplication/vnd.sas.glossary.term.type.summary+jsonapplication/json Default: application/vnd.sas.glossary.term.type+json |
Information about a term type.
Name | Type | Required | Description |
---|---|---|---|
id | string | true | The unique identity of this term type; this attribute is immutable after creation. |
name | string | true | The name of the term type; the maximum length is 100. The name must be unique (case-insensitive) among all term types. |
label | string | false | A label for the term type; the maximum length is 100. |
description | string | false | A description for the term type; the maximum length is 1000. |
baseType | string | false | The term type name this type is based upon if applicable. |
attributes | array [object] | false | An ordered list of attributes. |
Status | Meaning | Description | ||
---|---|---|---|---|
201 | Created | Created. The term type has been created. | Headers | Schema |
400 | Bad Request | Bad request (the request is not well-formed). | Schema | |
401 | Unauthorized | Not authenticated. | Schema | |
403 | Forbidden | The user does not have permission to complete this request. | Schema | |
406 | Not Acceptable | Not Acceptable. Include an Accept header with a supported value on the request. | Schema | |
409 | Conflict | A conflict has occurred; usually this means that the term type name is already in use or a term type attribute name was duplicated. | Schema | |
415 | Unsupported Media Type | Unsupported Media Type. Include a Content-Type header with a supported value in the request. | Schema |