searchDocument

Java class

Request

web/wwwroot/ws/java/document/SearchDocumentRequestType.java

Return

web/wwwroot/ws/java/document/SearchDocumentResponseType.java

Request

ID #

Required

Description

FILTERS

X

Search 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; ID # of permission user;

▪DEPARTMENTPERM: String; Permission of department ID #;

▪IDUSERREGISTER: String; Record user ID;

▪FUNCTIONPERM: String; Permission of position ID #;

▪KEYWORD: String; Keyword;

▪OPKEYWORD: Integer; Operator of key word; 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; Deadline 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; Deadline for document creation date period;

▪DTVALIDBEGIN: String; Start date for validity date search field;

▪DTVALIDEND: String; End date for validity date search field;

▪DTREVLASTDAY: String; Number of days referring to the document revision date (last days);

▪DTREVBEGIN: String; Start date for document revision period;

▪DTREVEND: String; Deadline for document revision period;

▪IDPROJECT: String; Project ID #;

▪NMPROJECT: String; Project name;

IDUSER

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

ATTRIBUTES

Attributes array:

▪IDATTRIBUTE: Attribute ID#;

▪VLATTRIBUTE: Attribute value.

Note: For attributes with a numeric value, the decimal place separator must be '.'.

Note: For date fields, the value must have the Y-M-D (Year-Month-Day) format.

Return

ID #

Description

return

SUCCESS: 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.

▪ADHESION: Starting from version 2.0, this parameter became obsolete. During the import, leave it blank.

FAILURE: returns a message with the error that occurred.