Descrição
Este serviço permite verificar se cada um dos datasets disponíveis pela Plataforma de Dados está habilitado ou não para para o usuário. A verificação de identidade do usuário é feita através do AccessToken, informado no cabeçalho ou corpo da requisição.
Parâmetros da Requisição
Os parâmetros dessa requisição não são obrigatórios. Eles são usados para filtrar o retorno dos dados, possibilitando obter uma consulta mais refinada. Caso nenhum parâmetro seja informado, serão retornados todos os datasets da plataforma, com a flag "IsEnabled" indicando se cada um deles está ou não habilitados para o usuário que realizou a chamada à API.
A tabela a seguir apresenta a descrição dos parâmetros que podem ser usados na chamada:
| Nome | Descrição |
|---|---|
| Api | Nome das APIs que devem ser usadas na busca pelos datasets |
| Datasets | Nome dos datasets específicos a serem retornados |
Exemplo de Requisição
Abaixo está um exemplo de requisição para a API de metadados:
{
"Api": "people",
"Datasets": "addresses_extended, basic_data, processes"
}
Exemplo de Resposta
Abaixo está um exemplo de resposta a uma requisição para a API de metadados:
{
"Datasets": {
"PT-BR": {
"People": [
{
"Name": "addresses_extended",
"Version": 1,
"CommonName": {
"pt-br": "Endereços - Estendido"
},
"IsEnabled": true
},
{
"Name": "basic_data",
"Version": 1,
"CommonName": {
"pt-br": "Dados Cadastrais Básicos"
},
"IsEnabled": true
},
{
"Name": "processes",
"Version": 1,
"CommonName": {
"pt-br": "Processos Judiciais e Administrativos"
},
"IsEnabled": true
}
]
}
},
"AnyDatasetsNotFound": false,
"DatasetsNotFound": [],
"AnyApisNotFound": false,
"ApisNotFound": [],
"QueryId": "***",
"ElapsedMilliseconds": 64716,
"QueryDate": "2023-05-17T13:02:19.5132416Z",
"Status": {
"metadata": [
{
"Code": 0,
"Message": "OK"
}
]
}
}