DocumentObj 2.5 Update
Updates a particular version and language of an Content Manager object. The function is typically used to adjust statuses and perform 'Check in' and 'Keep checked out' in one call, thereby updating the object in the repository.
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. |
| psLogicalId | String | In | The logical identifier of the object. |
| psVersion | String | InOut | The version of the object. When no exact version is given, the version number will be returned. |
| psLanguage | String | In | The language of the object. |
| psResolution | String | In | The resolution of the object. Only used for illustrations: this parameter should be empty for any other object types. |
| psXMLMetadata | String | In | Metadata XML structure with the metadata that will be set on the current object. |
| psXMLRequiredCurrentMetadata | String | In | Metadata 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. |
| psEdt | String | In | The unique identifier of the electronic document type. |
| pbData | Blob | In | The object content. |
Requirements are:
- The user must have write access for the folder in which the object is going to be updated.
- When
psXMLMetaDataspecifies a status transition for the object that is updated, this transition has to be compliant with the configured workflow. - When the state of the document requires any plug-ins to be ran successfully, the update will only succeed if the required plug-ins are also successful for the newly submitted object content.
- When the object is checked out by another user, the update is not allowed unless the current user is an administrator for the department that owns the object.
Note that:
- All logical identifiers within Content Manager are in uppercase.
- The parameter
psXMLRequiredCurrentMetaDatacan 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’.
- When the object is in a released status type, only administrators can update the object content.
- 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.