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 |
The status of the resultant execution |
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 |
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 |
The run log of the execution |
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 |
The run log of the execution |
Faults
| name |
type |
conditions |
| UnknownExecutionException |
UnknownExecutionException |
|
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 |
|
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 |
The input of the execution, as a UTF-8 encoded 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 |
The result of the execution, as a UTF-8 encoded string |
Faults
| name |
type |
conditions |
| UnknownExecutionException |
UnknownExecutionException |
|
listExecutions Operation
List all the executions
Return Value
| type |
description |
| 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