Documentation Center

Folder 2.5 GetMetaData

This function returns the properties of the 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.
peBaseFoldereBaseFolderInIndicates the root folder to use as starting point for folder actions
pasFolderPathStringArrayInString array with the label of the parent folders (except the base folder) and the requested folder (e.g. "MobilePhones","330","Modules").
psXMLRequestedMetaDataStringInRequested Metadata XML structure indicating which metadata has to be retrieved for a given object.
psOutXMLFolderListStringOutThe Folder Metadata XML structure containing the metadata of the folder

Requirements are:

  • The user must have read access for the object.

Note that:

  • When the paFolderPath parameter is empty, the metadata of the base folder is returned.