Documentation Center

DocumentObj 2.5 CheckOut

Checks out an object and locks it for other users.

Objects can only be checked out if:
  • The user has write access for the object.
  • No one else has checked out the object.
  • The object is not part of a released publication.

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.
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.
psXMLRequestedMetadataStringInRequested Metadata XML structure indicating which metadata has to be retrieved for a given object.
psOutXMLObjListStringOutObjectList XML structure containing both the object content (base 64 encoded) and the requested metadata.

Note that:
  • The user name of the user who checked out the object is stored in the metadata field CHECKED-OUT-BY .
  • If the object is already checked out by someone else, an exception will be thrown that contains the user name of the user that checked out the object.
  • All logical identifiers within Content Manager are in uppercase.
  • The parameter psLng is only used to retrieve the object in the desired language.
  • The result is no longer a byte stream with the requested object but an ObjectList containing both the object and its metadata. Like this metadata can also be returned for objects that are not XML and the returned metadata does not imply DTD modifications.
  • Although an object is checked out, metadata changes are on the object are still allowed.