Ver resultados de uma consulta da administração

Retorna os resultados de consultas cadastradas no módulo Administração. Somente consultas criadas pelo próprio usuário ou aquelas em que foi alocado como editor ou membro da audiência poderão ser acessadas.

 

URL

{RMUrl}/api/administration/queries/<Consulta>[?[page=<Página>][[&]page_size=<Tamanhodapágina>]]

 

MÉTODO DE SOLICITAÇÃO

GET

 

PARÂMETROS DA URL

Query: esse parâmetro é fornecido na URL e pode ser tanto o nome quanto o GUID da consulta. Consultas com caracteres especiais em seus nomes não podem ser executadas através da API.

page: número de páginas a serem exibidas. Valores válidos: de 1 ao número máximo de páginas. Se omitido, o valor 1 é utilizado. Se o valor for maior que o número máximo de páginas, uma lista em branco será retornada.

page_size: número de itens exibidos por página. Valores válidos: de 1 a 1.000. Se omitido, o valor padrão de 10 itens por página é utilizado.

 

EXEMPLOS DE SOLICITAÇÃO

Os primeiros 10 resultados da pesquisa "Perfis de Marketing":

{RMUrl}/api/administration/queries/Perfis de Marketing

{RMUrl}/api/administration/queries/9684e36e-560f-46ff-8677-56903914a117

 

Resultados do 21 ao 30 (terceira página, tamanho 10):

{RMUrl}/api/administration/queries/Perfis de Marketing?page=3&page_size=10

{RMUrl}/api/administration/queries/9684e36e-560f-46ff-8677-56903914a117?page=3&page_size=10

 

RESPOSTA DE SUCESSO

Retorna uma lista dinâmica de objetos de acordo com as colunas selecionadas quando a consulta é criada e seus respectivos valores.

 

EXEMPLO DE RESPOSTAS DE SUCESSO

[

{

"AuthorId":"a0c6aa09-00dc-11e6-80c7-00155d81062a","AuthorName":"Maria da Penha Doe","AuthorPhone":"+55 (21) 1234-1234","AuthorEmail":"maria.penha@abc.com","Id":"9684e36e-560f-46ff-8677-56903914a117","Name":"Perfis de Marketing","Description":"Esta consulta lista os perfis nos quais a equipe do Departamento de Marketing está incluída.","Type":"administration","UpdatedOn":"\/Date(1564433118010-0300)\/"},

{"AuthorId":"a0c6aa09-00dc-11e6-80c7-00155d81062a","AuthorName":"Maria da Penha","AuthorPhone":"+55 (21) 1234-1234","AuthorEmail":"maria.penha@abc.com","Id":"f00fb526-ac1a-4914-8b9d-604c95098d39","Name":"Papéis de Marketing","Description":"Esta consulta lista os papéis aos quais a equipe do Departamento de Marketing está alocada.","Type":"administration","UpdatedOn":"\/Date(1564431103343-0300)\/"

}

]