Returns the results of a query in the Administration module. Queries are accessible only to their authors, editors, and audience members.
URL
{RMUrl}/api/administration/queries/<Query>[?[page=<Page>][[&]page_size=<PageSize>]]
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.
page: Number of the page to be displayed. Valid values: 1 to the maximum number of pages. If omitted, the value 1 is used. If the value is greater than the maximum number of pages, a blank list will be returned.
page_size: Number of items displayed per page. Valid values: 1 to 1,000. If omitted, the default value of 10 is used.
REQUEST EXAMPLES
The first ten results of the "Marketing Profiles" query:
{RMUrl}/api/administration/queries/Marketing Profiles
{RMUrl}/api/administration/queries/9684e36e-560f-46ff-8677-56903914a117
Results 21 through 30 (third page, size 10):
{RMUrl}/api/administration/queries/Marketing Profiles?page=3&page_size=10
{RMUrl}/api/administration/queries/9684e36e-560f-46ff-8677-56903914a117?page=3&page_size=10
SUCCESS RESPONSE
Returns a dynamic list of objects, according to the columns selected when creating the query and their respective values.
SUCCESS RESPONSE EXAMPLE
[
{
"AuthorId":"a0c6aa09-00dc-11e6-80c7-00155d81062a","AuthorName":"Jane Doe","AuthorPhone":"+55 (21) 1234-1234","AuthorEmail":"jane.doe@abc.com","Id":"9684e36e-560f-46ff-8677-56903914a117","Name":"Marketing Profiles","Description":"This query lists the profiles in which the Marketing Department staff is included.","Type":"administration","UpdatedOn":"\/Date(1564433118010-0300)\/"},
{"AuthorId":"a0c6aa09-00dc-11e6-80c7-00155d81062a","AuthorName":"Jane Doe","AuthorPhone":"+55 (21) 1234-1234","AuthorEmail":"jane.doe@abc.com","Id":"f00fb526-ac1a-4914-8b9d-604c95098d39","Name":"Marketing Roles","Description":"This query lists the roles to which the Marketing Department staff is assigned.","Type":"administration","UpdatedOn":"\/Date(1564431103343-0300)\/"
}
]