Get directory members

get/sessions/{sessionId}/files/{directoryPath}/members
Internal-Use Only

Returns a collection of directory members from a specified directory path.

Request Samples

1

Response Samples

1{
2  "accept": "application/vnd.sas.compute.file.properties",
3  "count": 2,
4  "items": [
5    {
6      "isDirectory": false,
7      "links": [
8        {
9          "href": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~hello.txt",
10          "method": "GET",
11          "rel": "self",
12          "type": "application/vnd.sas.compute.file.properties",
13          "uri": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~hello.txt"
14        },
15        {
16          "href": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~hello.txt",
17          "method": "GET",
18          "rel": "getFileProperties",
19          "type": "application/vnd.sas.compute.file.properties",
20          "uri": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~hello.txt"
21        },
22        {
23          "href": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~hello.txt/content",
24          "method": "GET",
25          "rel": "getFile",
26          "type": "text/plain",
27          "uri": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~hello.txt/content"
28        },
29        {
30          "href": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~hello.txt",
31          "method": "DELETE",
32          "rel": "deleteFile",
33          "uri": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~hello.txt"
34        },
35        {
36          "href": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~hello.txt/content",
37          "method": "PUT",
38          "rel": "createFile",
39          "type": "text/plain",
40          "uri": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~hello.txt/content"
41        },
42        {
43          "href": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~hello.txt",
44          "method": "PUT",
45          "rel": "renameFile",
46          "responseType": "application/vnd.sas.compute.file.properties",
47          "type": "application/vnd.sas.compute.file.properties",
48          "uri": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~hello.txt"
49        },
50        {
51          "href": "/compute/sessions/RKEY-ses0000/files/{destinationFile}",
52          "method": "POST",
53          "rel": "copyFile",
54          "responseType": "application/vnd.sas.compute.file.properties",
55          "type": "application/vnd.sas.compute.file.request",
56          "uri": "/compute/sessions/RKEY-ses0000/files/{destinationFile}"
57        }
58      ],
59      "modifiedTimeStamp": "2019-01-02T12:01:57Z",
60      "name": "hello.txt",
61      "path": "/u/test/mydir",
62      "readOnly": true,
63      "size": 0,
64      "version": 1
65    },
66    {
67      "isDirectory": true,
68      "links": [
69        {
70          "href": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~dir1",
71          "method": "GET",
72          "rel": "self",
73          "type": "application/vnd.sas.compute.file.properties",
74          "uri": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~dir1"
75        },
76        {
77          "href": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~dir1",
78          "method": "GET",
79          "rel": "getDirectoryProperties",
80          "type": "application/vnd.sas.compute.file.properties",
81          "uri": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~dir1"
82        },
83        {
84          "href": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~dir1",
85          "method": "DELETE",
86          "rel": "deleteDirectory",
87          "uri": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~dir1"
88        },
89        {
90          "href": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~dir1",
91          "method": "PUT",
92          "rel": "renameDirectory",
93          "responseType": "application/vnd.sas.compute.file.properties",
94          "type": "application/vnd.sas.compute.file.properties",
95          "uri": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~dir1"
96        },
97        {
98          "href": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~dir1",
99          "method": "POST",
100          "rel": "makeDirectory",
101          "responseType": "application/vnd.sas.compute.file.properties",
102          "type": "application/vnd.sas.compute.file.properties",
103          "uri": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~dir1"
104        },
105        {
106          "href": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~dir1",
107          "method": "POST",
108          "rel": "createFile",
109          "responseType": "application/vnd.sas.compute.file.properties",
110          "type": "application/vnd.sas.compute.file.properties",
111          "uri": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~dir1"
112        },
113        {
114          "href": "/compute/sessions/RKEY-ses0000/files/{destinationDirectory}",
115          "method": "POST",
116          "rel": "copyDirectory",
117          "responseType": "application/vnd.sas.compute.file.properties",
118          "type": "application/vnd.sas.compute.file.request",
119          "uri": "/compute/sessions/RKEY-ses0000/files/{destinationDirectory}"
120        },
121        {
122          "href": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~dir1/members",
123          "itemType": "application/vnd.sas.compute.file.properties",
124          "method": "GET",
125          "rel": "getDirectoryMembers",
126          "type": "application/vnd.sas.collection",
127          "uri": "/compute/sessions/RKEY-ses0000/files/~fs~u~fs~test~fs~mydir~fs~dir1/members"
128        }
129      ],
130      "modifiedTimeStamp": "2019-01-02T12:01:57Z",
131      "name": "dir1.txt",
132      "path": "/u/test/mydir",
133      "readOnly": false,
134      "size": 0,
135      "version": 1
136    }
137  ],
138  "limit": 50,
139  "links": [
140    {
141      "href": "/compute/sessions/RKEY-ses0000/files?limit=50&start=0",
142      "itemType": "application/vnd.sas.compute.file.properties",
143      "method": "GET",
144      "rel": "self",
145      "type": "application/vnd.sas.collection",
146      "uri": "/compute/sessions/RKEY-ses0000/files?limit=50&start=0"
147    },
148    {
149      "href": "/compute/sessions/RKEY-ses0000/files",
150      "itemType": "application/vnd.sas.compute.file.properties",
151      "method": "GET",
152      "rel": "collection",
153      "type": "application/vnd.sas.collection",
154      "uri": "/compute/sessions/RKEY-ses0000/files"
155    }
156  ],
157  "name": "Directory listing",
158  "start": 0,
159  "version": 2
160}

Path Parameters

NameTypeRequiredDescription
directoryPath
string
true

Specifies the directory path. In the directory path, replace each forward slash with fs.

sessionId
string<object-id>
true

Specifies the ID of the session.

Query Parameters

NameTypeRequiredDescription
expandPath
boolean
false

Specifies whether to return fully qualified paths in response links.

Default:
false
showAll
boolean
false

Specifies whether to return hidden members in the directory.

Default:
false
limit
integer
false

Specifies the maximum number of members to return. The default value is 10.

sortBy
string<sort-criteria>
false

Sets the sort order for the returned collection of members.

start
integer
false

Specifies the offset of the first directory member to return. The default value is 0.

Responses

StatusMeaningDescription
200OKThe request succeeded.HeadersSchema
404Not FoundNo resource exists at the requested path.Schema