Documentation Center

DocumentObj 2.5 SetMetaData

Sets the metadata for the specified object.


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.
psLogicalIdStringInThe logical identifier of the object.
psVersionStringInOutThe version of the object. When no exact version is given, the version number will be returned.
psLanguageStringInThe language of the object.
psResolutionStringInThe resolution of the object. Only used for illustrations: this parameter should be empty for any other object types.
psXMLMetadataStringInMetadata XML structure with the metadata that will be set on the current object.
psXMLRequiredCurrentMetadataStringInMetadata XML structure with the metadata that object is required to have set currently. The update of the object is only carried out when the object has exactly the same metadata specification, i.e. the metadata was not changed by someone else.

Requirements are:
  • The user must have write access for the folder in which the object is going to be updated.
  • When psXMLMetaData specifies a status transition for the object that is updated, this transition has to be compliant with the configured workflow.
Note that:
  • All logical identifiers within Content Manager are in uppercase.
  • The parameter psXMLRequiredCurrentMetaData can be used to require that the update only is carried out when the object is still in the same state as the users thinks it is.
  • When the updating user currently has checked out the object, the update is allowed. So this function can also be used as an intermediate ‘check in – keep checked out’.
  • The (working) language of the object is only used to find the correct language object. If you want to update the language, use the field 'DOC-LANGUAGE' in psXMLMetaData.