Get file resources

get/files

Internal-Use Only

Retrieves 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=2",
7      "uri": "/files/files?sortBy=name&start=0&limit=2",
8      "type": "application/vnd.sas.collection"
9    },
10    {
11      "method": "GET",
12      "rel": "next",
13      "href": "/files/files?sortBy=name&start=2&limit=2",
14      "uri": "/files/files?sortBy=name&start=2&limit=2",
15      "type": "application/vnd.sas.collection"
16    },
17    {
18      "method": "GET",
19      "rel": "last",
20      "href": "/files/files?sortBy=name&start=544&limit=2",
21      "uri": "/files/files?sortBy=name&start=544&limit=2",
22      "type": "application/vnd.sas.collection"
23    }
24  ],
25  "name": "files",
26  "accept": "application/vnd.sas.file",
27  "start": 0,
28  "count": 546,
29  "items": [
30    {
31      "creationTimeStamp": "2022-03-31T20:00:03.609Z",
32      "modifiedTimeStamp": "2022-03-31T20:00:03.826Z",
33      "createdBy": "sas.audit",
34      "modifiedBy": "sas.audit",
35      "id": "cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
36      "parentUri": "/jobExecution/jobs/b9fe292d-2a4e-434c-8154-5f490b4b9257",
37      "properties": {
38        "LastState": "running",
39        "JobRequest": "",
40        "Job": "b9fe292d-2a4e-434c-8154-5f490b4b9257",
41        "Provider": "casl"
42      },
43      "contentDisposition": "text/plain",
44      "contentType": "text/plain",
45      "description": "Log File for Job b9fe292d-2a4e-434c-8154-5f490b4b9257",
46      "documentType": "log",
47      "encoding": "UTF-8",
48      "links": [
49        {
50          "method": "GET",
51          "rel": "self",
52          "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
53          "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
54          "type": "application/vnd.sas.file"
55        },
56        {
57          "method": "GET",
58          "rel": "alternate",
59          "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
60          "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
61          "type": "application/vnd.sas.summary"
62        },
63        {
64          "method": "PATCH",
65          "rel": "patch",
66          "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
67          "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
68          "type": "application/vnd.sas.file",
69          "responseType": "application/vnd.sas.file"
70        },
71        {
72          "method": "PUT",
73          "rel": "update",
74          "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
75          "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
76          "type": "application/vnd.sas.file",
77          "responseType": "application/vnd.sas.file"
78        },
79        {
80          "method": "DELETE",
81          "rel": "delete",
82          "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7",
83          "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7"
84        },
85        {
86          "method": "GET",
87          "rel": "content",
88          "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7/content",
89          "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7/content",
90          "type": "text/plain"
91        },
92        {
93          "method": "PUT",
94          "rel": "updateContent",
95          "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7/content",
96          "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7/content",
97          "type": "*/*",
98          "responseType": "application/vnd.sas.file"
99        },
100        {
101          "method": "POST",
102          "rel": "copyFile",
103          "href": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7/copy",
104          "uri": "/files/files/cddc7f5d-9b30-4bf1-bb2f-6d5e40728cb7/copy",
105          "responseType": "application/vnd.sas.file"
106        },
107        {
108          "method": "POST",
109          "rel": "create",
110          "href": "/files/files",
111          "uri": "/files/files",
112          "type": "*/*",
113          "responseType": "application/vnd.sas.file"
114        }
115      ],
116      "name": "2022-03-31T20:00:03Z-results.log",
117      "size": 742,
118      "searchable": false,
119      "fileStatus": "unlocked",
120      "fileVersion": 0,
121      "expirationTimeStamp": "2022-04-07T20:00:03.651Z",
122      "virusDetected": false,
123      "urlDetected": false,
124      "quarantine": false,
125      "version": 4
126    },
127    {
128      "creationTimeStamp": "2022-03-31T20:01:12.657Z",
129      "modifiedTimeStamp": "2022-03-31T20:01:12.941Z",
130      "createdBy": "sas.audit",
131      "modifiedBy": "sas.audit",
132      "id": "bed8ac75-2c21-4355-ab8a-0e595049c246",
133      "parentUri": "/jobExecution/jobs/2c08ebfd-bd82-4970-8cf0-cc9858f5dc6e",
134      "properties": {
135        "LastState": "running",
136        "JobRequest": "",
137        "Job": "2c08ebfd-bd82-4970-8cf0-cc9858f5dc6e",
138        "Provider": "casl"
139      },
140      "contentDisposition": "text/plain",
141      "contentType": "text/plain",
142      "description": "Log File for Job 2c08ebfd-bd82-4970-8cf0-cc9858f5dc6e",
143      "documentType": "log",
144      "encoding": "UTF-8",
145      "links": [
146        {
147          "method": "GET",
148          "rel": "self",
149          "href": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246",
150          "uri": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246",
151          "type": "application/vnd.sas.file"
152        },
153        {
154          "method": "GET",
155          "rel": "alternate",
156          "href": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246",
157          "uri": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246",
158          "type": "application/vnd.sas.summary"
159        },
160        {
161          "method": "PATCH",
162          "rel": "patch",
163          "href": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246",
164          "uri": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246",
165          "type": "application/vnd.sas.file",
166          "responseType": "application/vnd.sas.file"
167        },
168        {
169          "method": "PUT",
170          "rel": "update",
171          "href": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246",
172          "uri": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246",
173          "type": "application/vnd.sas.file",
174          "responseType": "application/vnd.sas.file"
175        },
176        {
177          "method": "DELETE",
178          "rel": "delete",
179          "href": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246",
180          "uri": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246"
181        },
182        {
183          "method": "GET",
184          "rel": "content",
185          "href": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246/content",
186          "uri": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246/content",
187          "type": "text/plain"
188        },
189        {
190          "method": "PUT",
191          "rel": "updateContent",
192          "href": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246/content",
193          "uri": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246/content",
194          "type": "*/*",
195          "responseType": "application/vnd.sas.file"
196        },
197        {
198          "method": "POST",
199          "rel": "copyFile",
200          "href": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246/copy",
201          "uri": "/files/files/bed8ac75-2c21-4355-ab8a-0e595049c246/copy",
202          "responseType": "application/vnd.sas.file"
203        },
204        {
205          "method": "POST",
206          "rel": "create",
207          "href": "/files/files",
208          "uri": "/files/files",
209          "type": "*/*",
210          "responseType": "application/vnd.sas.file"
211        }
212      ],
213      "name": "2022-03-31T20:01:12Z-results.log",
214      "size": 742,
215      "searchable": false,
216      "fileStatus": "unlocked",
217      "fileVersion": 0,
218      "expirationTimeStamp": "2022-04-07T20:01:12.678Z",
219      "virusDetected": false,
220      "urlDetected": false,
221      "quarantine": false,
222      "version": 4
223    }
224  ],
225  "limit": 2,
226  "version": 2
227}

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 applies 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	false	The file resource media type value. If this is not specified, the API returns the latest version.

Responses

Status	Meaning	Description
200	OK	The request succeeded. If files are found for the specified criteria, they are returned in a collection. If no files are found, an empty collection is returned.		Schema
404	Not Found	file not found.		Schema