Skip to main content
Version: 2.2.2

viewDocumentData

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

Java class
Requestweb/wwwroot/ws/java/document/ViewDocumentDataRequestType.java
Returnweb/wwwroot/ws/java/document/ViewDocumentDataResponseType.java

Request:

ID #RequiredDescription
IDDOCUMENTXDocument ID #.
IDREVISIONRevision ID #.
IDUSERStarting with version 2.0, this parameter became obsolete. During the import, leave it blank.
IDCATEGORYDocument category ID #.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:document">
<soapenv:Header/>
<soapenv:Body>
<urn:viewDocumentData>
<!--You may enter the following 4 items in any order-->
<urn:iddocument>?</urn:iddocument>
<urn:idrevision>?</urn:idrevision>
<urn:iduser>?</urn:iduser>
<urn:idcategory>?</urn:idcategory>
</urn:viewDocumentData>
</soapenv:Body>
</soapenv:Envelope>

Return:

ID #Description
returnSUCCESS: 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.
â–ª NMAUTHOR: String; Document author name.
â–ª 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; Document view API URL.
â–ª LINKSHARE: Document sharing link.
â–ª ATTRIBUTTES: Matrix; Document attributes:
• ATTRIBUTTENAME: String; Attribute ID#.
• ATTRIBUTTEVALUE: vector; Attribute values.
â–ª ELECTRONICFILE: Matrix; Electronic file
• FILENAME: String; File name
FAILURE: 0: Message with the error found.