3.12 RunVOSScriptByProvider

POST method to run a VOS script query against a specific provider namespace.

3.12.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.12.2 Request Data

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

Element

Description

AttributeList

REQUIRED. List of names and values that are input parameters for the VOS script. This list can be empty if the script does not have input parameters.

RetriveSchema

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

Script

REQUIRED. VOS script.

Provider

REQUIRED. Workflow Automation provider name.

HINT:You can get a list of all the active providers for a Workflow Automation Server using the GetManagementServices method.

3.12.3 Response Data

The POST response data contains the following elements.

Element

Description

OutputIsQueryResult

If true, element QueryResult contains the results from the VOS script. Otherwise, element StringResult contains the results.

QueryResult

IQConnect table-like structure containing the VOS script results if OutputQueryResult is true.

StringResult

String containing the VOS script results if OutputQueryResult is false.