3.13 RunVQLQuery

POST method to run a VQL query against the available Workflow Automation provider namespaces.

3.13.1 Request Parameters

Include the following parameters in the request URL as needed.

Parameter

Description
  • sessionID
  • userName
  • password
  • hostName
  • portNumber

All web service calls require BSL authentication and may optionally identify a Workflow Automation Server. For more information about authentication and identification, see Authentication and Identification.

3.13.2 Request Data

Include the following elements in the POST request data as needed.

Element

Description

QueryString

REQUIRED. VOS query language string.

RetrieveSchema

OPTIONAL. If true, return the schema as part of the query result. If not specified, the default is true.

3.13.3 Response Data

The POST response data contains the following elements.

Element

Description

ResultList

IQConnect table-like structure containing the VOS query results.

Schema

List of attribute names and values that define the VOS query table column names and types.