View Organizational Query Results

Returns the results of a query registered in the Organization module. Each user can only access queries of which they are author, editor, or an audience member.

 

URL

{RMUrl}/api/Organization/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 name or GUID of the query. 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 "Grouping" query:

{RMUrl}/api/Organization/queries/Grouping

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

 

Results 21 through 30 (third page, size 10):

{RMUrl}/api/Organization/queries/Grouping?page=3&page_size=10

{RMUrl}/api/Organization/queries/cc45b704-b3d5-11e0-8b69-001ec91f4b0a?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

[

{"Name":"Computer_01","GapIndex":0.33333333333333331,"RiskIndex":0.4,"IdentifiedRisk":72,"SecurityIndex":0.6,"ControlIndex":0.66666666666666663},

{"Name":"Conference Room","GapIndex":1,"RiskIndex":1,"IdentifiedRisk":51,"SecurityIndex":0,"ControlIndex":0},

{"Name":"Computer_02","GapIndex":0,"RiskIndex":0,"IdentifiedRisk":0,"SecurityIndex":0,"ControlIndex":0},

{"Name":"Improvement Process","GapIndex":0,"RiskIndex":0,"IdentifiedRisk":0,"SecurityIndex":0,"ControlIndex":0}

]