Get a paginated list of relationships

get/relationships

Internal-Use Only

Returns a paginated collection of relationships. The subject(s) are specified using either the resourceUri or the referenceId query parameter. Using resourceUri or referenceId in the filter parameter can conflict with the resourceUri or referenceId query parameter. Standard paging, filtering, and sorting options are provided. The media type of the returned items in the collection is application/vnd.sas.relationship+json. References may also be queried using POST /relationships#withQuery with the query string in the request body.

Request Samples

Response Samples

200
application/json
1{
2  "version": 2,
3  "accept": "application/vnd.sas.relationship",
4  "count": 3021,
5  "start": 0,
6  "limit": 2,
7  "name": "items",
8  "items": [
9    {
10      "creationTimeStamp": "2022-11-18T20:48:29.987000Z",
11      "createdBy": "sasuser",
12      "modifiedTimeStamp": "2022-11-18T20:48:29.987000Z",
13      "modifiedBy": "sasuser",
14      "id": "001a6075-617d-40a0-aae0-96e9db639a26",
15      "links": [
16        {
17          "method": "GET",
18          "rel": "self",
19          "href": "/relationships/relationships/001a6075-617d-40a0-aae0-96e9db639a26",
20          "uri": "/relationships/relationships/001a6075-617d-40a0-aae0-96e9db639a26",
21          "type": "application/vnd.sas.relationship"
22        },
23        {
24          "method": "DELETE",
25          "rel": "delete",
26          "href": "/relationships/relationships/001a6075-617d-40a0-aae0-96e9db639a26",
27          "uri": "/relationships/relationships/001a6075-617d-40a0-aae0-96e9db639a26"
28        },
29        {
30          "method": "PUT",
31          "rel": "update",
32          "href": "/relationships/relationships/001a6075-617d-40a0-aae0-96e9db639a26",
33          "uri": "/relationships/relationships/001a6075-617d-40a0-aae0-96e9db639a26",
34          "type": "application/vnd.sas.relationship",
35          "responseType": "application/vnd.sas.relationship"
36        },
37        {
38          "method": "GET",
39          "rel": "up",
40          "href": "/relationships/relationships",
41          "uri": "/relationships/relationships",
42          "type": "application/vnd.sas.collection",
43          "itemType": "application/vnd.sas.relationship"
44        }
45      ],
46      "resourceUri": "/dataTables/dataSources/Compute~fs~99e703fb-eeaa-43cb-ab9a-21f65b83a0e8~fs~DEMO_TGT/tables/NY_CLUSTERS/columns/LATLONG",
47      "type": "Contains",
48      "relatedResourceUri": "/catalog/instances/9dfc07c9-88a1-43dc-a3d9-19a4cdba3fc7",
49      "referenceId": "f28417bd-5c5b-864d-82b3-923cd1671741",
50      "relatedReferenceId": "9dfc07c9-88a1-43dc-a3d9-19a4cdba3fc7",
51      "version": 1
52    },
53    {
54      "creationTimeStamp": "2022-11-17T09:25:04.033000Z",
55      "createdBy": "sasuser",
56      "modifiedTimeStamp": "2022-11-17T09:25:04.033000Z",
57      "modifiedBy": "sasuser",
58      "id": "001bc483-2dc4-4707-860d-5107abd3e460",
59      "links": [
60        {
61          "method": "GET",
62          "rel": "self",
63          "href": "/relationships/relationships/001bc483-2dc4-4707-860d-5107abd3e460",
64          "uri": "/relationships/relationships/001bc483-2dc4-4707-860d-5107abd3e460",
65          "type": "application/vnd.sas.relationship"
66        },
67        {
68          "method": "DELETE",
69          "rel": "delete",
70          "href": "/relationships/relationships/001bc483-2dc4-4707-860d-5107abd3e460",
71          "uri": "/relationships/relationships/001bc483-2dc4-4707-860d-5107abd3e460"
72        },
73        {
74          "method": "PUT",
75          "rel": "update",
76          "href": "/relationships/relationships/001bc483-2dc4-4707-860d-5107abd3e460",
77          "uri": "/relationships/relationships/001bc483-2dc4-4707-860d-5107abd3e460",
78          "type": "application/vnd.sas.relationship",
79          "responseType": "application/vnd.sas.relationship"
80        },
81        {
82          "method": "GET",
83          "rel": "up",
84          "href": "/relationships/relationships",
85          "uri": "/relationships/relationships",
86          "type": "application/vnd.sas.collection",
87          "itemType": "application/vnd.sas.relationship"
88        }
89      ],
90      "resourceUri": "/casManagement/servers/cas-shared-default/caslibs/COMMON_PROD/tables/CONTACTS_ONLY",
91      "type": "Equivalent",
92      "relatedResourceUri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~COMMON_PROD/tables/CONTACTS_ONLY",
93      "referenceId": "b5fbc8bf-57c2-4166-ae7c-bbfd2fc226eb",
94      "relatedReferenceId": "c06dfdc9-1990-4df0-a7ec-ec517b7d9847",
95      "version": 1
96    }
97  ],
98  "links": [
99    {
100      "method": "GET",
101      "rel": "self",
102      "href": "/relationships/relationships?start=0&limit=2&sortBy=id",
103      "uri": "/relationships/relationships?start=0&limit=2&sortBy=id",
104      "type": "application/vnd.sas.collection",
105      "itemType": "application/vnd.sas.relationship"
106    },
107    {
108      "method": "GET",
109      "rel": "collection",
110      "href": "/relationships/relationships",
111      "uri": "/relationships/relationships",
112      "type": "application/vnd.sas.collection",
113      "itemType": "application/vnd.sas.relationship"
114    },
115    {
116      "method": "GET",
117      "rel": "up",
118      "href": "/relationships",
119      "uri": "/relationships",
120      "type": "application/vnd.sas.api"
121    },
122    {
123      "method": "POST",
124      "rel": "create",
125      "href": "/relationships/relationships",
126      "uri": "/relationships/relationships",
127      "type": "application/vnd.sas.relationship",
128      "responseType": "application/vnd.sas.relationship"
129    },
130    {
131      "method": "GET",
132      "rel": "next",
133      "href": "/relationships/relationships?limit=2&sortBy=id&start=2",
134      "uri": "/relationships/relationships?limit=2&sortBy=id&start=2",
135      "type": "application/vnd.sas.collection",
136      "itemType": "application/vnd.sas.relationship"
137    }
138  ]
139}

