Skip to main content
Version: Next

searchDocument

This method allows searching for documents. To use it, it is necessary to follow the standard documented below:

Java class
Requestweb/wwwroot/ws/java/document/SearchDocumentRequestType.java
Returnweb/wwwroot/ws/java/document/SearchDocumentResponseType.java

Request:

ID #RequiredDescription
FILTERSXSearch filters array:
â–ª IDCATEGORY: String; Category ID #;
â–ª IDDOCUMENT: String; Document ID #;
â–ª NMTITLE: String; Document title;
â–ª NMAUTHOR: String; Document author;
â–ª CONTENT: String; Content;
â–ª SYNONYM: String; Search for synonym;
â–ª STATUS: String; Document status. Ex.: 1,2,3,4; 1: Issue; 2: Released; 3: Revision; 4: Cancelled;
â–ª PERMISSION: String; Document permissions. Ex.: 1,2,3,4,5; 1: Add; 2: Edit; 3: Delete; 4: Revise; 5: Knowledge; 6: Distribute copy; 7: View; 8: Cancel; 9: Archive; 10: Print; 11: Training; 12: Create training; 13: Save locally; 14: Sign; 15: Notification;
â–ª IDUSERPERM: String; Permission user ID;
â–ª DEPARTMENTPERM: String; Permission department ID #;
â–ª IDUSERREGISTER: String; Record user ID;
â–ª FUNCTIONPERM: String; Permission position ID;
â–ª KEYWORD: String; Keyword;
â–ª OPKEYWORD: Integer; Keyword operator; 1: AND; 2: OR;
â–ª DTDOCLASTDAY: String; Number of days referring to the document date (last days);
â–ª DTDOCBEGIN: String; Start date for document period;
â–ª DTDOCEND: String; End date for document period;
â–ª DTREGLASTDAY: String; Number of days referring to the document creation date (last days);
â–ª DTREGBEGIN: String; Start date for document creation date period;
â–ª DTREGEND: String; End date for document creation date period;
â–ª DTVALIDBEGIN: String; Start date for validity date filter;
â–ª DTVALIDEND: String; End date for validity date filter;
â–ª DTREVLASTDAY: String; Number of days referring to the document revision date (last days);
â–ª DTREVBEGIN: String; Start date for document revision period;
â–ª DTREVEND: String; End date for document revision period;
â–ª IDPROJECT: String; Project ID #;
â–ª NMPROJECT: String; Project name;
IDUSERStarting with version 2.0, this parameter became obsolete. During the import, leave it blank.
ATTRIBUTESAttributes array:
â–ª IDATTRIBUTE: Attribute ID#;
â–ª VLATTRIBUTE: Attribute value.
Note: For attributes with a numeric value, the decimal place separator must be "." (dot).
Note: For date fields, the value must have the Y-M-D (Year-Month-Day) format.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:document">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:searchDocument>
         <!--You may enter the following 3 items in any order-->
         <urn:filters>
            <!--You may enter the following 27 items in any order-->
            <urn:IDCATEGORY>?</urn:IDCATEGORY>
            <urn:IDDOCUMENT>?</urn:IDDOCUMENT>
            <urn:NMTITLE>?</urn:NMTITLE>
            <urn:NMAUTHOR>?</urn:NMAUTHOR>
            <urn:CONTENT>?</urn:CONTENT>
            <urn:SYNONYM>?</urn:SYNONYM>
            <urn:STATUS>?</urn:STATUS>
            <urn:PERMISSION>?</urn:PERMISSION>
            <urn:IDUSERPERM>?</urn:IDUSERPERM>
            <urn:DEPARTMENTPERM>?</urn:DEPARTMENTPERM>
            <urn:IDUSERREGISTER>?</urn:IDUSERREGISTER>
            <urn:FUNCTIONPERM>?</urn:FUNCTIONPERM>
            <urn:KEYWORD>?</urn:KEYWORD>
            <urn:OPKEYWORD>?</urn:OPKEYWORD>
            <urn:DTDOCLASTDAY>?</urn:DTDOCLASTDAY>
            <urn:DTDOCBEGIN>?</urn:DTDOCBEGIN>
            <urn:DTDOCEND>?</urn:DTDOCEND>
            <urn:DTREGLASTDAY>?</urn:DTREGLASTDAY>
            <urn:DTREGBEGIN>?</urn:DTREGBEGIN>
            <urn:DTREGEND>?</urn:DTREGEND>
            <urn:DTVALIDBEGIN>?</urn:DTVALIDBEGIN>
            <urn:DTVALIDEND>?</urn:DTVALIDEND>
            <urn:DTREVLASTDAY>?</urn:DTREVLASTDAY>
            <urn:DTREVBEGIN>?</urn:DTREVBEGIN>
            <urn:DTREVEND>?</urn:DTREVEND>
            <urn:IDPROJECT>?</urn:IDPROJECT>
            <urn:NMPROJECT>?</urn:NMPROJECT>
         </urn:filters>
         <urn:iduser>?</urn:iduser>
         <urn:attributes>
            <!--0 to 1000 repetitions:-->
            <urn:item>
               <!--You may enter the following 2 items in any order-->
               <urn:IDATTRIBUTE>?</urn:IDATTRIBUTE>
               <urn:VLATTRIBUTE>?</urn:VLATTRIBUTE>
            </urn:item>
         </urn:attributes>
      </urn:searchDocument>
   </soapenv:Body>
</soapenv:Envelope>

Return:

ID #Description
returnSUCCESS: Matrix with search result:
â–ª IDDOCUMENT: String; Document ID #.
â–ª NMTITLE: String; Document title.
â–ª IDREVISION: String; ID # of the current revision of the document.
â–ª DTDOCUMENT: String; Date of the current revision of the document.
â–ª IDCATEGORY: String; Document category ID #.
â–ª NMCATEGORY: String; Document category name.
â–ª NMFILE: String; Name of the electronic file associated with the document. In case of multiple files, the number of files will be returned concatenated with a ".multifile" text.
â–ª ADHESION: As of 2.0, this parameter has become obsolete. In the import, leave it blank.
FAILURE: Returns a message regarding the error that occurred.
Last updated on