Documentation Center

DocumentObj 2.5 CheckIn

Checks in a particular version and language of an object in Content Manager. A user can only check in an object when the user first checked out the same 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
psVersionStringInThe version of the object. This version number has to be an exact number.
psLanguageStringInThe (working)language of the object
psResolutionStringInThe resolution of the object. Only used for illustrations, for other object types this parameter should be empty
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.
psEdtStringInThe unique identifier of the electronic document type
pbDataBlobInThe object content

Requirements are:

  • The user checked out the this object.
  • The user requires write access for the folder containing the object that will be checked in.
  • The user must be able to do a valid status transition on this object, otherwise it is considered read-only for this user.
Note that:
  • All logical identifiers within Content Manager are in uppercase.
  • The psXMLMetaData parameter is allowed to contain a valid available status transition for the object that is updated.
  • All plug-ins have to run successfully, to allow a check in of the object. This includes status transition checks like e.g. the submitted xml has to be valid according its DTD before it is allowed to enter the requested status.
  • For implementing the functionality 'check-in keep checked-out', it is recommended to use the update function.
  • 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.