Query Parameters

Name	Type	Required	Description
limit	integer<int32>	false	The maximum number of items to return in this request. Default: 10
start	integer<int64>	false	The 0-based start index of a paginated request. Default: 0
depth	integer<int32>	false	How deep to traverse the relationships tree. A value >1 specifies a recursive traversal through the list of related resources up to the specified depth. A value of -1 returns all relationships for all resources. The default setting is 1, which returns only direct relationships of the resource. Default: 1
direction	string	false	The direction of the relationships to return. A relationship is defined as a resource URI "to" a related resource URI. A direction value of "from" returns relationships where the resource(s) indicated by the `resourceUri` or `referenceId` parameter is the related resource. A value of "both" returns all relationships that include the resource(s) indicated by the `resourceUri` or `referenceId` parameter.
filter	string<filter-criteria>	false	An expression for filtering the collection. Valid expressions include `eq(member,"string")`. Allowed members: `id`, `resourceUri`, `type`, `relatedResourceUri`, `source`, `resource.type`. The `resource.type` criteria is applied to each resource and related resource. When depth > 1, the relationship type and `resource.type` criteria are applied at each level. Relationships that are filtered out for a given level are not used to search the next level.
referenceId	string	false	The ID of the subject or subjects for which to get relationships. Specify multiple subjects by using the `'\|'` separator.
resourceUri	string	false	The subject or subjects for which to get relationships. Specify multiple subjects by using the `'\|'` separator.
sortBy	string<sort-criteria>	false	The sort criteria for returned relationships. Supports the following fields in either ascending or descending order: `id`, `type`, `resourceUri`, `referenceId`, `relatedResourceUri`, `relatedReferenceId`, `source`, `modifiedTimeStamp`, `creationTimeStamp`, `createdBy`, `modifiedBy`. Default: name

Responses

Status	Meaning	Description
200	OK	Ok.	Headers	Schema
400	Bad Request	Bad request (the request is not well-formed).		Schema