Get indexable representations for files

get/files
Internal-Use Only

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

Request Samples

1

Response Samples

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

Query Parameters

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

Header Parameters

NameTypeRequiredDescription
Accept-Item
string
true

The value of the file resource media type. You must specify this as "application/vnd.sas.search.indexable.data".

Responses

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