TopoPesquisar
Ao pesquisar, o usuário poderá informar critérios de filtro para listar apenas os registros desejados. Normalmente depois de informar os filtros desejados, o usuário deverá executar a operação [b:Listar].
Obtenha maiores detalhes em
Como utilizar a tela de pesquisa?.
TopoListar
Apresenta uma lista com os registros que atendem aos filtros informados.
A lista possui diversos recursos práticos e importantes para o usuário:
- Clique no link apresentado na primeira coluna para acessar um registro específico. Você também pode usar as teclas (seta para baixo) e (seta para cima) para navegar entre os registros apresentados para acessá-lo.
- Normalmente, o cursor fica ativo no link do primeiro registro, ou no registro que estava sendo acessado no caso do usuário voltar para a lista após acessar um registro específico.
- É possível reordenar a lista clicando no título da coluna desejada. Clicar no título de uma coluna que já está sendo ordenada, inverte o sentido da ordenação (ascendente/descendente). Clicar no link juntamente com a tecla SHIFT, acrescenta a coluna à ordenação já imposta, permitindo ordenar primeiro por uma coluna e segundo por outra.
- Ao clicar no ícone de agrupamento, a lista é refeita apresentando todas as informações totalizáveis dos registros agrupados pela respectiva coluna.
- No canto superior direito da tabela com a lista, existe um ícone que, ao ser clicado, abre um pequeno menu que permite o usuário configurar a tabela.
- No menu de configuração da tabela, o usuário pode escolher quais colunas devem ser apresentadas e em que posição.
- No menu de configuração da tabela, o usuário pode gerar uma pivot da mesma.
- Antes da lista, são apresentados os filtros aplicados. Cada filtro possui um pequeno "x" que pode ser utilizado para exclui-lo. Ao fazer isso, a lista é automaticamente atualizada.
TopoConsultar
Autenticação
A API utiliza autenticação Bearer. Solicite o token de acesso ao administrador do sistema e inclua o seguinte header no cabeçalho de todas as requisições. Exemplo:
Authorization: Bearer 033CC53E52AB68451304CB751BC9D476D25789AC
Respostas
Todos os métodos executados com sucesso irão retornar status 200.
| Status | Descrição |
|
|---|
| 200 | Método executado com sucesso |
|
| 400 | Serviço (objeto) inválido |
|
| 401 | Falha na autorização (token inválido) |
|
| 404 | Registro não encontrado |
|
| 500 | Erro interno (não esperado) |
|
Erros, quando ocorrerem serão acompanhados de uma mensagem JSON contendo a descrição do erro:
Exemplo:
{
"error": "Usuário inválido!"
}
Métodos
Os seguintes métodos são suportados.
GET objeto/?query
Consulta uma lista de registros. Caso informado, a lista é obedece aos filtros informados. O retorno é formado por um array de objetos JSON.
O filtro deverá ser informado com os parâmetros documentados para o objeto específico.
Além de poder filtrar por um valor específico, também é possível filtrar por alguns operadores conforme a tabela abaixo. Os operadores são informados entre colchetes junto ao nome do campo a ser filtrado e quando o operador exigir mais do que um valor, então os valores deverão ser separados por ";".
| Operador | Descrição | Exemplo |
|
|---|
| between | Filtra registros cujo campo esteja em uma faixa | data[between]=2018-01-01;2018-12-31 |
|
| contains | Filtra registros que possuam determinadas palavras no campo | descricao[contains]=roda;pneu |
|
| not-equals | Filtra registros cujo campo tenha um valor diferente | situacao[not-equals]=CANCELADO |
|
| in | Campo tem um dos valores informados | estabelecimento[in]=MATRIZ;FILIAL |
|
| not-in | Campo não é um dos valores informados | situacao[not-in]=P;E;X |
|
| is-null | Campo deve estar nulo | data_emissao[is-null] |
|
| is-not-null | Campo deve estar nulo | data_emissao[is-not-null] |
|
GET objeto/${id}
Retorna as informações de um objeto/registro específico (id). O resultado é um objeto JSON.
DELETE objeto/${id}
Exclui o registro informado.
POST objeto
Cria um novo registro. O registro é formado com um objeto JSON contendo os atributos documentados para o respectivo objeto. O resultado é um objeto JSON contendo todos os atributos do objeto, incluindo seu ID e outros atributos calculados ou inferidos pelas regras de negócio instituídas para o mesmo.
PUT objeto/${id}
Altera um registro específico. A requisição deve enviar um objeto JSON contendo os atributos atualizados do registro.
Comportamento: