Get a Type Definition by its ID

get/definitions/{definitionId}

Get a Type Definition by its ID. The definition itself must be supported by the media type(s) specified in the accept header; application/vnd.sas.metadata.definition.summary and application/json will match any type.

Request Samples

1

Response Samples

1{
2  "creationTimeStamp": "2021-01-19T00:00:00Z",
3  "createdBy": "sasuser",
4  "modifiedTimeStamp": "2021-01-19T00:00:00Z",
5  "modifiedBy": "sasuser",
6  "id": "7f2d115f-6713-4c71-8fea-08beefb34dbb",
7  "links": [
8    {
9      "method": "GET",
10      "rel": "self",
11      "href": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb",
12      "uri": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb",
13      "type": "application/vnd.sas.metadata.definition.classification"
14    },
15    {
16      "method": "GET",
17      "rel": "alternate",
18      "href": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb",
19      "uri": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb",
20      "type": "application/vnd.sas.metadata.definition.summary"
21    },
22    {
23      "method": "GET",
24      "rel": "up",
25      "href": "/catalog/definitions",
26      "uri": "/catalog/definitions",
27      "type": "application/vnd.sas.collection",
28      "itemType": "application/vnd.sas.metadata.definition.summary"
29    },
30    {
31      "method": "PUT",
32      "rel": "update",
33      "href": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb",
34      "uri": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb",
35      "type": "application/vnd.sas.metadata.definition.classification",
36      "responseType": "application/vnd.sas.metadata.definition.classification"
37    },
38    {
39      "method": "DELETE",
40      "rel": "delete",
41      "href": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb",
42      "uri": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb"
43    }
44  ],
45  "version": 1,
46  "definitionType": "classification",
47  "name": "retention",
48  "label": "Retention",
49  "description": "Defines the retention requirements for related data items."
50}

Path Parameters

NameTypeRequiredDescription
definitionId
string
true

The ID of the Type Definition

Query Parameters

NameTypeRequiredDescription
includeInheritedAttributes
string
false

Indicates whether to display inherited attributes in response. Defaults to false.

Header Parameters

NameTypeRequiredDescription
Accept
string
false

The desired representation for the response.

Allowed values:
application/vnd.sas.metadata.definition.summary+jsonapplication/vnd.sas.metadata.definition.attribute+jsonapplication/vnd.sas.metadata.definition.classification+jsonapplication/vnd.sas.metadata.definition.entity+jsonapplication/vnd.sas.metadata.definition.relationship+jsonapplication/json
Default:
application/vnd.sas.metadata.definition.summary+json

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
400Bad Request

Bad request (the request is not well-formed).

Schema
401Unauthorized

Not authenticated.

Schema
403Forbidden

The user does not have permission to complete this request.

Schema
404Not Found

The specified resource was not found.

Schema
406Not Acceptable

Not Acceptable. Include an Accept header with a supported value on the request.

Schema