Objective

It allows to delete one document (the content, profile and all versions) from the library. The user should have the appropriate rights to perform the delete operation. It could be used to delete folders as well but the folders must be empty and have no relations with other objects (subfolders or documents). DST must be provided.

Parameters

ParameterDescriptionType
libraryeDOCS libraryString
userUser nameString
passwordUser passwordString
formThe name of the form used to create new folders.String
docNumberDocument number. Only one document number is allowed.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:
    • “/DeleteDocument/?library={library}&user={user}&password={password}&form={form}&docNumber={docNumber}&client={client}&project={project}”
    • “/DeleteDocumentDST/?library={library}&user={user}&password={password}&form={form}&docNumber={docNumber}&client={client}&project={project}”

Example

http://localhost:8732/GSService/xml/DeleteDocument/?library=DMTESTLEGAL&user=admin&password=owc123&form=LAWPROF&docNumber=746

DST Example

http://localhost:8732/GSService/xml/DeleteDocumentDST/library=DMTESTLEGAL&user=admin&dst=afd448a5d0f9b8...77ad16b7540fe6f&form=LAWPROF&docNumber=740

The method returns 0 if the delete operation is successful or -1 if the operation fail.

Error

As this method only returns an integer, detailed errors can be found in the error log. See Appendix D for more information about the edocs.log file.