Execution Web Service definition
GetServiceURL
Retrieve the load balanced service URL.
Parameters
string username, string password
Return value
string serviceURL
Login
This would explicitly login the provided user and create a session that could be kept alive on the server.
All other methods would require being associated with this ticket.
Parameters
string username, string password
Return value
string ticket
Logout
Explicitly ends the session associated with the provided user and ticket. Logging the user out, ending any execution jobs, and deleting any resulting output. (The agent class logout method requires username and userTicket in order to perform a logout.)
Parameters
string username, string userTicket
Return value
Void
ExecuteAsync()
Async method. The method will run the job in a new thread and be immediately returned.
All xml used here follows the IBM SPSS Collaboration and Deployment Services Repository schedParams schema.
Parameters
string username, String ticket, byte[] packageContent, string xmlParams
Return value
string jobID
GetExecutionStatus
Sync method. Provides a way to check the associated job status.
Parameters
String username, String ticket, string jobID
Return value
ExecutionStatusEnum : Starting, Running, Canceling, Canceled, Completed, Not Found, Error
GetExecutionLog
Sync method. The execution log can be retrieved at any time.
Parameters
String username, String ticket, String jobID
Return Value
Log string
Cancel()
Async method. The method will be immediately returned (platform required).
The client can GetExecutionStatus() to check the job status at any time.
Parameters
String username, String ticket, string jobID
Return value
Bool
(True: cancel success False: cancel failed)
GetOutputFile()
Sync method. The output file will be zipped and then returned in the byte[] stream.
Parameters
String username, String ticket, string jobID string fileName
Return value
Byte[]
(file content in byte[] format)
GetOutputVariables()
Sync method. The output variables are returned in XML format.
Parameters
String username, String ticket, string jobID
Return value
string xmlParams
Close()
Sync method. Cleans the working job directory.
Parameters
String username, String ticket, string jobID
Return value
Void
See also