Objective

It allows to retrieve the size (in bytes) of a specific document version or document subversion.

Parameters

ParameterDescriptionType
libraryeDOCS libraryString
userUser nameString
passwordUser passwordString
docNumberDocument number. Only one document number is allowed.Long
versionVersion number of the document. (1, 2, 3 …).Long
subVersionSubversion letter (A, B, C, …). No letter will be used by default.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:
    • “/GetDocumentSize/?library={library}&user={user}&password={password}&docNumber={docNumber}&version={version}&subVersion={subVersion}&dbSchema={dbSchema}&client={client}&project={project}”
    • “/GetDocumentSizeDST/?library={library}&user={user}&dst={dst}&docNumber={docNumber}&version={version}&subVersion={subVersion}&dbSchema={dbSchema}&client={client}&project={project}”

Example

http://localhost:8732/GSService/xml/GetDocumentSize/?library=DMTESTLEGAL&user=admin&password=owc123&docNumber=754&version=1&subVersion=&dbSchema=DOCSADM

The method returns the size of the document in bytes, or nil=”true” If the document cannot be found.

DST Example 

http://localhost:8732/GSService/xml/GetDocumentSizeDST/?form=LAWPROF/ library=DMTESTLEGAL&user=admin&dst=afd448a5d0f9b...55355b8c677ad16&docNumber=754&version=1&subVersion=&dbSchema=DOCSADM

Error

It returns the application name or an error. Check the event.log file if you find errors.