Pular para o conteúdo principal
Versão: 2.2.1

searchDocument

Este método possibilita realizar a consulta de documentos. Para utilizá-lo, é necessário seguir o padrão abaixo documentado.

Classe Java
Requisiçãoweb/wwwroot/ws/java/document/SearchDocumentRequestType.java
Retornoweb/wwwroot/ws/java/document/SearchDocumentResponseType.java

Requisição:

IdentificadorRequeridoDescrição
FILTERSXArray de filtros para consulta:
IDCATEGORY: String; Identificador da categoria;
IDDOCUMENT: String; Identificador do documento;
NMTITLE: String; Título do documento;
NMAUTHOR: String; Autor do documento;
CONTENT: String; Conteúdo;
SYNONYM: String; Procurar por sinônimo;
STATUS: String; Situação do documento. Ex.: 1,2,3,4; 1: Emissão; 2: Homologado; 3: Revisão; 4: Cancelado;
PERMISSION: String; Permissões do documento. Ex.: 1,2,3,4,5; 1: Incluir; 2: Alterar; 3: Excluir; 4: Revisar; 5: Conhecimento; 6: Distribuir cópia; 7: Visualizar; 8: Cancelar; 9: Arquivar; 10: Imprimir; 11: Treinamento; 12: Registrar treinamento; 13: Salvar localmente; 14: Assinar; 15: Notificação;
IDUSERPERM: String; Matrícula do usuário da permissão;
DEPARTMENTPERM: String; Identificador da área da permissão;
IDUSERREGISTER: String; Matrícula do usuário de cadastro;
FUNCTIONPERM: String; Identificador da função da permissão;
KEYWORD: String; Palavra-chave;
OPKEYWORD: Integer; Operador da palavra-chave; 1: E; 2: OU;
DTDOCLASTDAY: String; Número de dias referente data do documento(últimos dias);
DTDOCBEGIN: String; Data de início para período do documento;
DTDOCEND: String; Data final para período do documento;
DTREGLASTDAY: String; Número de dias referente data de cadastro do documento (últimos dias);
DTREGBEGIN: String; Data de início para período de data de cadastro do documento;
DTREGEND: String; Data final para período de data de cadastro do documento;
DTVALIDBEGIN: String; Data de início para filtro por data de validade;
DTVALIDEND: String; Data final para filtro por data de validade;
DTREVLASTDAY: String; Número de dias referente data da revisão do documento(últimos dias);
DTREVBEGIN: String; Data de início para período da revisão do documento;
DTREVEND: String; Data final para período da revisão do documento;
IDPROJECT: String; Identificador do projeto;
NMPROJECT: String; Nome do projeto;
IDUSERA partir da 2.0 este parâmetro tornou-se obsoleto. Na importação, deixe-o em branco.
ATTRIBUTESArray de atributos:
IDATTRIBUTE: Identificador do atributo;
VLATTRIBUTE: Valor do atributo.
Obs.: Para atributos com valor numérico, o separador de casas decimais deve ser o '.'.
Obs.: Para campos de data, o valor deve ter o formato Y-M-D (Ano-Mês-Dia).

Estrutura da requisição:

<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>

Retorno:

IdentificadorDescrição
returnSUCESSO: Matriz com resultados da pesquisa:
IDDOCUMENT: String; Identificador do documento.
NMTITLE: String; Título do documento.
IDREVISION: String; Identificador da revisão vigente do documento.
DTDOCUMENT: String; Data da revisão vigente do documento.
ADHESION: A partir da 2.0 este parâmetro tornou-se obsoleto. Na importação, deixe-o em branco.
FALHA: retorna uma mensagem com o erro ocorrido.