View Compliance Query Results

Returns the results of a query from the Compliance module. Queries are accessible only to their authors, editors, and audience members.

 

KNOWN LIMITATIONS

Queries to view interview results are not supported.

 

URL

{RMUrl}/api/Compliance/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 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 "Object" query:

{RMUrl}/api/Compliance/queries/Object

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

 

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

{RMUrl}/api/Compliance/queries/Object?page=3&page_size=10

{RMUrl}/api/Compliance/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

[

{"ObjectName":"Tactical Business Component","ObjectType":"Business Component","ComplianceIndex":0.6938,"ComplianceLevel":"Not Compliant","ProjectCode":"PRJC11005","ProjectName":"Compliance Project"},

{"ObjectName":"Network Administration Office","ObjectType":"Asset","ComplianceIndex":0.8141,"ComplianceLevel":"Not Compliant","ProjectCode":"PRJC11005","ProjectName":"Compliance Project"},

{"ObjectName":"Windows Server 2008","ObjectType":"Asset","ComplianceIndex":0.7345,"ComplianceLevel":"Not Compliant","ProjectCode":"PRJC11005","ProjectName":"Compliance Project"}

]