Initializing help system before first use

Executor REST API

FICO Xpress Executor Web Application

Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

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

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.

The services API is also accessible by a set of client-side libraries that can be downloaded from the files and libraries page.

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.
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.
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.
Covered Topics
  • files and libraries
  • files and libraries page
  • RuntimeEndpoints
    Endpoints for interacting with the Xpress Executor component, scheduling executions, querying status & results.
  • RuntimeSoapEndpoints
    SOAP Endpoint for scheduling & interacting with model executions using SOAP Webservice requests.
  • 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.
  • 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.
  • RepositoryStatus
    Structure containing information about the status of the repository
  • RunLogFragment
    Structure containing information about (part or all) of the run log
  • 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.
Parent Topic Decision Management Platform

© 2001-2020 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.