Manipulate individual properties on a draft term using JSON Patch requests

patch/terms/{termId}/draft

Internal-Use Only

Patch updates properties on a draft term. Only the parentId field can be manipulated. It can be changed only on drafts that have not been created from a published term.

Request Samples

application/json-patch
1

Response Samples

200
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}

Path Parameters

Name	Type	Required	Description
termId	string	true	The ID of the term.

Header Parameters

Name	Type	Required	Description
Content-Type	string	true	The representation in the request body. Allowed values: application/json-patch+jsonapplication/json Default: application/json-patch+json
If-Match	string	true	The ETag that was returned from a GET, POST, PUT, PATCH, or HEAD of this object. If the ETag does not match, the update will fail.
Accept	string	false	The desired representation for the response. Allowed values: application/vnd.sas.glossary.termapplication/json Default: application/vnd.sas.glossary.term

Request Body

A JSONPatch document containing the operations to be performed on the defined term.

Name	Type	Required	Description
op	string	true	The type of operation to be performed on the defined term; either 'add' (which also updates), or 'remove'. Other patch operations are not supported. Allowed values: addremove
path	string	true	The JSON path to the property to be manipulated. Only "/parentId" is supported.
value	string	false	The new value of the property for 'add' operations. The value must be the ID of a term that can be the parent for the specified term.

Responses

Status	Meaning	Description
200	OK	The request succeeded, and the draft term has been updated.	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
404	Not Found	The specified resource was not found.		Schema
412	Precondition Failed	Precondition failed. The target has changed since it was last fetched.		Schema
428	Precondition Required	Precondition required. Include an If-Match header with the request.		Schema