Rename a File or Folder in an ObjectStore Using Path (REST API: POST)

This operation renames a file or a folder in the ObjectStore based on the file or folder path.

Request

Syntax

POST <webservice>/contentstore/action/rename HTTP/1.1
 Host: <host name>
 Accept: application/xml
 Authtoken: <authentication token>
 Content-type: application/xml
 <App_FileResourceInfo path=”” name="" />

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name	Description
Host	The host name of the Web Server or Web Console used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Request Body

An XML element is required. See Syntax. The following table displays the parameters for the request body.

Name

Description

Elements

path

The complete path to the file or folder.

Specify the path relative from the root.

App_FileResourceInfo

name

The new name for the file or folder.

App_FileResourceInfo

Response

Response Parameters

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

0, successful completion.
a specific error code.

response

errorMessage

The description of the error code. Not all error codes have an error message.

response

Examples

Sample Request

POST <webservice>/contentstore/action/rename HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/xml
 <App_FileResourceInfo path=”\Test\plant.jpg” name="Flower.jpg" />

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <App_GenericResp errorCode="0"/>

Supported Error Codes

Code	Status	Description
400	Bad Request	The request is missing required parameters or the file/folder name has some unacceptable characters.
404	Not Found	The specified file or folder does not exist.
409	Conflict	A file or folder with the specified new name already exists in the specified location.