Update an Instance with a specific Instance ID

put/instances/{instanceId}

Internal-Use Only

Update an Instance with a specific Instance ID.

Request Samples

application/vnd.sas.metadata.instance.classification+json
1

Response Samples

200
application/json
1{
2  "creationTimeStamp": "2021-10-01T14:05:27.219Z",
3  "createdBy": "sasuser",
4  "modifiedTimeStamp": "2021-10-01T14:05:27.219Z",
5  "modifiedBy": "sasuser",
6  "id": "b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
7  "links": [
8    {
9      "method": "GET",
10      "rel": "self",
11      "href": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
12      "uri": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
13      "type": "application/vnd.sas.metadata.instance.entity"
14    },
15    {
16      "method": "GET",
17      "rel": "alternate",
18      "href": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
19      "uri": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
20      "type": "application/vnd.sas.summary"
21    },
22    {
23      "method": "GET",
24      "rel": "up",
25      "href": "/catalog/instances",
26      "uri": "/catalog/instances",
27      "type": "application/vnd.sas.collection",
28      "itemType": "application/vnd.sas.metadata.instance"
29    },
30    {
31      "method": "PUT",
32      "rel": "update",
33      "href": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
34      "uri": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
35      "type": "application/vnd.sas.metadata.instance.entity",
36      "responseType": "application/vnd.sas.metadata.instance.entity"
37    },
38    {
39      "method": "DELETE",
40      "rel": "delete",
41      "href": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
42      "uri": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf"
43    }
44  ],
45  "version": 1,
46  "instanceType": "entity",
47  "definition": "sasTable",
48  "name": "AACOMP",
49  "type": "sasTable",
50  "attributes": {
51    "analysisTimeStamp": "2021-10-01T14:05:24.247Z",
52    "columnCount": 4,
53    "completenessPercent": 100,
54    "creator": "sas",
55    "dataLocale": "ENUSA",
56    "dataSize": 458752,
57    "dateCreated": "2021-09-28T08:03:09.972Z",
58    "dateModified": "2021-09-28T08:03:09.972Z",
59    "encoding": "us-ascii  ASCII (ANSI)",
60    "extension": "sas7bdat",
61    "informationPrivacy": "private",
62    "isView": false,
63    "reviewStatus": "none",
64    "rowCount": 2020,
65    "runStatus": "new",
66    "sourceSystem": "SAS"
67  }
68}

Path Parameters

Name	Type	Required	Description
instanceId	string	true	The ID of the Instance

Header Parameters

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

Request Body

The classification in metadata used to categorize entities.

Name	Type	Required	Description
parentId	string	false	The ID of a parent classification.
properties	object	false	A key/value map containing additional properties for the classification.
instanceType	string<enumeration>	true	The type of metadata instance this represents. Immutable after creation. Allowed values: entityclassificationrelationship
definitionId	string	false	The identity of this object's parent definition. Immutable after creation. Either definitionId or definition must be provided. If definitionId is provided, definition is ignored.
definition	string	true	The name of this object's parent definition. Immutable after creation. Either definitionId or definition must be provided. If definitionId is provided, definition is ignored.
attributes	object	false	The attributes of the given type populated on this entity. The maximum length of the key is 100.
label	string	false	The user-facing name of this object; the maximum length is 255. Sometimes called the business label.
name	string	false	The name of this object; the maximum length is 1000. For classification instances, the name must be unique among all instances that share the same parentId.
description	string	false	The user description of this instance of metadata; the maximum length is 1000.
id	string	false	the unique identity of this object. Immutable after creation.
version	integer	false	The version of the media type.

Responses

Status	Meaning	Description
200	OK	The request succeeded.	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
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
500	Internal Server Error	The Catalog service encountered an error.		Schema