Initializing help system before first use

Executor REST API

Resources

name path methods description
RuntimeEndpoints
  • /runtime/execution/{id}
  • /runtime/execution/{id}/input
  • /runtime/execution/{id}/result
  • /runtime/status
  • /runtime/execution/{id}/runlog
  • /runtime/execution
  • /runtime/ping
  • DELETE, GET
  • GET
  • GET
  • GET
  • GET
  • DELETE, GET, POST
  • GET
Endpoints for interacting with the Xpress Executor component, scheduling executions, querying status & results.
StatusEndpoints
  • /status/healthcheck
  • /status/cachedhealthcheck
  • /status/healthchecks
  • GET
  • DELETE
  • GET
Endpoints for querying the health of the component

Services

Namespace http://soap.endpoint.xpress.comp.dmp.fico.com/
name description
RuntimeSoapEndpoints SOAP Endpoint for scheduling & interacting with model executions using SOAP Webservice requests.

Data Types

JSON

type description
ExecutionRequestData Container for desired inputs for the execution. The input file is specified as either text (in inputText) or binary (in inputBase64) or neither, and any parameters as an enclosed map.
HealthCheckSummary Structure summarising the results of the last health check performed
ModelExecution Structure containing status information about a model execution.
ModelStatus Enumeration of possible model status codes. For error codes, the execution run log may contain more information.
PassFailSkip
RepositoryStatus Structure containing information about the status of the repository
RunLogFragment Structure containing information about (part or all) of the run log

XML

Default Namespace
type description
modelStatus Enumeration of possible model status codes. For error codes, the execution run log may contain more information.
repositoryStatus Structure containing information about the status of the repository
runLogFragment Structure containing information about (part or all) of the run log
executionRequest The input data and parameters to use when performing an execution. You should specify the model input & result in either inputString or inputBytes (or neither), but not both.
executionStatus The status of an execution.
parameter A single model parameter
faultBean Encapsulates additional information about faults from the Xpress Executor SOAP webservice.