Descrição
A chamada de Obter Detalhes permite ao usuário recuperar informações detalhadas sobre todas as consultas personalizadas as quais que ele tem acesso, ou algum subconjunto dessas consulta personalizadas, a partir de filtros. Por definição, um usuário tem acesso a dois escopos diferentes de consulta personalizadas: o escopo do seu domínio (o grupo de usuários associados com a sua empresa) e o escopo global, que inclui todas as consulta personalizadas criadas pela BigData Corp. para simplificar o uso dos dados por clientes.
Todas as consulta personalizadas que residem no escopo do domínio são privadas, e apenas acessíveis aos usuários do próprio domínio.
Funcionamento
Caso não passe nenhum parâmetro no Body, serão retornadas todas as consulta personalizadas que o token tem permissão de uso e que estão no escopo do seu domínio, independente de qualquer outra característica. No entanto, a consulta permite também a utilização de outros parâmetros de busca, que viabilizam o filtro das consulta personalizadas por algumas de suas características. Os campos suportados estão listados abaixo:
Scope: Define o escopo das consulta personalizadas que serão retornadas. Pode receber o valor global ou domain;
View: Define o nome da consulta personalizada sendo buscada no escopo selecionado. Caso seja informado, será retornada a consulta personalizada encontrada, ou nenhum resultado caso não exista consulta personalizada com o nome especificado;
Api: Define a API à qual as consulta personalizadas sendo buscadas se referem. Pode receber o valor people ou companies;
Esses filtros permitem a identificação rápida de consulta personalizadas para o seu gerenciamento ou utilização direta.
Exemplos
Como recuperar as consulta personalizadas globais disponíveis:
POST https://plataforma.bigdatacorp.com.br/views/obterDetalhes
Body:
{
"Scope": "global"
}
Como recuperar as consulta personalizadas que utilizam o dataset de processos da API de pessoas:
POST https://plataforma.bigdatacorp.com.br/views/obterDetalhes
Body:
{
"Scope": "global",
"Api": "people",
"Datasets": "processes"
}
Como recuperar uma consulta personalizada específica:
POST https://plataforma.bigdatacorp.com.br/views/obterDetalhes
Body:
{
"View": "[nome da sua consulta personalizada]"
}