Objective

It allows to return information about one document but in this case, the document is divided into “chunks” of the specified size. It is useful for downloading large documents.

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
versionVersion number of the document. (1, 2, 3 …).Long
subVersionSubversion letter (A, B, C, …). No letter will be used by default.String
readBytesNumber of bytes already downloaded (i.e., the offset).String
firstTime

  • True –> When downloading the first part of the document.
  • False –> When downloading any other parts of the document.

String
sizePartThe size of the next part of the document.Long
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:
    • “/ShowMultipartDocument/?library={library}&user={user}&password={password}&form={form}&docNumber={docNumber}&version={version}&subVersion={subVersion}&readBytes={readBytes}&firstTime={firstTime}&sizepart={sizepart}&client={client}&project={project}”
    • “/ShowMultipartDocumentDST/?library={library}&user={user}&dst={dst}&form={form}&docNumber={docNumber}&version={version}&subVersion={subVersion}&readBytes={readBytes}&firstTime={firstTime}&sizepart={sizepart}&client={client}&project={project}”

Example

http://localhost:8732/GSService/xml/ShowMultipartDocument/?library=DMTESTLEGAL&user=admin&password=owc123&form=LAWPROF&docNumber=310&version=1&subVersion=!&readBytes=1024&firstTime=true&sizepart=1024

If all parameters are correct the method returns a XML file with the following information.

DST Example

http://localhost:8732/GSService/xml/ShowMultipartDocumentDST/?library=DMTESTLEGAL&user=admin&dst=afd448a5d0f9b...55355b8c677ad16&form=LAWPROF&docNumber=310&version=1&subVersion=!&readBytes=1024&firstTime=true&sizepart=1024

Error

If there are mistakes in the parameters then detailed errors can be found in the error log. See Appendix D for more information about the edocs.log file