Documentation Center

DocumentObj 2.5 SetMetadataByIshLngRefs

Updates the metadata of the specified language objects.

Every language object is updated one-by-one.
  • If the update succeed, the update is submitted to the database.
  • If the update fails, the exception with some extra information about the object is returned in the psOutXMLErrorReport parameter.

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.
palLngRefsLongArrayInLong list with the unique identifiers of the language objects.
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.
psOutXMLErrorReportStringOutError Report XML structure containing the exception per object.

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:
  • 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’.
  • If you want to update the language, use the field 'DOC-LANGUAGE' in psXMLMetaData.