Get references

get/references
Internal-Use Only

Returns a collection of references. Standard paging, filtering, and sorting options are provided. The default media type of the returned items in the collection is application/vnd.sas.relationship.reference+json. References may also be queried using POST /references#withQuery with the query string in the request body.

Request Samples

1

Response Samples

1{
2  "version": 2,
3  "accept": "application/vnd.sas.relationship.reference",
4  "count": 1,
5  "start": 0,
6  "limit": 2,
7  "name": "items",
8  "items": [
9    {
10      "creationTimeStamp": "2022-11-22T16:43:41.586000Z",
11      "modifiedTimeStamp": "2022-11-22T16:43:41.586000Z",
12      "id": "6293390f-8f76-4620-afc1-29a94d09fb83",
13      "links": [
14        {
15          "method": "GET",
16          "rel": "self",
17          "href": "/relationships/references/6293390f-8f76-4620-afc1-29a94d09fb83",
18          "uri": "/relationships/references/6293390f-8f76-4620-afc1-29a94d09fb83",
19          "type": "application/vnd.sas.relationship.reference"
20        },
21        {
22          "method": "GET",
23          "rel": "up",
24          "href": "/relationships/references",
25          "uri": "/relationships/references",
26          "type": "application/vnd.sas.collection",
27          "itemType": "application/vnd.sas.relationship.reference"
28        },
29        {
30          "method": "PUT",
31          "rel": "update",
32          "href": "/relationships/references/6293390f-8f76-4620-afc1-29a94d09fb83",
33          "uri": "/relationships/references/6293390f-8f76-4620-afc1-29a94d09fb83",
34          "type": "application/vnd.sas.relationship.reference",
35          "responseType": "application/vnd.sas.relationship.reference"
36        },
37        {
38          "method": "DELETE",
39          "rel": "delete",
40          "href": "/relationships/references/6293390f-8f76-4620-afc1-29a94d09fb83",
41          "uri": "/relationships/references/6293390f-8f76-4620-afc1-29a94d09fb83"
42        },
43        {
44          "method": "GET",
45          "rel": "getRelationships",
46          "href": "/relationships/relationships?referenceId=6293390f-8f76-4620-afc1-29a94d09fb83",
47          "uri": "/relationships/relationships?referenceId=6293390f-8f76-4620-afc1-29a94d09fb83",
48          "type": "application/vnd.sas.collection",
49          "responseType": "application/vnd.sas.collection",
50          "itemType": "application/vnd.sas.relationship"
51        }
52      ],
53      "name": "COSTCHANGE",
54      "resourceUri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~Samples/tables/COSTCHANGE",
55      "contentType": "casTable",
56      "source": "SAS",
57      "analysisTimeStamp": "2022-11-22T16:43:42.543000Z",
58      "version": 1
59    }
60  ],
61  "links": [
62    {
63      "method": "GET",
64      "rel": "self",
65      "href": "/relationships/references?start=0&limit=2&filter=eq%28name%2C%27COSTCHANGE%27%29&sortBy=name",
66      "uri": "/relationships/references?start=0&limit=2&filter=eq%28name%2C%27COSTCHANGE%27%29&sortBy=name",
67      "type": "application/vnd.sas.collection",
68      "itemType": "application/vnd.sas.relationship.reference"
69    },
70    {
71      "method": "GET",
72      "rel": "collection",
73      "href": "/relationships/references",
74      "uri": "/relationships/references",
75      "type": "application/vnd.sas.collection",
76      "itemType": "application/vnd.sas.relationship.reference"
77    },
78    {
79      "method": "GET",
80      "rel": "up",
81      "href": "/relationships",
82      "uri": "/relationships",
83      "type": "application/vnd.sas.api"
84    },
85    {
86      "method": "POST",
87      "rel": "create",
88      "href": "/relationships/references",
89      "uri": "/relationships/references",
90      "type": "application/vnd.sas.relationship.reference",
91      "responseType": "application/vnd.sas.relationship.reference"
92    }
93  ]
94}

Query Parameters

NameTypeRequiredDescription
filter
string<filter-criteria>
false

Filter criteria for returned references. Filters are supported on the following top level fields for references: id, name, resourceUri, type, source, analysisTimeStamp, modifiedTimeStamp, creationTimeStamp, createdBy, modifiedBy.

limit
integer
false

The maximum number of references to return in this page of results. The actual number of returned references may be less if the collection has been exhausted.

Default:
50
sortBy
string<sort-criteria>
false

Sort the returned resources. The sort criteria supports the following fields in ascending or descending order: id, name, resourceUri, type, source, analysisTimeStamp, modifiedTimeStamp, creationTimeStamp, createdBy, modifiedBy.

start
integer
false

The starting index of the first reference in a page.

Default:
0

Header Parameters

NameTypeRequiredDescription
Accept-Item
string
false

An alternative media type that the service recognizes. Optional. If the service can not provide the media type, a 406 response is returned.

Allowed values:
application/vnd.sas.summary+jsonapplication/vnd.sas.relationship.reference+json

Responses

StatusMeaningDescription
200OKOk.HeadersSchema
400Bad RequestBad request (the request is not well-formed).Schema