Folder 2.5 UpdateReferenceFolder
Modifies the folder name and read access.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| psAuthContext | String | InOut | Deprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services making this parameter redundant. |
| plFolderRef | Long | In | Identifier of the folder |
| psNewFolderName | String | In | New name of the folder |
| pasReadAccess | StringArray | In | String array with the user groups that have read access to this folder. When the string array is empty, all users have read access to the folder. |
Requirements are:
- The user must have write access to the folder.
Some typical scenarios are:
- When the user is not a member of the owner's usergroup of the folder, you receive an error (
ObjectNotPartOfUserGroup, -117). - When the user has no read access on the usergroup of the modified folder, you receive an error.
- When the read access of the to be modified folder violates the read access of the parent folder, you receive an error (
SecurityRuleViolatedInParentFolder, -225). - When the read access of the to be modified folder violates the read access of one of the subfolders, you receive an error (
SecurityRuleViolatedInSubFolders, -224). - When the owner is not part of the read access setting, you receive an error (
SecurityRuleViolatedOnOwnerAccess, -264).
Note that:
- When the
psNewFolderNameparameter is empty, the name of the folder is not updated. - When the
paReadAccessparameter is an empty string array, the read access of the folder is updated to give all users read access. - Use the Rename function, if you only want to rename the folder. The
updatefunction will always change the read access of the folder as well.