Tutorial de utilização do

Kibana e Postman
Discover, Dev Tools e Postman
Utilizando o Kibana e Postman

Sumário
1. Introdução 3
2. Kibana 3
3. Acesso ao Kibana 3
4. Acesso às ferramentas de desenvolvimento 4
5. Pesquisando seus dados no console do Dev Tools 7
6. Tutorial Elastic 11
7. Acesso à API utilizando Postman 11
8. Tutorial Postman 22
9. Tipagem de dados 23
10. Versão do browser e do Postman 26

P á g i n a 2 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman
1. Introdução
O tutorial tem como objetivo fornecer orientações de uso da ferramenta Kibana para
consulta aos dados indexados de Tribunais, bem como, apoiar no consumo destes dados
através de API utilizando a ferramenta Postman.

2. Kibana
O Kibana é a interface de usuário para visualizar os dados do Elasticsearch e navegar
no Elastic Stack, além de possibilitar o monitoramento da carga de consultas até analisar como
as solicitações fluem pelas suas aplicações, tais como o Discover e o Dev Tools.

O Dev Tools permite o envio de solicitações para Elasticsearch e a visualização das

respostas, bem como a visualização da documentação da API.

O Discover permite explorar os dados de forma interativa, incluindo pesquisa e

filtragem.

3. Acesso ao Kibana
O acesso ao ambiente será feito pela URL [Link] onde será
exibida a tela para efetuar login de acesso restrito a pessoas autorizadas.

Figura 1: Acesso ao Elastic

Após o acesso pelo login e senha do usuário, será apresentada a tela para acesso ao
Kibana, conforme imagem abaixo.

P á g i n a 3 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman

Figura 2: Acesso ao Kibana com login e senha

O acesso ao Kibana é feito ao informar login e senha. A figura, abaixo, ilustra a tela
inicial de acesso, no qual deverá selecionar o space “API Tribunais”. A ferramenta permitirá
acesso ao tribunal do usuário logado.

Figura 3: Página inicial de acesso ao ambiente no space API Tribunais

4. Acesso às ferramentas de desenvolvimento

a. Analytics - Discover

A página inicial do Kibana exibe o menu , localizado no canto superior esquerdo da

tela inicial, logo abaixo do ícone da Elastic; quando selecionado permite visualizar e acessar as
opções de ferramentas de consulta Elastic, o Discover e o Dev Tools.

A ferramenta Discover está disponível no menu Analytics, conforme destacado na

imagem, abaixo.

P á g i n a 4 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman

Figura 4: Tela de seleção do Analytics - Discover

Ao selecionar o Discover, serão exibidas opções de criar (new), abrir (open),

compartilhar (share) e inspecionar (inspect) consultas, conforme destacado na imagem, abaixo.

Figura 5: Menu Analytics - Discover

No Discover também é possível fixar um filtro e ele permanecerá no lugar quando você
alterar alternar para visualizar. Observe que um filtro é baseado em um campo de índice
específico — se os índices que estão sendo pesquisados não contiverem o campo em um filtro
fixado, ele não terá efeito.

A figura, abaixo, apresenta a tela carregada com os dados indexados do tribunal do

usuário logado.

Por padrão, o Discover exibe a opção de realização de consulta utilizando Kibana

Query Language . O guia para utilização desta opção está disponível no link do fabricante
em [Link]

Figura 6: Discover - KQL

P á g i n a 5 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman
Outra opção de realização de consulta é a sintaxe do Lucene quando a opção de
utilização do Kibana Query Language for desabilitada, conforme imagem, abaixo.

Figura 7: Discover – Opção de selecionar Lucene

O resultado da seleção de consulta utilizando o Lucene está representado na imagem,

abaixo.

Figura 8: Discover – Lucene

O guia para utilização do Lucene está disponível no link do fabricante em

[Link]

Para maiores informações, o guia de utilização da ferramenta Discover está disponível

no link do fabricante em [Link]

