Get summary representations

get/files

Internal-Use Only

Retrieves summary representations of file resources for the specified criteria. Standard paging, filtering, and sorting options are available.

Request Samples

Response Samples

200
application/vnd.sas.collection+json
1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "self",
6      "href": "/files/files?sortBy=name&start=0&limit=3",
7      "uri": "/files/files?sortBy=name&start=0&limit=3",
8      "type": "application/vnd.sas.collection"
9    },
10    {
11      "method": "GET",
12      "rel": "next",
13      "href": "/files/files?sortBy=name&start=3&limit=3",
14      "uri": "/files/files?sortBy=name&start=3&limit=3",
15      "type": "application/vnd.sas.collection"
16    },
17    {
18      "method": "GET",
19      "rel": "last",
20      "href": "/files/files?sortBy=name&start=3&limit=3",
21      "uri": "/files/files?sortBy=name&start=3&limit=3",
22      "type": "application/vnd.sas.collection"
23    }
24  ],
25  "name": "files",
26  "accept": "application/vnd.sas.summary",
27  "start": 0,
28  "count": 6,
29  "items": [
30    {
31      "creationTimeStamp": "2022-04-13T17:53:51.710Z",
32      "modifiedTimeStamp": "2022-04-13T17:53:51.710Z",
33      "createdBy": "SysUser",
34      "modifiedBy": "SysUser",
35      "id": "bccd30ff-8603-4770-bfa3-b771f6713ffb",
36      "type": "file",
37      "name": "Attributes.csv",
38      "links": [
39        {
40          "method": "GET",
41          "rel": "self",
42          "href": "/files/files/bccd30ff-8603-4770-bfa3-b771f6713ffb",
43          "uri": "/files/files/bccd30ff-8603-4770-bfa3-b771f6713ffb",
44          "type": "application/vnd.sas.file"
45        },
46        {
47          "method": "GET",
48          "rel": "alternate",
49          "href": "/files/files/bccd30ff-8603-4770-bfa3-b771f6713ffb",
50          "uri": "/files/files/bccd30ff-8603-4770-bfa3-b771f6713ffb",
51          "type": "application/vnd.sas.summary"
52        }
53      ],
54      "version": 2
55    },
56    {
57      "creationTimeStamp": "2022-04-13T17:53:55.567Z",
58      "modifiedTimeStamp": "2022-04-13T17:53:55.567Z",
59      "createdBy": "SysUser",
60      "modifiedBy": "SysUser",
61      "id": "acd5718a-c0ec-46b1-a0c0-de4a42db584a",
62      "type": "file",
63      "name": "Attributes.csv",
64      "links": [
65        {
66          "method": "GET",
67          "rel": "self",
68          "href": "/files/files/acd5718a-c0ec-46b1-a0c0-de4a42db584a",
69          "uri": "/files/files/acd5718a-c0ec-46b1-a0c0-de4a42db584a",
70          "type": "application/vnd.sas.file"
71        },
72        {
73          "method": "GET",
74          "rel": "alternate",
75          "href": "/files/files/acd5718a-c0ec-46b1-a0c0-de4a42db584a",
76          "uri": "/files/files/acd5718a-c0ec-46b1-a0c0-de4a42db584a",
77          "type": "application/vnd.sas.summary"
78        }
79      ],
80      "version": 2
81    },
82    {
83      "creationTimeStamp": "2022-04-13T17:53:57.219Z",
84      "modifiedTimeStamp": "2022-04-13T17:53:57.219Z",
85      "createdBy": "SysUser",
86      "modifiedBy": "SysUser",
87      "id": "335f6597-96f8-4851-a76a-9672af8c6c62",
88      "type": "file",
89      "name": "Attributes.csv",
90      "links": [
91        {
92          "method": "GET",
93          "rel": "self",
94          "href": "/files/files/335f6597-96f8-4851-a76a-9672af8c6c62",
95          "uri": "/files/files/335f6597-96f8-4851-a76a-9672af8c6c62",
96          "type": "application/vnd.sas.file"
97        },
98        {
99          "method": "GET",
100          "rel": "alternate",
101          "href": "/files/files/335f6597-96f8-4851-a76a-9672af8c6c62",
102          "uri": "/files/files/335f6597-96f8-4851-a76a-9672af8c6c62",
103          "type": "application/vnd.sas.summary"
104        }
105      ],
106      "version": 2
107    }
108  ],
109  "limit": 3,
110  "version": 2
111}

Query Parameters

Name	Type	Required	Description
filter	string	false	The filter criteria to apply to the returned member collection.
limit	integer<int64>	false	The maximum number of members to return. The default value is 10.
parentUri	string	false	The URI of the associated object or parent object.
sortBy	string	false	The sort criteria to apply to the returned member collection.
start	integer<int64>	false	The offset of the first member to return. The default value is 0.

Header Parameters

Name	Type	Required	Description
Accept-Item	string	true	The value of the file resource media type. You must specify this as "application/vnd.sas.summary".

Responses

Status	Meaning	Description
200	OK	The request succeeded. If files are found for the specified criteria, summary representations are returned in a collection. If no files are found, an empty collection is returned.		Schema
400	Bad Request	The request was not valid. The `limit` parameter cannot be less than 0 or greater than 10000.