getResourcePlan
Execute the provided path directly within the TDV server and return the execution plan. Only PROCEDURE and TABLE resources can be executed.
The rootNodeTitle is the name of this sqlText execution plan. It is possible to get the execution plan for the resource in the path element.
The parameters element contains a set of parameters to be inputs to the execution for TDV script. A parameter contains two subelements:
• definition: SQL language type for this parameter value. For example, VARCHAR(40) or BIGINT.
• value: The value of this parameter.
The queryPlanRoot contains the root plan.
The name contains this plan’s node name.
The type shows this plan’s node type. PROCEDURE and TABLE are valid types.
The properties element contains a set of plan node properties.
Only users with the ACCESS_TOOLS right can call this operation.
Location
/services/webservices/system/admin/execute/operations/
Request Elements
rootNodeTitle (optional): The name of this path execution plan. Defaults to Execution Plan.
path: Specify a full resource path of a table or procedure for that SQL to be evaluated.
type: TABLE and PROCEDURE types are valid.
parameters (optional): A list of parameter elements (containing definition-value pairs) to use as input for the execution.
Response Elements
queryPlanRoot (iterative over child nodes, to any depth):
• name: Query plan node name.
• type: Type of this query plan node.
• properties (optional): List of name-value pairs of properties for current node.
Faults
RuntimeError: If an error occurs during execution.
Security: If the user does not have the ACCESS_TOOLS right and other appropriate priveleges.