b. Management – Dev Tools

Também, no menu, é possível acessar a ferramenta de consulta DevTools.

A ferramenta Dev Tools está disponível no menu Management, conforme destacada na

imagem, abaixo.

P á g i n a 6 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman

Figura 9: Seleção do Dev Tools

Ao selecionar o Dev Tools, a tela a seguir é exibida para execução de consultas

utilizando query DSL. No item 5, a seguir, estão listados exemplos de consultas que podem ser
executadas utilizando o console.

Figura 10: Console do Dev Tools

Para maiores informações, o guia de utilização da ferramenta Dev Tools está disponível
no link do fabricante em [Link]

5. Pesquisando seus dados no console do Dev Tools

Este item descreve as consultas elaboradas para auxiliar os Tribunais na busca de dados
na solução Elasticsearch.

a. Consultas básicas
GET view-processos-sigilo-*/_search
{
"query": {
"term": {
"dpj_classeProcessual": {
"value": "22"
}
}
P á g i n a 7 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman
}
}

Quantidade (Count)

GET view-processos-sigilo-*/_count
{
"query": {
"term": {
"dpj_classeProcessual": {
"value": "22"
}
}
}
}

Agregação (Group By)

GET view-processos-sigilo-*/_search
{
"size": 0,
"aggs": {
"classe": {
"terms": {
"field": "dpj_classeProcessual",
"size": 10
}
}
}
}

Início - Fim (From / Size)

GET view-processos-sigilo-*/_search
{
"from": 0,
"size": 20,
"query": {
"match": {
"dpj_classeProcessual": "1465"
}
}
}

b. Agregação por classe / com range de data de ajuizamento

Consulta por período da data de ajuizamento e classe

GET view-processos-sigilo-*/_search
{
"query": {
"bool": {
"must": [
{
"range": {
"dadosBasicos.dpj_dataAjuizamento": {
"gte": "2013-04-01",
"lte": "2013-04-30"
}
}

P á g i n a 8 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman
},
{
"term": {
"dpj_classeProcessual": {
"value": "22"
}
}
}
]
}
}
}

c. Consulta Nested com movimentos específicos e faltando determinado

movimento
GET view-processos-sigilo-*/_search
{
"query": {
"nested": {
"path": "movimento",
"query": {
"bool": {
"must": [
{
"terms": {
"movimento.dpj_codigoMovimentoNacional": ["493", "51", "123",
"60", "581"]
}
}
],
"must_not": [
{
"term": {
"movimento.dpj_codigoMovimentoNacional": {
"value": "22"
}
}
}
]
}
}
}
}
}

d. Agregação por órgão julgador / sem código de movimento específico

Agregação por órgão julgador sem movimento específico

GET view-processos-sigilo-*/_search
{
"size": 0,
"query": {
"bool": {
"must": [
{
"nested": {
"path": "movimento",
"query": {
P á g i n a 9 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman
"term": {
"movimento.dpj_codigoMovimentoNacional": {
"value": "22"
}
}
}
}
}
]
}
},
"aggs": {
"orgao_julgador": {
"terms": {
"field": "[Link]",
"size": 10
}
}
}
}

e. Exemplo com Wildcard em campos de texto (Nome da Classe e Nome

da Parte)
Utilização de Wildcard (Like)

GET view-processos-sigilo-*/_search
{
"query": {
"bool": {
"must": [
{
"wildcard": {
"dpj_nomeClasseProcessual.keyword": {
"value": "*Medidas Sócio*"
}
}
},
{
"nested": {
"path": "[Link]",
"query": {
"nested": {
"path": "[Link]",
"query": {
"wildcard": {
"[Link]": "Ezequiel Pereira*"
}
}
}
}
}
}
]
}
}
}

