Create a Folder in an ObjectStore Using ID (REST API: POST)

This operation creates a new folder in the ObjectStore based on the GUID of the parent folder.

Request

Syntax
POST <webservice>/contentstore/file/{folderId} HTTP/1.1
 Host: <host name>
 Accept: application/xml
 Authtoken: <authentication token>
 Content-type: application/xml
 <App_FileResourceInfo 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 Parameters

Name

Description

Required

folderId

The GUID of the parent folder. GUID is a unique identifier for a file or folder and remains the same even when you rename or move the file or folder to another path.

To retrieve the GUID of the parent folder, see View ObjectStore File or Folder Properties.

Yes

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.

Content-type

The media type contained in the request body.

Request Body

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

Name

Description

Elements

name

The name of the new folder.

App_FileResourceInfo

Response

Response Parameters

Parameter

Description

Element

parentGuid

The GUID of the parent folder.

App_FileResourceResponse

GUID

The GUID of the new folder.

App_FileResourceResponse

directory

'directory=1' indicates the request item is a folder.

App_FileResourceResponse

path

The path to the new folder.

App_FileResourceResponse

name

Name of the new folder.

App_FileResourceResponse

Examples

Sample Request
POST <webservice>/contentstore/file/97409005317b4dbd9c138d2fd80a9e50 HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/xml
 <App_FileResourceInfo name="NewFolder"/>
Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <App_FileResourceResponse> <fileResource parentGuid="97409005317b4dbd9c138d2fd80a9e50" GUID="be7d714583584307bf00f1de47212b94" directory="1" name="NewFolder" path="\Folder1\NewFolder" /> </App_FileResourceResponse>

Supported Error Codes

Code

Status

Description

400

Bad Request

The request is missing required parameters or the folder name has some unacceptable characters.

404

Not Found

The specified parent folder does not exist.

409

Conflict

A folder with the specified name already exists in the same location.

The response body will include the information of the folder that already exists. For example:

<App_FileResourceResponse> <error errorCode="409" /> <fileResource parentGuid="97409005317b4dbd9c138d2fd80a9e50" GUID="be7d714583584307bf00f1de47212b94" directory="1" name="NewFolder" path="\Folder1\NewFolder" /> </App_FileResourceResponse>

Loading...