Objective
It allows to retrieve the size (in bytes) of a specific document version or document subversion.
Parameters
Parameter | Description | Type |
library | eDOCS library | String |
user | User name | String |
password | User password | String |
docNumber | Document number. Only one document number is allowed. | Long |
version | Version number of the document. (1, 2, 3 …). | Long |
subVersion | Subversion letter (A, B, C, …). No letter will be used by default. | String |
dbSchema | Database schema. By default is set to “DOCSADM” if an empty string is passed. | String |
client | Optional parameter for the client code | String |
project | Optional parameter for the project code | String |
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.