logo

Antes de começar

O tutorial abaixo demonstra como utilizar a API de download do Holmes. Caso você nunca tenha feito integrações com o holmes recomendamos os seguintes passos:

  1. Veja o vídeo Holmes API
  2. Entenda o mecanismo de autenticação 

API de busca

Realiza uma consulta de documentos dentro do Holmes.

GET /search

Paramêtros (query string)

Campo Descrição Tipo
query Consulta string
start Posição do primeiro registro int
rows Total de registros int
sortBy Campo de ordenação string
order Tipo da ordenação enum (ASC ou DESC)

Exemplos

Request

Procurar documentos que foram classificados com a natureza “Ponto” e que contenham as tags “joao” e “ferias”. Query: +_nature:"Ponto" +_tag:"joao" +_tag:"ferias"

https://api.holmesdoc-homolog.com/search?query=+%2B_nature%3A%22Ponto%22++++%2B_tag%3A%22joao%22+%2B_tag%3A%22ferias%22+++&start=0&rows=54&sortBy=_uploaddate&order=DESC

Response

{
  "response": {
    "start": 0,
    "numFound": 1,
    "docs": [
      {
        "_uploaddate": "20180118191928",
        "_storageid": 249,
        "thumbLink": "249/2018/01/18/29246176/c11b24a2a01d681dc7c7a58759845386c11c1b6f",
        "_pages": 1,
        "_name": "arquivo.pdf",
        "_publishedby": "user.redspark",
        "_nature": "Ponto",
        "_document": 28555135,
        "_type": "DOCUMENT",
        "_docversion": 1,
        "_workflowstatus": "approved",
        "_documentversionid": "29246176",
        "_filelocation": "/2018/01/18/",
        "_status": "READY",
        "_author": "user.redspark",
        "_lockedby": null,
        "_removedBy": null,
        "_removedDate": null,
        "_sortBy": "18/01/2018 19:19:28"
      }
    ]
  },
  "responseHeader": {
    "QTime": 0,
    "status": 0
  }
}
0 acharam interessante