getProceduralResult
Get the procedural result associated with the resultId returned from a call to
executeProcedure or
executeSqlScript.
If isBlocking is TRUE, this operation does not return until the processing associated with the execution has completed and the outputs element is set. Otherwise, this operation returns immediately and outputs are only set if the COMPLETED element is TRUE.
If includeMetadata is TRUE, the response includes the metadata element. The metadata element describes the names and types of the output parameter data that are provided in the result, either in this call or in a later call to
getProceduralResult.
The completed element reports whether all possible results have been retrieved.
The requestStatus element reports the status of the server request associated with the execution. The request status can be one of the following:
• STARTED: The request has started. The request has been created but is not yet running.
• WAITING: The request is waiting in a queue for the server to process the request.
• RUNNING: The request is currently being executed by the server.
• COMPLETED: The execution associated with the request has completed. Results can now be acquired.
• CLOSING: The request is closing.
• SUCCESS: The request closed with success.
• FAILURE: The request closed with failure.
• TERMINATED: The request was terminated.
The rowsAffected element is set if it is known how many rows were affected by this execution.
The outputs element contains a set of ProcValue instance. If the out type is cursor, you should get a resultId which is a handle to the result in server. You can use it with
getTabularResult and
closeResult. If the out type is not cursor, you should get real output value.
Location
/services/webservices/system/admin/execute/operations/
Request Elements
resultId: The result ID.
isBlocking: If TRUE (default), do not return until the execution completes.
includeMetadata (optional): If TRUE, the response contains information about the output parameter names and their types. Defaults to FALSE.
Response Elements
completed: If TRUE, all processing associated with execution has completed.
requestStatus: Status of the server request performing the execution.
metadata (optional): Table metadata listing the parameter names and types within the result.
rowsAffected (optional): If known, the number of rows affected by the execution; otherwise unset.
outputs (optional): List of type-value pairs of procedural outputs.
Faults
IllegalArgument: If the isBlocking element is malformed.
NotFound: If the resultId does not exist within the current transaction or has already been closed.
RuntimeError: If an error occurs during execution. The resultId is closed if this occurs.