Descrição
A chamada de Obter Detalhes permite ao usuário recuperar informações detalhadas sobre todas as views as quais que ele tem acesso, ou algum subconjunto dessas views, a partir de filtros. Por definição, um usuário tem acesso a dois escopos diferentes de views: o escopo do seu domínio (o grupo de usuários associados com a sua empresa) e o escopo global, que inclui todas as views criadas pela BigData Corp. para simplificar o uso dos dados por clientes.
Todas as views 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 views 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 views por algumas de suas características. Os campos suportados estão listados abaixo:
Scope: Define o escopo das views que serão retornadas. Pode receber o valor global ou domain;
View: Define o nome da view sendo buscada no escopo selecionado. Caso seja informado, será retornada a view encontrada, ou nenhum resultado caso não exista view com o nome especificado;
Api: Define a API à qual as views sendo buscadas se referem. Pode receber o valor people ou companies;
Esses filtros permitem a identificação rápida de views para o seu gerenciamento ou utilização direta.
Exemplos
Como recuperar as views globais disponíveis:
POST https://dataplatform.bigdatacorp.com.br/views/obterDetalhes
Body:
{
"Scope": "global"
}
Como recuperar as views que utilizam o dataset de processos da API de pessoas:
POST https://dataplatform.bigdatacorp.com.br/views/obterDetalhes
Body:
{
"Scope": "global",
"Api": "people",
"Datasets": "processes"
}
Como recuperar uma view específica:
POST https://dataplatform.bigdatacorp.com.br/views/obterDetalhes
Body:
{
"View": "[nome da sua view]"
}