Initializing help system before first use

RuntimeSoapEndpoints

SOAP Endpoint for scheduling & interacting with model executions using SOAP Webservice requests.

Namespace
http://soap.endpoint.xpress.comp.dmp.fico.com/
Path
/RuntimeSoapEndpointsService

execute Operation

Initiates an execution. The input data for the model is optional, as are the model parameters. The execution is given an id, returned in the response, that is used when requesting the results, run log and status this execution.

Input Parameters
name type description
executionRequest (arg0) executionRequest the details of the execution request
Return Value
type description
executionStatus  
Faults
name type conditions
InsufficientStorageForNewExecutionException InsufficientStorageForNewExecutionException  
InvalidExecutionParametersException InvalidExecutionParametersException  

deleteExecution Operation

Deletes the specified execution. If the execution is currently being solved, it will be flagged to be interrupted and deleted shortly; in other cases it will be deleted immediately.

Input Parameters
name type description
executionId (arg0) string the id of the execution
Faults
name type conditions
UnknownExecutionException UnknownExecutionException  

getExecutionStatus Operation

Gets the status of an execution.

Input Parameters
name type description
executionId (arg0) string the id of the execution
Return Value
type description
executionStatus  
Faults
name type conditions
UnknownExecutionException UnknownExecutionException  

getRunLog Operation

Gets the run log of an execution. The run log is available when the execution has started.

Input Parameters
name type description
executionId (arg0) string the id of the execution
Return Value
type description
string  
Faults
name type conditions
UnknownExecutionException UnknownExecutionException  

getRunLogFragment Operation

Gets part of the run log of an execution. The run log is available when the execution has started. You should check the 'version' field in the returned object and, if it is different from that returned by your previous call to getRunLogFragment, delete any locally cached run log & start fetching again from line 1.

Input Parameters
name type description
executionId (arg0) string the id of the execution
firstLine (arg1) int the number of the first line to return. The start of the run log is line 1
maxLines (arg2) int the maximum number of lines of run log data to return
Return Value
type description
runLogFragment  
Faults
name type conditions
UnknownExecutionException UnknownExecutionException  

getInput Operation

Gets the input provided to an execution as a byte array. The input is available when the execution has initialized.

Input Parameters
name type description
executionId (arg0) string the id of the execution
Return Value
type description
base64Binary The input of the execution, as a byte array
Faults
name type conditions
UnknownExecutionException UnknownExecutionException  

getInputAsString Operation

Gets the input provided to an execution as a UTF-8 encoded string. The input is available when the execution has initialized.

Input Parameters
name type description
executionId (arg0) string the id of the execution
Return Value
type description
string  
Faults
name type conditions
UnknownExecutionException UnknownExecutionException  

getResult Operation

Gets the result of an execution as a byte array.

Input Parameters
name type description
executionId (arg0) string the id of the execution
Return Value
type description
base64Binary The result of the execution, as a byte array
Faults
name type conditions
UnknownExecutionException UnknownExecutionException  

getResultAsString Operation

Gets the result of an execution as a UTF-8 encoded string.

Input Parameters
name type description
executionId (arg0) string the id of the execution
Return Value
type description
string  
Faults
name type conditions
UnknownExecutionException UnknownExecutionException  

listExecutions Operation

List all the executions

Return Value
type description
list of executionStatus The status of every execution known to the component.

deleteAllExecutions Operation

Deletes all executions. If any execution is currently being solved, it will be flagged to be interrupted and deleted shortly; in other cases it will be deleted immediately.

getRepositoryStatus Operation

Returns a summary of the repository status

Return Value
type description
repositoryStatus  

© 2001-2023 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.