Add folder

This API supports creation of a new folder given the folderid. A site’s root folderid can be obtained by using the “site list” API endpoint.

Request

POST       /api/1/folders?parentfolderid={parentfolderid}

Query Parameters

Request body

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<folder>

         <name>Demofolder</name>

         <description>This is a description for Demofolder</description>

         <accessInherited>1</accessInherited>

        {optional DMS settings}

         <dms>
              <dmsfolderid></dmsfolderid>
              <dmscreateddate></dmscreateddate>
              <dmsmodifiedBy></dmsmodifiedBy>
              <dmsdatabasename></dmsdatabasename>
              <dmsParentFolderID></dmsParentFolderID>                               
         </dms>

</folder>

Additional fields available to register DMS details for an folder created from a DMS system. These parameter are used to store information about an external DMS solution like worksite. So that the information required for a two way sync can be managed. 

Form Parameters
 

Response

If successful this method returns the details of folder resource in the response body.

<folder>

     <id>3619</id>

     <link>https://domain.com/api/1/folders/3619</link>

</folder>

Example request:

POST  http://clientinstance.highq.com/clientinstance/api/1/folders/1234

XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 

<folder>
          <id>131</id>
          <link>https://collaborate.highq.com/sitepoint/api/1/folders/131</link>
</folder>
 

JSON:

{
   "name": null,
   "description": null,
   "parentFolderID": null,
   "accessInherited": null,
   "batchID": null,
   "dms": null,
   "id": 61,
   "link": "https://domain.com/api/1/folders/61",
   "createddate": null,
   "modifieddate": null,
   "permission": null,
   "child": null,
   "createdby": null,
   "modifiedby": null
}

Error Response

In case of an error an error object in returned in the response body.

XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<error>              
<link> https://ankitjava.local.com/ankit_3_3_0/api/1/error/2125 </link>              
<ref>41</ref>               
<summary>                 
    Can not create new folder inside deleted folder 'Folder2Json'     
</summary>         
</error>

JSON:
1)

{

"summary": "Can not create new folder inside deleted folder - 'Folder2Json' ",

"ref": "41",

"link": "https://ankitjava.local.com/ankit_3_3_0/api/1/error/2124"

}
2)

{     

"summary": "Access denied",     

"ref": "130",     "link": null

}