List Queries

Returns a list of all the queries to which the user has access.

 

URL

{RMUrl}/api/queries[?[[&]$filter=<filter>][[&]$orderby=<field1[desc],field2[desc]…fieldN[desc]>]]

 

REQUEST METHOD

GET

 

URL PARAMETERS

filter: Query based on the OData protocol syntax for configuring filters. The fields supported are listed below. See the examples to view the operations allowed.

orderby: Orders the business components listed on the page by field. To order by more than one field, use a comma between the field names. For descending order, add the word "desc" for each desired field. The supported fields are listed below.

 

FIELDS SUPPORTED BY FILTER

string Name;

string Description;

Guid Id;

string Type;

DateTime? UpdatedOn;

 

For detailed information on filters as supported operators, which filters apply to which data types, and more examples, see Appendix 3: Filters.

 

REQUEST EXAMPLES

List all queries:

{RMUrl}/api/queries

 

Filter by queries that have "Windows" in the "Name" field:

{RMUrl}/api/queries?$filter=substringof('Windows',Name)

 

SUCCESS RESPONSE

List organizational queries according to the filters and page size specified.

OrganizationQuery[].

 

The OrganizationQuery object is in the following format:

OrganizationQuery

{

string Name;

string Description;

Guid Id;

string Type;

DateTime? UpdatedOn;

object Links;

}

 

SUCCESS RESPONSE EXAMPLE

[

{

"Name":"Query to Assets"

"Description":"Query to the organization's assets.",

"Id":"29e5b79d-4b54-11e1-b4b4-0800270094a6",

"Type":"Organizational Information - Assets",

"UpdatedOn":"\/Date(1321621109510-0200)\/" ,

"Links":[{

"Uri":"https://riskamanager.modulo.com/RM/api/organization/queries/5c67ef1c-3b68-4034-b83b-aeb26d6e2527",

"Rel":"run",

"Name":"Run"

}]

},

{

"Name":"Custom Query"

"Description":"Custom Query",

"Id":"3a5e728d-4b54-11e1-b4b4-0800270094a6",

"Type":"Status of Controls",

"UpdatedOn":"\/Date(1321621109510-0200)\/" ,

"Links":[{

"Uri":"https://riskmanager.modulo.com/RM/api/queries/rest/3502b1f6-9a63-4b9c-b452-46afec2a6ea0",

"Rel":"run",

"Name":"Run"

}]

}

]