Navigation:  Integração via web services SOAP > Web services publicados > Documento >

searchDocument

Previous  Top  Next

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

 

Classe Java

Requisição

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

Retorno

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

 

Requisição

Identificador

Requerido

Descrição

FILTERS

X

Array 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; Identificador 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;

IDUSER

 

A partir da 2.0 este parâmetro tornou-se obsoleto. Na importação, deixe-o em branco.

ATTRIBUTES

 

Array 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).

 

Retorno

Identificador

Descrição

return

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