P á g i n a 10 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman
f. Partes tipoPessoa = "FISICA" e que não possuem
numeroDocumentoPrincipal
GET view-processos-sigilo-*/_search
{
"size": 2,
"query": {
"bool": {
"filter": [
{
"nested": {
"path": "[Link]",
"query": {
"bool": {
"must": [
{
"match": {
"[Link]": "FISICA"
}
}
],
"must_not": [
{
"exists": {
"field":
"[Link]"
}
}
]
}
}
}
}
]
}
}
}

6. Tutorial Elastic
Para maiores informações, o link para acesso ao tutorial de uso do Elasticsearch no site
do fabricante é [Link]

7. Acesso à API utilizando Postman

A sugestão de consumo da API é a utilização da ferramenta Postman, que é uma
plataforma que simplifica a etapa de consultas. Pode ser obtida para instalação no link do
fabricante disponível em [Link]

a. Tela de acesso
O acesso aos dados disponibilizados na API será feito pela URL
[Link]

A imagem abaixo apresenta o primeiro acesso no qual é possível efetuar login de

usuários já cadastrados ou criar um cadastro .

P á g i n a 11 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman

Figura 11: Tela inicial do Postman

Ao selecionar a opção de efetuar login com usuário já cadastrado é exibida a tela

a seguir.

Figura 12: Login via browser

O login via browser ocorre com a informação de usuário e senha em tela, conforme
exibido na imagem, abaixo, para autenticar a conta.

P á g i n a 12 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman

Figura 13: Informação de login e senha via browser

b. Exemplos de uso do Postman

Quando a conta do usuário é autenticada é apresenta a tela inicial do Postman.

Figura 14: Tela inicial de acesso ao Postman

Para acesso aos dados da API é necessário criar o workspace das coleções que
conterão as requisições a ser executadas na opção .

P á g i n a 13 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman

Figura 15: Opção de criar workspace

A selecionar a opção de criação do workspace, será apresentada a tela na qual o usuário

deverá informar o nome desejado, conforme a imagem, abaixo.

Figura 16: Nome do workspace

Após informar o nome desejado para o seu workspace e selecionar na tela anterior a
opção , a ferramenta estará pronta para ser utilizada.
Para começar a utilizar o seu workspace é necessário criar uma coleção, conforme
imagem destacada, abaixo.

P á g i n a 14 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman

Figura 17: Create collection do workspace

Após selecionar a opção de criação da coleção a tela, abaixo, é

apresentada para informação do nome, conforme destaque da imagem, a seguir.

Figura 18: Atribuição do nome da Collection

A coleção criada será exibida na ferramenta conforme a imagem destacada, abaixo.

P á g i n a 15 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman

Figura 19: Collection criada no workspace

A ferramenta disponibiliza a opção de “mais ações” para a coleção criada, na qual o

usuário deverá selecionar a adição de uma nova requisição.
A imagem, abaixo, apresenta a opção de selecionar “mais ações” oferecidas pela
ferramenta.

Figura 20: Seleção de mais ações da Collection criada no workspace

A imagem, abaixo, ilustra o item do menu da coleção a ser selecionado para adição de
requisição.

P á g i n a 16 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman

Figura 21: Adição de requisição na coleção

A seleção de nova requisição apresenta a tela, abaixo.

Figura 22: Nova requisição

A nova requisição deverá ser renomeada. Para renomear a requisição a ferramenta

disponibiliza a opção ao selecionar o menu destacado na imagem, abaixo.

P á g i n a 17 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman

Figura 23: Rename da requisição

A opção de renomear a requisição disponibiliza a tela da imagem com os destaques, a

seguir.

Figura 24: Exemplo de rename da requisição

Com a renomeação da requisição, a ferramenta estará pronta para receber o endpoint

de acesso aos dados indexados, conforme o exemplo destacado na imagem, abaixo.

P á g i n a 18 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman

Figura 25: Exemplo de endpoint

O acesso aos dados do endpoint requer autenticação de usuário com login e senha,
obtido através da seleção da opção “Authorization” e da seleção da opção de autorização básica,
“Basic Auth”, destacadas na imagem, abaixo.

Figura 26: Autorização de autenticação básica

