|
A API do conjunto de dados possibilita consumir o retorno de queries criadas dentro de conjuntos cadastrados no sistema. Esses conjuntos precisam utilizar a fonte de dados padrão do sistema (SESUITE).
Parâmetros de entrada
|
Identificador
|
Tipo
|
Descrição
|
identificador
|
PATH
|
Identificador do conjunto de dados a ser consumido
|
Parâmetros do conjunto
|
BODY
|
Parâmetros adicionados no conjunto de dados. É necessário enviar todos os parâmetros cadastrados no conjunto de dados para que a requisição aconteça com sucesso.
|
Corpo da requisição (Exemplo)
|
{
"idParam1": 1234,
"idParam2": "value"
}
|
Exemplo do JSON de retorno (em caso de sucesso)
|
[
{
"cduser": 1,
"idlogin": "string",
"nmuser": "string"
},
{
"cduser": 2,
"idlogin": "string",
"nmuser": "string"
},
{
"cduser": 3,
"idlogin": "string",
"nmuser": "string"
}
]
|
▪A estrutura de campos do retorno varia de acordo com aqueles retornados pela query e mapeados no conjunto de dados. O retorno acima é apenas um exemplo simples com a tabela de usuários do sistema. Campos que retornam valores nulos retornarão “” (vazio) no lugar.
▪Para cada linha retornada pela query, a mesma será serializada em forma de um objeto JSON no retorno da API. Serão retornados apenas os primeiros 10000 registros como objetos.
|
Retorno (em caso de erro)
|
Identificador
|
Descrição
|
message
|
Mensagem explicativa do problema ocorrido
|
status
|
Código HTTP do retorno
|
Códigos mapeados
|
Código HTTP
|
Descrição
|
200 (OK)
|
Ocorre quando o recurso consegue consumir o conjunto de dados com sucesso e trazer seus resultados
|
400 (Bad request)
|
Ocorre quando é informado um conjunto de dados inválido ou com características não suportadas pelo recurso
|
404 (Not found)
|
Ocorre quando é informado um identificador inválido de conjunto de dados, ou quando aquele usuário não possui permissão de visualização/edição
|
500 (Internal server error)
|
Ocorre quando um erro não esperado é retornado pelo recurso, ou em caso de timeout na execução da query
|
503 (Service unavailable)
|
Ocorre quando o serviço do sesuite está sobrecarregado no uso de memória da JVM
|
|
