Documentation Center

Folder 2.5 CreateQueryFolder

Creates a query folder in the Content Manager repository. The content of the query folder is generated dynamically based on the provided metadata criteria. It is not possible to create objects in the query folder.


Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated 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.
plParentFolderRefLongInIdentifier of the parent folder.
psFolderNameStringInName for the new folder
psOwnedByStringInName of the user group or department that will be the owner of the folder that is created. When an empty string is provided all users of all user groups or departments have write access to document components stored inside the folder.
pasReadAccessStringArrayInString 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.
psXMLQueryStringInFolder Query XML structure containing the metadata query to find the content of the folder.
plOutNewFolderRefLongOutIdentifier of the folder that has been created

Requirements are:
  • The user must have write access in the parent folder.
Some typical scenarios are:
  • When a folder with the same name already exists as subfolder of the given parent folder, you receive an error (FolderAlreadyExists ,-160).
  • When the user is not a member of the owner's usergroup of the given parent folder, you receive an error (ObjectNotPartOfUserGroup, -117).
  • When the user has no read access on the usergroup of the created folder, you receive an error.
  • When the read access of the to be created folder violates the read access of the parent folder, you receive an error (SecurityRuleViolatedInParentFolder, -225).
  • When the peQuery parameter is empty or contains invalid xml, you receive an error (QueryFolderWithoutQuery, -161).
  • When the owner is not part of the read access setting, you receive an error (SecurityRuleViolatedOnOwnerAccess, -264).
Note that:
  • Only users that have read access to the folder can execute the metadata query, but the read access on the folder has no effect on the content of the folder. The content of the folder is generated dynamically with a combination of the metadata query and the security settings of the user.
  • The Folder Query XML can only contain filters using logical level metadata!