Conjunto de dados

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).

Listar os registros do conjunto de dados

GET /apigateway/v1/dataset-integration/{your_id_dataset}

Exemplo de solicitação:

Atributos suportados:

Path Parameter	Tipo	Requerido	Descrição
your_id_dataset	String	Sim	Identificador do conjunto de dados a ser consumido

curl -X GET 'https://my-domain.softexpert.com/apigateway/v1/dataset-integration/users' \
-H 'Authorization: <your_api_token>'

Exemplo de resposta:

200 OK

[
  {
    "nmdepartment": "Administrative",
    "nmuser": "Kevin Turey",
    "idlogin": "Kevint",
    "isactive": "active",
    "nmposition": "Chief Executive Officer",
    "isenabled": "non-blocked"
  },
  {
    "nmdepartment": "Manufacture",
    "nmuser": "Manuel Coronado",
    "idlogin": "coronado",
    "isactive": "active",
    "nmposition": "Coordinator",
    "isenabled": "non-blocked"
  },
  {
    "nmdepartment": "Purchase",
    "nmuser": "Patricia Cooperstone",
    "idlogin": "PurCoo",
    "isactive": "active",
    "nmposition": "Coordinator",
    "isenabled": "non-blocked"
  },
  {
    "nmdepartment": "Administrative",
    "nmuser": "Philip Smith",
    "idlogin": "marlon",
    "isactive": "active",
    "nmposition": "Manager",
    "isenabled": "non-blocked"
  },
  {
    "nmdepartment": "Production",
    "nmuser": "Suzan Thompson",
    "idlogin": "st",
    "isactive": "active",
    "nmposition": "Service Desk",
    "isenabled": "non-blocked"
  }
]

cuidado

• 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, esta será serializada em forma de um objeto JSON no retorno da API. Serão retornados apenas os primeiros 10.000 (dez mil) registros como objetos.

Obter um registro do conjunto de dados

POST /apigateway/v1/dataset-integration/{your_id_dataset}

Exemplo de solicitação:

Atributos suportados:

Path Parameter	Tipo	Requerido	Descrição
your_id_dataset	String	Sim	Identificador do conjunto de dados a ser consumido

curl -X POST 'https://my-domain.softexpert.com/apigateway/v1/dataset-integration/users' \
-H 'Content-Type: application/json' \
-H 'Authorization: <your_api_token>' \
-d '{
    "id_login": "coronado"
}'

Exemplo de resposta:

200 OK

[
  {
    "nmdepartment": "Manufacture",
    "nmuser": "Manuel Coronado",
    "idlogin": "coronado",
    "isactive": "active",
    "nmposition": "Coordinator",
    "isenabled": "non-blocked"
  }
]

Outras informações

Retorno em caso de erro

Identificador	Descrição
message	Mensagem explicativa do problema ocorrido
status	Código HTTP do retorno

HTTP Status

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 SoftExpert Suite está sobrecarregado no uso de memória da JVM