Update folder
Update folder
OVERVIEW
This API method updates the details of an existing folder.
Request
PUT /api/1/folders/{folderid}
Parameters
|
Parameter Name |
Value |
Description |
|---|---|---|
|
folderid |
Int |
The ID for the folder in question |
Request body
<folder>
<name>Demofolder</name>
<description>This is the description for Demofolder</description>
<dmsfolderid>{string value}</dmsfolderid>
<dmsdatabasename>{string value}</dmsdatabasename>
<dmsParentFolderID>{string value}</dmsParentFolderID>
<dmslink>true/false</dmslink>
<dmslinkby>{email address}</dmslinkby>
</dms>
</folder>
The dms tag is optional, the dms details are only updated when the tag is present in request. Please see the Add folder method for explanation of the dms parameters
|
Parameter Name |
Value |
Description |
|---|---|---|
|
name |
string |
Name of folder, which is to be updated in the system |
|
description |
string |
Description for the document to be updated |
|
accessInherited |
int |
Possible values are 0 and 1. Value of 1 means that the access permissions are inherited for this folder from the root folder otherwise not. |
Response
If successful this method returns a 200 OK response.
Example request:
PUT http://clientinstance.highq.com/clientinstance/api/1/folders/1234
XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<folder>
<name>Folder1</name>
<description>This is discption for Demofolder</description>
<accessInherited>1</accessInherited>
</folder>
JSON:
{
"name": "Folder2Json",
"description": "This is discption for Demofolder",
"accessInherited": "1"
}
Although the page mentions accessInherited, I just learned that you cannot use the Update folder REST call to enable or disable inheritance on the folder.
So, apparently, there is no way to change the inheritance setting on an existing folder use REST calls. :(
HighQ: please add that.
Imran Aziz are there any plans on reimplementing this feature (accessInherited) in near future? Right now some of our automation workflows are affected by this. Product Management Team
Joe Leung CC Imran Aziz (who is our product manager for the API)
Jason Pallay Are there plans to support it? We're trying to create some automation around it and if we can't adjust the accessInherited flag, that basically blocks us.
Joe Leung - I've spoken with our development team and we do not support this option. It has been removed in the most recent updated version of the documentation which is on Swagger.
Joe Leung please raise a ticket via support@highq.com and one of the team can investigate this for you... include the uri , all the headers and the body of your request aswell as the response code that the system returns to you. thanks!
When I try to set "accessInherited": "0" - it doesn't seem to work... Also tried "accessInherited": 0 and still no dice. Has anyone else run into this issue?
I found a problem, when i update a folder to change the dms tag dmsfolderid to a new value then i could not reset this value later.
1. change dmsfolderid to "ABCDEFG" - work
2. change dmsfolderid to "GFEDCBA" - work
3. change dmsfolderid back to "ABCDEFG"- does not work, dmsfolderid is "GFEDCBA"
are there any restrictions for dmsfolderid value?
Thank you
Your review has been submitted.
Comments
8 Comments