View Administration Query Details

Returns information on a query in the Administration module. Each user can only access the queries of which they are author, editor or audience member.

URL

{RMUrl}/api/administration/queries/<Query>/metadata

REQUEST METHOD

GET

URL PARAMETERS

Query: This parameter is provided in the URL and can be either the query name or the query GUID. Queries with special characters in their names cannot be run through the API.

REQUEST EXAMPLE

{RMUrl}/api/administration/queries/Organizational Query Audience Members/metadata

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

SUCCESS RESPONSE

Returns a QueryMetadata in the following format:

QueryMetadata

{

Guid AuthorId;

string AuthorName;

string AuthorPhone;

string AuthorEmail;

Guid Id;

string Name;

ColumnMetadata[] Columns;

}

The "Columns" field has the following format:

{

string Name;

string SmallCaption;

string Caption;

int? Order;

bool IsGroup;

bool IsCustomAttribute;

ColumnType? Type;

ColumnSortOrder SortOrder;

}

The "ColumnType" field may have the following values: Text, Number, Link, Date, DateTime and Time.

The "ColumnSortOrder" field may have the following values: None, Ascending, Descending.

SUCCESS RESPONSE EXAMPLE

{"AuthorId":"a0c6aa09-00dc-11e6-80c7-00155d81062a","AuthorName":"Jane Doe","AuthorPhone":"+55 (21) 1234-1234","AuthorEmail":"jane.doe@abc.com","Id":"4e4d9434-0da6-4bbd-b5cd-28abb8fd25c5","Name":"Event Coordinator Profile","Columns":[{"Name":"Name","SmallCaption":"Name","Caption":"Name","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":"Description","Caption":"Description","Order":2,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"UserName","SmallCaption":"UserName","Caption":"Login","Order":3,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"LastLogon","SmallCaption":"LastLogon","Caption":"Last Logon","Order":4,"IsGroup":false,"IsCustomAttribute":false,"Type":"DateTime","SortOrder":"None"},{"Name":"Profiles","SmallCaption":"Profiles","Caption":"Profiles","Order":5,"IsGroup":false,"IsCustomAttribute":false,"Type":"Link","SortOrder":"None"}],"UpdatedOn":"\/Date(-62135596800000)\/"}