Com a seleção da opção “Authorization” e da opção “Basic Auth”, descritas e destacadas

na imagem anterior, a tela a seguir é exibida e os campos para autenticação do usuário (login e
senha) são apresentados.

P á g i n a 19 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman

Figura 27: Autenticação de usuário

Efetuada a autenticação, a ferramenta disponibiliza a opção de ajustar o corpo da

requisição conforme a necessidade do usuário. A opção para ajuste do corpo da requisição está
destacada, abaixo.

Figura 28: Corpo da requisição

As opções sugeridas para ajuste do corpo da requisição são “Raw” e “Json” (dentro da
opção “Text”), conforme destaques feitos na imagem, abaixo.

P á g i n a 20 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman

Figura 29: Configuração do corpo da requisição

Feita a seleção desejada do corpo da requisição, as consultas disponibilizadas no item

5 (Pesquisando seus dados no console do Dev Tools) podem ser utilizadas. Na imagem, abaixo,
está destacada utilização de consultas.

O exemplo de consulta utilizado é o item 5.a. deste tutorial.

Figura 30: Exemplo de requisição de consultas

Após informar a consulta desejada e selecionar a opção de envio , o resultado

será exibido conforme destaque na imagem, abaixo.

P á g i n a 21 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman

Figura 31: Resultado da requisição

A ferramenta permite que as consultas efetuadas sejam salvas para uso posterior. A
opção de salvar uma consulta está destacada na imagem, abaixo.

Figura 32: Opção de salvar a requisição

8. Tutorial Postman
Para maiores orientações, o link para acesso ao tutorial de uso do Postman no site do
fabricante é [Link]

P á g i n a 22 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman
9. Tipagem de dados
Esse item descreve os campos com seus respectivos tipos de dados; esta informação
se faz necessária, pois entender o tipo do dado é de suma importância ao trabalhar com
consultas no Elasticsearch. Por exemplo, consultas com Wildcard trabalham com campos do tipo
Keyword, já filtros por range precisam trabalhar com dados do tipo numérico ou data.

A tabela, abaixo, contém os campos e os tipos de dados conforme indexados no

Elasticsearch.

Campo Tipo Mapping

dadosBasicos STRUCT object
[Link] STRUCT nested
[Link] STRUCT object
[Link] BIGINT long
[Link] INTEGER integer
[Link] VARCHAR keyword
[Link] BIGINT long
[Link].dpj_codigoAssuntoNacional BIGINT long
[Link].dpj_nomeAssuntoNacional VARCHAR text
[Link].dpj_nomeAssuntoNacional.keyword VARCHAR keyword
[Link] BOOLEAN boolean
[Link] BIGINT long
[Link] BIGINT long
[Link] VARCHAR keyword
[Link] BIGINT long
[Link] TIMESTAMP datetime
dadosBasicos.dpj_dataAjuizamento TIMESTAMP datetime
dadosBasicos.dpj_totalAssuntosInvalidos BIGINT long
[Link] INTEGER integer
[Link] VARCHAR keyword
[Link] BOOLEAN boolean
[Link] VARCHAR keyword
[Link] BIGINT long
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] STRUCT object
[Link] BIGINT long
[Link] VARCHAR keyword
[Link].dpj_codigoOrgaoNacional BIGINT long
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] STRUCT nested
[Link] STRUCT nested
[Link] STRUCT object
[Link] STRUCT object
[Link] VARCHAR keyword
[Link] VARCHAR keyword

P á g i n a 23 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] BOOLEAN boolean
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] BOOLEAN boolean
[Link] BIGINT long
[Link] STRUCT object
[Link] VARCHAR keyword
[Link] TIMESTAMP datetime
[Link] TIMESTAMP datetime
[Link] STRUCT object
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] STRUCT object
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] BIGINT long
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] BIGINT long
[Link] VARCHAR keyword
[Link] STRUCT object
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword

