Copy a file or directory

post/sessions/{sessionId}/files/{destinationFileOrDirectoryPath}

Internal-Use Only

Copies a file or directory. Provide the path of the destination file or directory in the URI. Provide the path of the source file or directory in the request body. If you do not provide a path in the request body, then the current working directory is assumed.

Request Samples

application/vnd.sas.compute.file.request+json
1

Response Samples

201
application/json
1{
2  "isDirectory": false,
3  "modifiedTimeStamp": "2018-11-07T08:32:45Z",
4  "name": "hello.txt",
5  "path": "test",
6  "readOnly": false,
7  "size": 6,
8  "version": 1,
9  "links": [
10    {
11      "href": "/compute/sessions/RKEY-ses0000/files/test~fs~hello.txt",
12      "method": "GET",
13      "rel": "self",
14      "type": "application/vnd.sas.compute.file.properties",
15      "uri": "/compute/sessions/RKEY-ses0000/files/test~fs~hello.txt"
16    },
17    {
18      "href": "/compute/sessions/RKEY-ses0000/files/test~fs~hello.txt/content",
19      "method": "GET",
20      "rel": "getFile",
21      "type": "text/plain",
22      "uri": "/compute/sessions/RKEY-ses0000/files/test~fs~hello.txt/content"
23    },
24    {
25      "href": "/compute/sessions/RKEY-ses0000/files/test~fs~hello.txt",
26      "method": "DELETE",
27      "rel": "deleteFile",
28      "uri": "/compute/sessions/RKEY-ses0000/files/test~fs~hello.txt"
29    },
30    {
31      "href": "/compute/sessions/RKEY-ses0000/files/test~fs~hello.txt/content",
32      "method": "PUT",
33      "rel": "createFile",
34      "type": "text/plain",
35      "uri": "/compute/sessions/RKEY-ses0000/files/test~fs~hello.txt/content"
36    },
37    {
38      "href": "/compute/sessions/RKEY-ses0000/files/test~fs~hello.txt",
39      "method": "PUT",
40      "rel": "renameFile",
41      "responseType": "application/vnd.sas.compute.file.properties",
42      "type": "application/vnd.sas.compute.file.properties",
43      "uri": "/compute/sessions/RKEY-ses0000/files/test~fs~hello.txt"
44    },
45    {
46      "href": "/compute/sessions/RKEY-ses0000/files/{destinationFile}",
47      "method": "POST",
48      "rel": "copyFile",
49      "responseType": "application/vnd.sas.compute.file.properties",
50      "type": "application/vnd.sas.compute.file.request",
51      "uri": "/compute/sessions/RKEY-ses0000/files/{destinationFile}"
52    }
53  ]
54}

Path Parameters

Name	Type	Required	Description
destinationFileOrDirectoryPath	string	true	Specifies the destination file or directory path. In the path value, replace each forward slash with fs.
sessionId	string<object-id>	true	Specifies the ID of the session.

Query Parameters

Name	Type	Required	Description
expandPath	boolean	false	Specifies whether to return fully qualified paths in response links. Default: false
overwrite	boolean	false	Specifies whether to force an overwrite of an existing file or directory if one of the same name exists at the destination path. If you specify true, the request replaces the existing file or directory. Default: false

Request Body

Specifies the source file or directory name and path elements. The name element is required, and the path element is optional.

Provides properties of a file or directory object.

Name	Type	Required	Description
name	string	false	Specifies the name of the file or directory.
path	string	false	Specifies the path of the file or directory.

Responses

Status	Meaning	Description
201	Created	A file or directory was copied.	Headers	Schema
400	Bad Request	The path was invalid. The file or directory cannot be copied.		Schema
404	Not Found	No file or directory exists at the requested path. The file or directory cannot be copied.		Schema
409	Conflict	The request could not be completed. The destination file or directory already exists.	Headers	Schema
415	Unsupported Media Type	The requested version that was provided in the Accept Header is not supported.		Schema