Objective

It allows to return an XML file with information about who has locked or checked-out a specific document. This information is stored in the CHECKOUT table. DST must be provided.

Parameters

ParameterDescriptionType
libraryeDOCS libraryString
userUser nameString
passwordUser passwordString
docNumberDocument number. Only one document number is allowed.String
versionLabelIt can be an empty string or the number of the version or the subversion (1, 2, 2A, …)String
dbSchemaDatabase schema. By default is set to “DOCSADM” if an empty string is passed.String
clientOptional parameter for the client codeString
projectOptional parameter for the project codeString

Rest Invoke

  • http://localhost:port/GSService/xml/ or http://localhost:port/GSService/json/
  • UriTemplate:
    • “/CheckedOutOrLockedBy/?library={library}&user={user}&password={password}&docNumber={docNumber}&versionLabel={versionLabel}&dbSchema={dbSchema}&client={client}&project={project}”
    • “/CheckedOutOrLockedByDST/?library={library}&user={user}&dst={dst}&docNumber={docNumber}&versionLabel={versionLabel}&dbSchema={dbSchema}&client={client}&project={project}”

Example

http://localhost:8732/GSService/xml//CheckedOutOrLockedBy/?library=DMTESTLEGAL&user=admin&password=owc123&docNumber=22&versionLabel=1&dbSchema=DOCSADM

The method returns 0 if the delete operation is successful, or an error if the operation fails (errors are also included in the error log file).

DST Example

http://localhost:8732/GSService/xml/CheckedOutOrLockedByDST/?library=DMTESTLEGAL&user=admin&dst=afd448a5d0f9b...55355b8c677ad16&docNumber=22&versionLabel=1&dbSchema=DOCSADM

Error

The method returns an XML file with information about the user who has locked or checked-out the document.