P á g i n a 24 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman
[Link] VARCHAR keyword
[Link] INTEGER integer
[Link] STRUCT object
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] VARCHAR keyword
[Link] BIGINT long
[Link] BIGINT long
[Link] INTEGER integer
[Link] REAL float
dataCriacaoArquivo TIMESTAMP datetime
dataProtocolo TIMESTAMP datetime
dpj_assuntosInvalidos BIGINT long
dpj_classeProcessual BIGINT long
dpj_classeProcessualValida BOOLEAN boolean
dpj_dataAjuizamento TIMESTAMP datetime
dpj_identificadorProcesso VARCHAR text
dpj_identificadorProcesso.keyword VARCHAR keyword
dpj_movimentosInvalidos BIGINT long
dpj_nomeClasseProcessual VARCHAR text
dpj_nomeClasseProcessual.keyword VARCHAR keyword
dpj_numero VARCHAR text
dpj_numero.keyword VARCHAR keyword
dpj_orgaoJulgadorValido BOOLEAN boolean
dpj_totalAssuntos BIGINT long
dpj_totalAssuntosInvalidos BIGINT long
dpj_totalDatasMovimentosInvalidas BIGINT long
dpj_totalMovimentos BIGINT long
dpj_totalMovimentosInvalidos BIGINT long
grau VARCHAR keyword
hash VARCHAR keyword
id VARCHAR text
[Link] VARCHAR keyword
idElastic VARCHAR text
[Link] VARCHAR keyword
millisInsercao BIGINT long
movimento STRUCT nested
[Link] STRUCT object
[Link] BIGINT long
[Link] BIGINT long
[Link] VARCHAR text
[Link] VARCHAR keyword
[Link] TIMESTAMP datetime
[Link] BOOLEAN boolean
movimento.dpj_DataHora TIMESTAMP datetime
movimento.dpj_codigoMovimentoNacional BIGINT long

P á g i n a 25 | 26
CNJ_Tutorial_Consulta_DSL_API
Utilizando o Kibana e Postman
movimento.dpj_nomeMovimentoNacional VARCHAR text
movimento.dpj_nomeMovimentoNacional.keyword VARCHAR keyword
[Link] VARCHAR keyword
[Link] STRUCT object
[Link] BIGINT long
[Link] INTEGER integer
[Link] VARCHAR keyword
[Link] STRUCT object
[Link] INTEGER integer
[Link] VARCHAR keyword
[Link] STRUCT object
[Link] INTEGER integer
[Link] VARCHAR keyword
[Link] BIGINT long
[Link] STRUCT object
[Link] .codigoMunicipioIBGE BIGINT long
[Link] .codigoOrgao VARCHAR keyword
[Link] .instancia VARCHAR keyword
[Link] .nomeOrgao VARCHAR keyword
[Link] VARCHAR keyword
[Link] INTEGER integer
movimentos STRUCT object
[Link] VARCHAR text
[Link] VARCHAR keyword
[Link] BOOLEAN boolean
movimentos.dpj_DataHora TIMESTAMP datetime
movimentos.dpj_codigoMovimentoNacional BIGINT long
movimentos.dpj_nomeMovimentoNacional VARCHAR text
movimentos.dpj_nomeMovimentoNacional.keyword VARCHAR keyword
[Link] STRUCT object
[Link] BIGINT long
[Link] BIGINT long
protocolo VARCHAR text
[Link] VARCHAR keyword
protocoloRN VARCHAR text
[Link] VARCHAR keyword
siglaTribunal VARCHAR keyword

Para mais detalhes a documentação oficial está disponível no link do fabricante em

[Link]

10. Versão do browser e do Postman

As versões de navegador e do Postman utilizados neste tutorial estão indicadas, abaixo:

• Chrome: Versão 91.0.4472.114 (Versão oficial) 64 bits

• Firefox: 89.0.2 (64 Bits)
• Postman: v8.8.0

P á g i n a 26 | 26
CNJ_Tutorial_Consulta_DSL_API