Navigation:  Integration via SOAP web services > Published web services > Document >

viewDocumentData

Previous  Top  Next

This method enables to recover the data of a document. To use it, it is necessary to follow the standard documented below:

 

Java class

Request

web/wwwroot/ws/java/document/ViewDocumentDataRequestType.java

Return

web/wwwroot/ws/java/document/ViewDocumentDataResponseType.java

 

Request

ID #

Required

Description

IDDOCUMENT

X

Document ID #.

IDREVISION

 

Revision ID #.

IDUSER

 

Starting with version 2.0, this parameter became obsolete. During the import, leave it blank.

IDCATEGORY

 

Document category ID #.

 

Return

ID #

Description

return

SUCCESS: returns a vector with the metadata:

IDDOCUMENT: String; Document ID #.

NMTITLE: String; Document title.

IDCATEGORY: String; Category ID #.

NMCATEGORY: String; Category name.

STATUS: String; Document status; 1: Issue; 2: Released; 3: Revision; 4: Cancelled; 5: Indexing, 6: Approval, 7: Closed contract.

NRHITS: Integer; Hits.

NMAUTHOR: String; Name of document author.

IDREVISION: String; Revision ID #.

DTDOCUMENT: String; Document date.

QTVALIDITY: Integer; Validity.

FGMEASVALID: String; Validity type: 1: Days 2: Months 3: Years.

REVALIDATION: String; Revalidation.

DTVALIDITY: String; Validity date.

RESUME: String; Document summary.

CANCELREASON: String; Cancellation description.

URL: String; URL for the document view API.

LINKSHARE: Document sharing link.

ATTRIBUTTES: Matrix; Document attributes:

oATTRIBUTTENAME: String; Attribute ID#.

oATTRIBUTTEVALUE: vector; Attribute values.

ELECTRONICFILE: Matrix; Electronic file

oFILENAME: String; File name

FAILURE: 0: Message with error.