View Workflow Query Results

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

 

URL

{WSUrl}/api/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 to be 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 "Open Risk Events" query:

{WSUrl}/api/queries/Open Risk Events

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

 

Results 41 through 60 (third page, size 20):

{WSUrl}/api/queries/Open Risk Events?page=3&page_size=20

{WSUrl}/api/queries/cc45b704-b3d5-11e0-8b69-001ec91f4b0a?page=3&page_size=20

 

SUCCESS RESPONSE

Returns a dynamic list of objects, according to the columns selected when creating the query and their respective values.

 

SUCCESS RESPONSE EXAMPLE

[

{"EventID":"EVTR201108000279","Title":"Host Names Found","Status":Open,"USR":9},

{"EventID":"EVTR201106000049","Title":"List of Web Directories","Status":Open,"USR":15},

{"EventID":"EVTR201106000059","Title":"Microsoft Windows Application EventLog Policy Parameters","Status":Open,"USR":27},

{"EventID":"EVTR201106000171","Title":"Microsoft Windows Users With Privilege - Increase Base Priority","Status":Open,"USR":27},

{"EventID":"EVTR201108000282","Title":"Microsoft Windows Users With Privilege - Profile Single Process","Status":Open,"USR":40},

{"EventID":"EVTR201110000740","Title":"DNS Host Name","Status":Open,"USR":9},

{"EventID":"EVTR201107000193","Title":"Windows Services List","Status":Open,"USR":25}

]