Update a Tag by its ID

put/tags/{tagId}

Internal-Use Only

Update a Tag by its ID. If the user does not have the appropriate authorization for the given tag and both the existing and updated members of the given tag then the update operation fails with a 403 Forbidden error. If the update operation removes all tag members from a given tag then the tag will be deleted and a 204 response returned.

Request Samples

application/vnd.sas.metadata.tag+json
1

Response Samples

200
application/vnd.sas.metadata.tag+json
1{
2  "creationTimeStamp": "2021-04-13T00:00:00Z",
3  "createdBy": "sasuser",
4  "modifiedTimeStamp": "2021-04-13T00:00:00Z",
5  "modifiedBy": "sasuser",
6  "id": "a56ce67a-54e0-44e4-bce2-2398a8b27b2e",
7  "links": [
8    {
9      "method": "GET",
10      "rel": "self",
11      "href": "/catalog/tags/a56ce67a-54e0-44e4-bce2-2398a8b27b2e?memberStart=0&memberLimit=2147483647",
12      "uri": "/catalog/tags/a56ce67a-54e0-44e4-bce2-2398a8b27b2e?memberStart=0&memberLimit=2147483647",
13      "type": "application/vnd.sas.metadata.tag"
14    },
15    {
16      "method": "GET",
17      "rel": "up",
18      "href": "/catalog/tags",
19      "uri": "/catalog/tags",
20      "type": "application/vnd.sas.collection",
21      "itemType": "application/vnd.sas.metadata.tag.summary"
22    },
23    {
24      "method": "PUT",
25      "rel": "update",
26      "href": "/catalog/tags/a56ce67a-54e0-44e4-bce2-2398a8b27b2e",
27      "uri": "/catalog/tags/a56ce67a-54e0-44e4-bce2-2398a8b27b2e",
28      "type": "application/vnd.sas.metadata.tag",
29      "responseType": "application/vnd.sas.metadata.tag"
30    },
31    {
32      "method": "DELETE",
33      "rel": "delete",
34      "href": "/catalog/tags/a56ce67a-54e0-44e4-bce2-2398a8b27b2e",
35      "uri": "/catalog/tags/a56ce67a-54e0-44e4-bce2-2398a8b27b2e"
36    }
37  ],
38  "version": 1,
39  "name": "Sales",
40  "members": {
41    "version": 1,
42    "type": "id",
43    "template": "/catalog/instances/{id}",
44    "resources": [
45      "b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
46      "91411bc6-a921-e443-80f0-c89c9c9216e6"
47    ]
48  }
49}

Path Parameters

Name	Type	Required	Description
tagId	string	true	The ID of the Tag

Header Parameters

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

Request Body

Information about a tag. Currently tags only supports tagging entities. Only /catalog/instances/{id} is accepted for the template property within members.

Name	Type	Required	Description
id	string	true	The unique identifier of this tag. Immutable after creation.
name	string	true	The name of the tag; the maximum length is 100.
links	array [Link]	false	The links that apply to the tag.
members	Selection	false	Identifies a set of resources.

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
204	No Content	The request succeeded.
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
406	Not Acceptable	Not Acceptable. Include an Accept header with a supported value on the request.		Schema
412	Precondition Failed	Precondition failed. The target has changed since it was last fetched.		Schema
415	Unsupported Media Type	Unsupported Media Type. Include a Content-Type header with a supported value in the request.		Schema
428	Precondition Required	Precondition required. Include an If-Match header with the request.		Schema