Get Type Definitions

get/definitions

Returns a list of type definitions. The collection may contain different kinds of type definitions (e.g. attribute, classification, entity, and relationship type definitions); the 'definitionType' field can be used to determine the type. The kind of type definitions in the collection can also be controlled via the 'Accept-Item' header. The properties that can be used as filter and sort criteria are:

id,
name,
label,
description,
createdBy,
creationTimeStamp,
modifiedBy, and
modifiedTimeStamp.

Request Samples

Response Samples


1{
2  "version": 2,
3  "accept": "application/vnd.sas.metadata.definition.summary",
4  "count": 4,
5  "start": 0,
6  "limit": 10,
7  "name": "definitions",
8  "items": [
9    {
10      "creationTimeStamp": "2021-01-19T00:00:00Z",
11      "modifiedTimeStamp": "2021-01-19T00:00:00Z",
12      "id": "de367483-2d27-4ad9-be56-31043dae8525",
13      "links": [
14        {
15          "method": "GET",
16          "rel": "self",
17          "href": "/catalog/definitions/de367483-2d27-4ad9-be56-31043dae8525",
18          "uri": "/catalog/definitions/de367483-2d27-4ad9-be56-31043dae8525",
19          "type": "application/vnd.sas.metadata.definition.entity"
20        },
21        {
22          "method": "GET",
23          "rel": "alternate",
24          "href": "/catalog/definitions/de367483-2d27-4ad9-be56-31043dae8525",
25          "uri": "/catalog/definitions/de367483-2d27-4ad9-be56-31043dae8525",
26          "type": "application/vnd.sas.metadata.definition.summary"
27        },
28        {
29          "method": "GET",
30          "rel": "up",
31          "href": "/catalog/definitions",
32          "uri": "/catalog/definitions",
33          "type": "application/vnd.sas.collection",
34          "itemType": "application/vnd.sas.metadata.definition.summary"
35        },
36        {
37          "method": "PUT",
38          "rel": "update",
39          "href": "/catalog/definitions/de367483-2d27-4ad9-be56-31043dae8525",
40          "uri": "/catalog/definitions/de367483-2d27-4ad9-be56-31043dae8525",
41          "type": "application/vnd.sas.metadata.definition.entity",
42          "responseType": "application/vnd.sas.metadata.definition.entity"
43        },
44        {
45          "method": "DELETE",
46          "rel": "delete",
47          "href": "/catalog/definitions/de367483-2d27-4ad9-be56-31043dae8525",
48          "uri": "/catalog/definitions/de367483-2d27-4ad9-be56-31043dae8525"
49        }
50      ],
51      "version": 1,
52      "definitionType": "entity",
53      "name": "asset",
54      "label": "Asset",
55      "description": "The asset object all metadata objects inherit from."
56    },
57    {
58      "creationTimeStamp": "2021-01-19T00:00:00Z",
59      "modifiedTimeStamp": "2021-01-19T00:00:00Z",
60      "id": "55212128-3647-472a-9fd0-dc19d9731c19",
61      "links": [
62        {
63          "method": "GET",
64          "rel": "self",
65          "href": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19",
66          "uri": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19",
67          "type": "application/vnd.sas.metadata.definition.relationship"
68        },
69        {
70          "method": "GET",
71          "rel": "alternate",
72          "href": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19",
73          "uri": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19",
74          "type": "application/vnd.sas.metadata.definition.summary"
75        },
76        {
77          "method": "GET",
78          "rel": "up",
79          "href": "/catalog/definitions",
80          "uri": "/catalog/definitions",
81          "type": "application/vnd.sas.collection",
82          "itemType": "application/vnd.sas.metadata.definition.summary"
83        },
84        {
85          "method": "PUT",
86          "rel": "update",
87          "href": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19",
88          "uri": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19",
89          "type": "application/vnd.sas.metadata.definition.relationship",
90          "responseType": "application/vnd.sas.metadata.definition.relationship"
91        },
92        {
93          "method": "DELETE",
94          "rel": "delete",
95          "href": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19",
96          "uri": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19"
97        }
98      ],
99      "version": 1,
100      "definitionType": "relationship",
101      "name": "relatedObjects",
102      "label": "Entity to related entity",
103      "description": "Entity to a related entity without specific relationship knowledge."
104    },
105    {
106      "creationTimeStamp": "2021-01-19T00:00:00Z",
107      "modifiedTimeStamp": "2021-01-19T00:00:00Z",
108      "id": "7f2d115f-6713-4c71-8fea-08beefb34dbb",
109      "links": [
110        {
111          "method": "GET",
112          "rel": "self",
113          "href": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb",
114          "uri": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb",
115          "type": "application/vnd.sas.metadata.definition.classification"
116        },
117        {
118          "method": "GET",
119          "rel": "alternate",
120          "href": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb",
121          "uri": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb",
122          "type": "application/vnd.sas.metadata.definition.summary"
123        },
124        {
125          "method": "GET",
126          "rel": "up",
127          "href": "/catalog/definitions",
128          "uri": "/catalog/definitions",
129          "type": "application/vnd.sas.collection",
130          "itemType": "application/vnd.sas.metadata.definition.summary"
131        },
132        {
133          "method": "PUT",
134          "rel": "update",
135          "href": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb",
136          "uri": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb",
137          "type": "application/vnd.sas.metadata.definition.classification",
138          "responseType": "application/vnd.sas.metadata.definition.classification"
139        },
140        {
141          "method": "DELETE",
142          "rel": "delete",
143          "href": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb",
144          "uri": "/catalog/definitions/7f2d115f-6713-4c71-8fea-08beefb34dbb"
145        }
146      ],
147      "version": 1,
148      "definitionType": "classification",
149      "name": "retention",
150      "label": "Retention",
151      "description": "Defines the retention requirements for related data items."
152    },
153    {
154      "creationTimeStamp": "2021-01-19T00:00:00Z",
155      "modifiedTimeStamp": "2021-01-19T00:00:00Z",
156      "id": "9e771b12-ace3-4b8a-bce0-b7d99852a213",
157      "links": [
158        {
159          "method": "GET",
160          "rel": "self",
161          "href": "/catalog/definitions/9e771b12-ace3-4b8a-bce0-b7d99852a213",
162          "uri": "/catalog/definitions/9e771b12-ace3-4b8a-bce0-b7d99852a213",
163          "type": "application/vnd.sas.metadata.definition.attribute"
164        },
165        {
166          "method": "GET",
167          "rel": "alternate",
168          "href": "/catalog/definitions/9e771b12-ace3-4b8a-bce0-b7d99852a213",
169          "uri": "/catalog/definitions/9e771b12-ace3-4b8a-bce0-b7d99852a213",
170          "type": "application/vnd.sas.metadata.definition.summary"
171        },
172        {
173          "method": "GET",
174          "rel": "up",
175          "href": "/catalog/definitions",
176          "uri": "/catalog/definitions",
177          "type": "application/vnd.sas.collection",
178          "itemType": "application/vnd.sas.metadata.definition.summary"
179        },
180        {
181          "method": "PUT",
182          "rel": "update",
183          "href": "/catalog/definitions/9e771b12-ace3-4b8a-bce0-b7d99852a213",
184          "uri": "/catalog/definitions/9e771b12-ace3-4b8a-bce0-b7d99852a213",
185          "type": "application/vnd.sas.metadata.definition.attribute",
186          "responseType": "application/vnd.sas.metadata.definition.attribute"
187        },
188        {
189          "method": "DELETE",
190          "rel": "delete",
191          "href": "/catalog/definitions/9e771b12-ace3-4b8a-bce0-b7d99852a213",
192          "uri": "/catalog/definitions/9e771b12-ace3-4b8a-bce0-b7d99852a213"
193        }
194      ],
195      "version": 1,
196      "definitionType": "attribute",
197      "name": "string",
198      "label": "String",
199      "description": "Attribute type to represent string values"
200    }
201  ],
202  "links": [
203    {
204      "method": "GET",
205      "rel": "self",
206      "href": "/catalog/definitions?start=0&limit=10&filter=or%28eq%28id%2C%279e771b12-ace3-4b8a-bce0-b7d99852a213%27%29%2Ceq%28id%2C%27de367483-2d27-4ad9-be56-31043dae8525%27%29%2Ceq%28id%2C%277f2d115f-6713-4c71-8fea-08beefb34dbb%27%29%2Ceq%28id%2C%2755212128-3647-472a-9fd0-dc19d9731c19%27%29%29&sortBy=name",
207      "uri": "/catalog/definitions?start=0&limit=10&filter=or%28eq%28id%2C%279e771b12-ace3-4b8a-bce0-b7d99852a213%27%29%2Ceq%28id%2C%27de367483-2d27-4ad9-be56-31043dae8525%27%29%2Ceq%28id%2C%277f2d115f-6713-4c71-8fea-08beefb34dbb%27%29%2Ceq%28id%2C%2755212128-3647-472a-9fd0-dc19d9731c19%27%29%29&sortBy=name",
208      "type": "application/vnd.sas.collection",
209      "itemType": "application/vnd.sas.metadata.definition.summary"
210    },
211    {
212      "method": "GET",
213      "rel": "collection",
214      "href": "/catalog/definitions",
215      "uri": "/catalog/definitions",
216      "type": "application/vnd.sas.collection",
217      "itemType": "application/vnd.sas.metadata.definition.summary"
218    },
219    {
220      "method": "GET",
221      "rel": "up",
222      "href": "/catalog",
223      "uri": "/catalog",
224      "type": "application/vnd.sas.api"
225    },
226    {
227      "method": "POST",
228      "rel": "create",
229      "href": "/catalog/definitions",
230      "uri": "/catalog/definitions",
231      "type": "application/vnd.sas.metadata.definition.summary",
232      "responseType": "application/vnd.sas.metadata.definition.summary"
233    }
234  ]
235}

Query Parameters


filter	string<filter-criteria>	false	Filter criteria for returned objects. See Filtering in REST APIs.
includeInheritedAttributes	string	false	Indicates whether to display inherited attributes in response. Defaults to false.
limit	integer	false	Maximum number of objects to return. Defaults to 10.
sortBy	string<sort-criteria>	false	Sort returned objects. See Sorting in REST APIs.
start	integer	false	0-based Offset of first object to return. Defaults to 0.

Header Parameters


Accept	string	false	The desired representation for the response. Allowed values: application/vnd.sas.collection+jsonapplication/json Default: application/vnd.sas.collection+json
Accept-Item	string	false	The desired item representation for collections; the default is application/vnd.sas.metadata.definition.summary+json, which can return heterogeneous type definitions in the collection. Specifying a particular kind of type definition ensures only that kind will appear in the collection. 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

Status	Meaning	Description
200	OK	OK.	Headers	Schema
400	Bad Request
401	Unauthorized	Not authenticated.		Schema
403	Forbidden
404	Not Found	The Catalog service is not available.		Schema