Get View Definitions

get/views
Internal-Use Only

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

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

Request Samples

1

Response Samples

1{
2 "version": 2,
3 "accept": "application/vnd.sas.metadata.definition.view",
4 "count": 1,
5 "start": 0,
6 "limit": 10,
7 "name": "views",
8 "items": [
9 {
10 "creationTimeStamp": "2022-03-23T14:36:42.145Z",
11 "createdBy": "sasuser",
12 "modifiedTimeStamp": "2022-03-23T14:36:42.145Z",
13 "modifiedBy": "sasuser",
14 "id": "a8fc4c97-b6b0-4026-81cc-c47af69ac56e",
15 "links": [
16 {
17 "method": "GET",
18 "rel": "self",
19 "href": "/catalog/views/a8fc4c97-b6b0-4026-81cc-c47af69ac56e",
20 "uri": "/catalog/views/a8fc4c97-b6b0-4026-81cc-c47af69ac56e",
21 "type": "application/vnd.sas.metadata.definition.view"
22 },
23 {
24 "method": "GET",
25 "rel": "up",
26 "href": "/catalog/views",
27 "uri": "/catalog/views",
28 "type": "application/vnd.sas.collection",
29 "itemType": "application/vnd.sas.metadata.definition.view"
30 },
31 {
32 "method": "PUT",
33 "rel": "update",
34 "href": "/catalog/views/a8fc4c97-b6b0-4026-81cc-c47af69ac56e",
35 "uri": "/catalog/views/a8fc4c97-b6b0-4026-81cc-c47af69ac56e",
36 "type": "application/vnd.sas.metadata.definition.view",
37 "responseType": "application/vnd.sas.metadata.definition.view"
38 },
39 {
40 "method": "DELETE",
41 "rel": "delete",
42 "href": "/catalog/views/a8fc4c97-b6b0-4026-81cc-c47af69ac56e",
43 "uri": "/catalog/views/a8fc4c97-b6b0-4026-81cc-c47af69ac56e"
44 }
45 ],
46 "version": 1,
47 "name": "dataSetColumns",
48 "label": "Dataset with Columns",
49 "description": "Dataset and columns",
50 "query": "match (t:dataSet)-[r:dataSetDataField]->(c:dataField)"
51 }
52 ],
53 "links": [
54 {
55 "method": "GET",
56 "rel": "self",
57 "href": "/catalog/views?start=0&limit=10&sortBy=name",
58 "uri": "/catalog/views?start=0&limit=10&sortBy=name",
59 "type": "application/vnd.sas.collection",
60 "itemType": "application/vnd.sas.metadata.definition.view"
61 },
62 {
63 "method": "GET",
64 "rel": "collection",
65 "href": "/catalog/views",
66 "uri": "/catalog/views",
67 "type": "application/vnd.sas.collection",
68 "itemType": "application/vnd.sas.metadata.definition.view"
69 },
70 {
71 "method": "GET",
72 "rel": "up",
73 "href": "/catalog",
74 "uri": "/catalog",
75 "type": "application/vnd.sas.api"
76 },
77 {
78 "method": "POST",
79 "rel": "create",
80 "href": "/catalog/views",
81 "uri": "/catalog/views",
82 "type": "application/vnd.sas.metadata.definition.view",
83 "responseType": "application/vnd.sas.metadata.definition.view"
84 }
85 ]
86}

Query Parameters

NameTypeRequiredDescription
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.definition.view+jsonapplication/json
Default:
application/vnd.sas.metadata.definition.view+json

Responses

StatusMeaningDescription
200OKOK.HeadersSchema
401UnauthorizedNot authenticated.Schema
403ForbiddenThe user does not have permission to complete this request.Schema
404Not FoundThe Catalog service is not available.Schema
406Not AcceptableNot Acceptable. Include an Accept header with a supported value on the request.Schema