Ver detalhes de uma consulta da administração

Retorna informações sobre uma consulta do módulo Administração. Somente as 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>/metadata

MÉTODO DE SOLICITAÇÃO

GET

PARÂMETRO 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.

EXEMPLO DE SOLICITAÇÃO

{RMUrl}/api/administration/queries/Membros da Audiencia de Consultas da Organizacao/metadata

{RMUrl}/api/administration/queries/cc45b704-b3d5-11e0-8b69-001ec91f4b0a/metadata

RESPOSTA DE SUCESSO

Retorna uma QueryMetadata no seguinte formato:

QueryMetadata

{

Guid AuthorId;

string AuthorName;

string AuthorPhone;

string AuthorEmail;

Guid Id;

string Name;

ColumnMetadata[] Columns;

}

O campo "Columns" tem o seguinte formato:

{

string Name;

string SmallCaption;

string Caption;

int? Order;

bool IsGroup;

bool IsCustomAttribute;

ColumnType? Type;

ColumnSortOrder SortOrder;

}

O campo "ColumnType" pode ter os seguintes valores: Text, Number, Link, Real, Date e DateTime.

O campo "ColumnSortOrder" pode ter os seguintes valores: None, Ascending e Descending.

EXEMPLO DE RESPOSTA DE SUCESSO

{"AuthorId":"a0c6aa09-00dc-11e6-80c7-00155d81062a","AuthorName":"Maria da Penha","AuthorPhone":"+55 (21) 1234-1234","AuthorEmail":"maria.penha@abc.com","Id":"4e4d9434-0da6-4bbd-b5cd-28abb8fd25c5","Name":"Gestores do Workflow ","Columns":[{"Name":"Name","SmallCaption":"Nome","Caption":"Nome","Order":0,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"Email","SmallCaption":"Email","Caption":"E-mail","Order":1,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},

{"Name":"Description","SmallCaption":"Descrição","Caption":"Descrição","Order":2,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"UserName","SmallCaption":"Login","Caption":"Login","Order":3,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},

{"Name":"LastLogon","SmallCaption":"Último Login","Caption":"Último Login","Order":4,"IsGroup":false,"IsCustomAttribute":false,"Type":"DateTime","SortOrder":"None"},{"Name":"Profiles","SmallCaption":"Perfis","Caption":"Perfis","Order":5,"IsGroup":false,"IsCustomAttribute":false,"Type":"Link","SortOrder":"None"}],"UpdatedOn":"\/Date(-62135596800000)\/"}