holmes-search.md

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

holmes-upload-basic.md

API de upload

Envia um documento para o Holmes.

POST (multipart/form-data) /upload

Paramêtros

Campo	Descrição	Tipo
file	Arquivo a ser enviado	file
thumbPage	Página da miniatura	int

Exemplos

Request

Request URL: https://api.holmesdoc-homolog.com/upload
Request Method: POST
Request Content-type: multipart/form-data; boundary=----WebKitFormBoundaryCE9f11X2wObf3I8R
Request Payload:

------WebKitFormBoundaryCE9f11X2wObf3I8R
Content-Disposition: form-data; name="thumbPage"

0
------WebKitFormBoundaryCE9f11X2wObf3I8R
Content-Disposition: form-data; name="file"; filename="documento.pdf"
Content-Type: application/pdf


------WebKitFormBoundaryCE9f11X2wObf3I8R--

Response

{
  "_author": "amaral",
  "_document": 713,
  "_documentversionid": "715",
  "_docversion": 1,
  "_filelocation": "/2017/07/12/",
  "_lockedby": null,
  "_name": "documento.pdf",
  "_nature": null,
  "_pages": 1,
  "_publishedby": "amaral",
  "_removedBy": null,
  "_removedDate": null,
  "_sortBy": null,
  "_status": "CONVERTING",
  "_storageid": 1,
  "_type": "DOCUMENT",
  "_uploaddate": "20170712204154",
  "_workflowstatus": "approved",
  "thumbLink": "1/2017/07/12/715/3451ffa15b1aca9ff5ca86565154c092822f6e3a"
}

holmes-upload-classification.md

API de upload com classificação

Envia um documento para o Holmes e já faz sua classificação.

POST (multipart/form-data) /upload

Paramêtros

Campo	Descrição	Tipo
file	Arquivo a ser enviado	file
natureId	ID da natureza	int
thumbPage	Página da miniatura	int
convert	Se deve converter	boolean
notify	Se deve notificar	boolean
<ID da propriedade>	Este campo pode ser enviado várias vezes com ID da propriedade e valor diferentes	string

Exemplos

Request

Request URL: https://api.holmesdoc-homolog.com/upload
Request Method: POST
Request Content-type: multipart/form-data; boundary=----WebKitFormBoundaryjoEtK2mLLxkQxpsE
Request Payload:

------WebKitFormBoundaryjoEtK2mLLxkQxpsE
Content-Disposition: form-data; name="natureId"

21
------WebKitFormBoundaryjoEtK2mLLxkQxpsE
Content-Disposition: form-data; name="thumbPage"

0
------WebKitFormBoundaryjoEtK2mLLxkQxpsE
Content-Disposition: form-data; name="convert"

true
------WebKitFormBoundaryjoEtK2mLLxkQxpsE
Content-Disposition: form-data; name="notify"

true
------WebKitFormBoundaryjoEtK2mLLxkQxpsE
Content-Disposition: form-data; name="file"; filename="documento.pdf"
Content-Type: application/pdf


------WebKitFormBoundaryjoEtK2mLLxkQxpsE
Content-Disposition: form-data; name="5"

Loja 1
------WebKitFormBoundaryjoEtK2mLLxkQxpsE
Content-Disposition: form-data; name="19"

20170712
------WebKitFormBoundaryjoEtK2mLLxkQxpsE
Content-Disposition: form-data; name="34"

Rafael
------WebKitFormBoundaryjoEtK2mLLxkQxpsE
Content-Disposition: form-data; name="33"

BA
------WebKitFormBoundaryjoEtK2mLLxkQxpsE--

Response

{
  "_author": "amaral",
  "_document": 714,
  "_documentversionid": "716",
  "_docversion": 1,
  "_filelocation": "/2017/07/12/",
  "_lockedby": null,
  "_name": "documento.pdf",
  "_nature": null,
  "_pages": 1,
  "_publishedby": "amaral",
  "_removedBy": null,
  "_removedDate": null,
  "_sortBy": null,
  "_status": "CONVERTING",
  "_storageid": 1,
  "_type": "DOCUMENT",
  "_uploaddate": "20170712205256",
  "_workflowstatus": "approved",
  "thumbLink": "1/2017/07/12/716/e88db631362dbd6e3c6f9bc2696281f705be9b0f"
}