Get a list of Instances

get/instances

Returns a list of instances. The properties that can be used as filter and sort criteria are:

  • id,
  • name,
  • label,
  • description,
  • type,
  • createdBy,
  • creationTimeStamp,
  • modifiedBy,
  • modifiedTimeStamp,
  • definition,
  • resourceId,
  • endpoint1Id, and
  • endpoint2Id

Request Samples

Response Samples

1{
2  "version": 2,
3  "accept": "application/vnd.sas.metadata.instance.entity",
4  "count": 105,
5  "start": 0,
6  "limit": 2,
7  "name": "instances",
8  "items": [
9    {
10      "creationTimeStamp": "2021-10-01T14:05:27.219Z",
11      "createdBy": "sasuser",
12      "modifiedTimeStamp": "2021-10-01T14:05:27.219Z",
13      "modifiedBy": "sasuser",
14      "id": "b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
15      "links": [
16        {
17          "method": "GET",
18          "rel": "self",
19          "href": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
20          "uri": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
21          "type": "application/vnd.sas.metadata.instance.entity"
22        },
23        {
24          "method": "GET",
25          "rel": "alternate",
26          "href": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
27          "uri": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
28          "type": "application/vnd.sas.summary"
29        },
30        {
31          "method": "GET",
32          "rel": "up",
33          "href": "/catalog/instances",
34          "uri": "/catalog/instances",
35          "type": "application/vnd.sas.collection",
36          "itemType": "application/vnd.sas.metadata.instance"
37        },
38        {
39          "method": "PUT",
40          "rel": "update",
41          "href": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
42          "uri": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
43          "type": "application/vnd.sas.metadata.instance.entity",
44          "responseType": "application/vnd.sas.metadata.instance.entity"
45        },
46        {
47          "method": "DELETE",
48          "rel": "delete",
49          "href": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf",
50          "uri": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf"
51        },
52        {
53          "method": "GET",
54          "rel": "definition",
55          "href": "/catalog/definitions/02b7102c-e997-465d-9f41-2491c3a4f05b",
56          "uri": "/catalog/definitions/02b7102c-e997-465d-9f41-2491c3a4f05b",
57          "type": "application/vnd.sas.metadata.definition.entity"
58        },
59        {
60          "method": "GET",
61          "rel": "history",
62          "href": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf/history",
63          "uri": "/catalog/instances/b7a9f8f7-e939-2f4d-bb4b-b6740702f2bf/history",
64          "type": "application/vnd.sas.collection",
65          "itemType": "application/vnd.sas.metadata.instance.entity"
66        },
67        {
68          "method": "GET",
69          "rel": "resource",
70          "href": "/dataTables/dataSources/Compute~fs~77191529-3947-401d-a883-0cc6055ecc8e~fs~SASHELP/tables/AACOMP",
71          "uri": "/dataTables/dataSources/Compute~fs~77191529-3947-401d-a883-0cc6055ecc8e~fs~SASHELP/tables/AACOMP",
72          "type": "application/json"
73        }
74      ],
75      "version": 1,
76      "instanceType": "entity",
77      "definition": "sasTable",
78      "name": "AACOMP",
79      "type": "sasTable",
80      "attributes": {
81        "analysisTimeStamp": "2021-10-01T14:05:24.247Z",
82        "columnCount": 4,
83        "completenessPercent": 100,
84        "creator": "sas",
85        "dataLocale": "ENUSA",
86        "dataSize": 458752,
87        "dateCreated": "2021-09-28T08:03:09.972Z",
88        "dateModified": "2021-09-28T08:03:09.972Z",
89        "encoding": "us-ascii  ASCII (ANSI)",
90        "extension": "sas7bdat",
91        "informationPrivacy": "private",
92        "isView": false,
93        "reviewStatus": "none",
94        "rowCount": 2020,
95        "runStatus": "new",
96        "sourceSystem": "SAS"
97      },
98      "resourceId": "/dataTables/dataSources/Compute~fs~77191529-3947-401d-a883-0cc6055ecc8e~fs~SASHELP/tables/AACOMP"
99    },
100    {
101      "creationTimeStamp": "2021-10-01T14:05:28.432Z",
102      "createdBy": "sasuser",
103      "modifiedTimeStamp": "2021-10-01T14:05:28.432Z",
104      "modifiedBy": "sasuser",
105      "id": "91411bc6-a921-e443-80f0-c89c9c9216e6",
106      "links": [
107        {
108          "method": "GET",
109          "rel": "self",
110          "href": "/catalog/instances/91411bc6-a921-e443-80f0-c89c9c9216e6",
111          "uri": "/catalog/instances/91411bc6-a921-e443-80f0-c89c9c9216e6",
112          "type": "application/vnd.sas.metadata.instance.entity"
113        },
114        {
115          "method": "GET",
116          "rel": "alternate",
117          "href": "/catalog/instances/91411bc6-a921-e443-80f0-c89c9c9216e6",
118          "uri": "/catalog/instances/91411bc6-a921-e443-80f0-c89c9c9216e6",
119          "type": "application/vnd.sas.summary"
120        },
121        {
122          "method": "GET",
123          "rel": "up",
124          "href": "/catalog/instances",
125          "uri": "/catalog/instances",
126          "type": "application/vnd.sas.collection",
127          "itemType": "application/vnd.sas.metadata.instance"
128        },
129        {
130          "method": "PUT",
131          "rel": "update",
132          "href": "/catalog/instances/91411bc6-a921-e443-80f0-c89c9c9216e6",
133          "uri": "/catalog/instances/91411bc6-a921-e443-80f0-c89c9c9216e6",
134          "type": "application/vnd.sas.metadata.instance.entity",
135          "responseType": "application/vnd.sas.metadata.instance.entity"
136        },
137        {
138          "method": "DELETE",
139          "rel": "delete",
140          "href": "/catalog/instances/91411bc6-a921-e443-80f0-c89c9c9216e6",
141          "uri": "/catalog/instances/91411bc6-a921-e443-80f0-c89c9c9216e6"
142        },
143        {
144          "method": "GET",
145          "rel": "definition",
146          "href": "/catalog/definitions/02b7102c-e997-465d-9f41-2491c3a4f05b",
147          "uri": "/catalog/definitions/02b7102c-e997-465d-9f41-2491c3a4f05b",
148          "type": "application/vnd.sas.metadata.definition.entity"
149        },
150        {
151          "method": "GET",
152          "rel": "history",
153          "href": "/catalog/instances/91411bc6-a921-e443-80f0-c89c9c9216e6/history",
154          "uri": "/catalog/instances/91411bc6-a921-e443-80f0-c89c9c9216e6/history",
155          "type": "application/vnd.sas.collection",
156          "itemType": "application/vnd.sas.metadata.instance.entity"
157        },
158        {
159          "method": "GET",
160          "rel": "resource",
161          "href": "/dataTables/dataSources/Compute~fs~77191529-3947-401d-a883-0cc6055ecc8e~fs~SASHELP/tables/AARFM",
162          "uri": "/dataTables/dataSources/Compute~fs~77191529-3947-401d-a883-0cc6055ecc8e~fs~SASHELP/tables/AARFM",
163          "type": "application/json"
164        }
165      ],
166      "version": 1,
167      "instanceType": "entity",
168      "definition": "sasTable",
169      "name": "AARFM",
170      "type": "sasTable",
171      "attributes": {
172        "analysisTimeStamp": "2021-10-01T14:05:24.247Z",
173        "columnCount": 4,
174        "completenessPercent": 100,
175        "creator": "sas",
176        "dataLocale": "ENUSA",
177        "dataSize": 262144,
178        "dateCreated": "2021-09-28T08:04:02.220Z",
179        "dateModified": "2021-09-28T08:04:02.220Z",
180        "encoding": "us-ascii  ASCII (ANSI)",
181        "extension": "sas7bdat",
182        "informationPrivacy": "private",
183        "isView": false,
184        "reviewStatus": "none",
185        "rowCount": 130,
186        "runStatus": "new",
187        "sourceSystem": "SAS"
188      },
189      "resourceId": "/dataTables/dataSources/Compute~fs~77191529-3947-401d-a883-0cc6055ecc8e~fs~SASHELP/tables/AARFM"
190    }
191  ],
192  "links": [
193    {
194      "method": "GET",
195      "rel": "self",
196      "href": "/catalog/instances?start=0&limit=2&sortBy=name",
197      "uri": "/catalog/instances?start=0&limit=2&sortBy=name",
198      "type": "application/vnd.sas.collection",
199      "itemType": "application/vnd.sas.metadata.instance.entity"
200    },
201    {
202      "method": "GET",
203      "rel": "collection",
204      "href": "/catalog/instances",
205      "uri": "/catalog/instances",
206      "type": "application/vnd.sas.collection",
207      "itemType": "application/vnd.sas.metadata.instance.entity"
208    },
209    {
210      "method": "GET",
211      "rel": "up",
212      "href": "/catalog/definitions/02b7102c-e997-465d-9f41-2491c3a4f05b",
213      "uri": "/catalog/definitions/02b7102c-e997-465d-9f41-2491c3a4f05b",
214      "type": "application/vnd.sas.metadata.definition.entity"
215    },
216    {
217      "method": "GET",
218      "rel": "next",
219      "href": "/catalog/instances?limit=2&sortBy=name&start=2",
220      "uri": "/catalog/instances?limit=2&sortBy=name&start=2",
221      "type": "application/vnd.sas.collection",
222      "itemType": "application/vnd.sas.metadata.instance.entity"
223    },
224    {
225      "method": "POST",
226      "rel": "create",
227      "href": "/catalog/instances",
228      "uri": "/catalog/instances",
229      "type": "application/vnd.sas.metadata.instance.entity",
230      "responseType": "application/vnd.sas.metadata.instance.entity"
231    }
232  ]
233}

Query Parameters

NameTypeRequiredDescription
includeRelLinks
boolean
false

Control generation of HATEOAS links for relationships for an entity. This parameter only applies to representations of type application/vnd.sas.metadata.instance.entity+json; when set to true, the type definition for the entity is interrogated for relationship types that reference that type definition, and the endpoints of those relationships are exposed via a HATEOAS link in the entity's links array.

filter
string<filter-criteria>
false

Filter criteria for returned objects. See Filtering in REST APIs.

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

NameTypeRequiredDescription
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.

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+json
Default:
application/vnd.sas.metadata.instance+json

Responses

StatusMeaningDescription
200OK

OK.

HeadersSchema
401Unauthorized

Not authenticated.

Schema
403Forbidden
404Not Found

The Catalog service is not available.

Schema
406Not Acceptable

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

Schema
500Internal Server Error

The Catalog service encountered an error.

Schema