Initializing help system before first use

# Model resources

Operation | Description
--- | ---
DELETE /api/config/model | Delete the model
HEAD /api/config/model | Model details
POST /api/config/model | Upload a new model

# DELETE /api/config/model

Delete the model

Delete the model

## Responses

204 No Content

  The model was successfully deleted

  Content-Type application/vnd.com.fico.executor.v2+json

    Empty response body

  FICO-Execution-Host | The hostname of the Executor that handled the request | string

403 Forbidden

  The component is not in the design lifecycle environment

  Content-Type application/vnd.com.fico.executor.v2+json

    Empty response body

  FICO-Execution-Host | The hostname of the Executor that handled the request | string

# HEAD /api/config/model

Model details

The size, path and time last modified of the model, if one exists

## Responses

200 OK

  The model exists

  Content-Type application/vnd.com.fico.executor.v2+json

    Empty response body

  Content-Length |  | string
  FICO-Execution-Host | The hostname of the Executor that handled the request | string
  FICO-Execution-Model-Is-Editable |  | boolean
  Last-Modified |  | string

404 Not Found

  No model exists

  Content-Type application/vnd.com.fico.executor.v2+json

    Empty response body

  FICO-Execution-Host | The hostname of the Executor that handled the request | string

# POST /api/config/model

Upload a new model

Upload a new model from the given model zip file

## Request Body

Content-Type multipart/form-data

  ### Properties

  model: string (binary) required

    The zip file of the model

## Responses

201 Created

  The model was successfully added

  Content-Type application/vnd.com.fico.executor.v2+json

    Empty response body

  FICO-Execution-Host | The hostname of the Executor that handled the request | string

403 Forbidden

  The component is not in the design lifecycle environment

  Content-Type application/vnd.com.fico.executor.v2+json

    Empty response body

  FICO-Execution-Host | The hostname of the Executor that handled the request | string

413 Request Entity Too Large

  The model file size exceeded the maximum model upload file size (xpress.executor.max-upload-size)

  Content-Type application/vnd.com.fico.executor.v2+json

    ErrorResponse

  Example:

      {
          "error": {
              "code": "FICO-Platform-Http-413",
              "desc": "Payload Too Large",
              "innerError": {
                  "code": "FICO-Platform-Validation-FileTooLarge",
                  "desc": "Model file too large",
                  "message": "Unzipped file exceeded upload threshold (900 MB)."
              },
              "message": "Payload Too Large",
              "parentId": "0000000000000def",
              "spanId": "0000000000000123",
              "timestamp": "1970-01-03T02:01:33.219Z",
              "traceId": "0000000000000abc"
          }
      }

  Example:

      {
          "error": {
              "code": "FICO-Platform-Http-413",
              "desc": "Payload Too Large",
              "innerError": {
                  "code": "FICO-Platform-Validation-FileTooLarge",
                  "desc": "Too many files in model zip",
                  "message": "Model zip must not have more than a thousand files."
              },
              "message": "Payload Too Large",
              "parentId": "0000000000000def",
              "spanId": "0000000000000123",
              "timestamp": "1970-01-03T02:01:33.219Z",
              "traceId": "0000000000000abc"
          }
      }

  Example:

      {
          "error": {
              "code": "FICO-Platform-Http-413",
              "desc": "Payload Too Large",
              "innerError": {
                  "code": "FICO-Platform-Validation-FileTooLarge",
                  "desc": "Model file too large",
                  "message": "File exceeded upload threshold (300 MB)."
              },
              "message": "Payload Too Large",
              "parentId": "0000000000000def",
              "spanId": "0000000000000123",
              "timestamp": "1970-01-03T02:01:33.219Z",
              "traceId": "0000000000000abc"
          }
      }

  FICO-Execution-Host | The hostname of the Executor that handled the request | string

422 Unprocessable Entity

  The file was invalid. See the details in the error response.

  Content-Type application/vnd.com.fico.executor.v2+json

    ErrorResponse

  Example:

      {
          "error": {
              "code": "FICO-Platform-Http-422",
              "desc": "Unprocessable Entity",
              "innerError": {
                  "code": "FICO-Platform-Validation-InvalidValue",
                  "desc": "Missing BIM file",
                  "message": "The compiled model file was not found at the top level of the archive."
              },
              "message": "Unprocessable Entity",
              "parentId": "0000000000000def",
              "spanId": "0000000000000123",
              "timestamp": "1970-01-03T02:01:33.219Z",
              "traceId": "0000000000000abc"
          }
      }

  Example:

      {
          "error": {
              "code": "FICO-Platform-Http-422",
              "desc": "Unprocessable Entity",
              "innerError": {
                  "code": "FICO-Platform-Validation-InvalidValue",
                  "desc": "Model upload failure",
                  "message": "Failed to import model."
              },
              "message": "Unprocessable Entity",
              "parentId": "0000000000000def",
              "spanId": "0000000000000123",
              "timestamp": "1970-01-03T02:01:33.219Z",
              "traceId": "0000000000000abc"
          }
      }

  Example:

      {
          "error": {
              "code": "FICO-Platform-Http-422",
              "desc": "Unprocessable Entity",
              "innerError": {
                  "code": "FICO-Platform-Validation-InvalidValue",
                  "desc": "Model zip file invalid",
                  "message": "Failed to import model: File is not a valid zip archive."
              },
              "message": "Unprocessable Entity",
              "parentId": "0000000000000def",
              "spanId": "0000000000000123",
              "timestamp": "1970-01-03T02:01:33.219Z",
              "traceId": "0000000000000abc"
          }
      }

  Example:

      {
          "error": {
              "code": "FICO-Platform-Http-422",
              "desc": "Unprocessable Entity",
              "innerError": {
                  "code": "FICO-Platform-Validation-InvalidValue",
                  "desc": "Unparsable BIM file",
                  "message": "Failed to parse the model.bim file."
              },
              "message": "Unprocessable Entity",
              "parentId": "0000000000000def",
              "spanId": "0000000000000123",
              "timestamp": "1970-01-03T02:01:33.219Z",
              "traceId": "0000000000000abc"
          }
      }

  FICO-Execution-Host | The hostname of the Executor that handled the request | string

# ErrorDetail: object

An error detail

### Properties

code: string

  The unique code for this error

  Example:

      "FICO_PLATFORM_VALIDATION_INVALID_VALUE"

desc: string

  A description of this error for client information, not intended for display to the end user

  Example:

      "Conflict"

message: string

  A message providing further information which may be displayed to the end user

  Example:

      "Conflict"

target: string

  An identifier to help the client locate the error. Typically a JSON property name.

timestamp: string (date-time)

  When the error was first detected

# ErrorResponse: object

An error response containing fault or error information

### Properties

error:

  The top level error

  OuterError

# InnerError: object

More specific error information

### Properties

code: string

  The unique code for this error

  Example:

      "FICO-Platform-Validation-FileTooLarge"

desc: string

  A description of this error for client information, not intended for display to the end user

  Example:

      "Attachment upload too large"

innerError: InnerError
message: string

  A message providing further information which may be displayed to the end user

  Example:

      "Files larger than 300 MB cannot be uploaded as attachments."

# OuterError: object

The top level error

### Properties

code: string , one of { FICO-Platform-Http-400 , FICO-Platform-Http-404 , FICO-Platform-Http-406 , FICO-Platform-Http-409 , FICO-Platform-Http-413 , FICO-Platform-Http-422 , FICO-Platform-Http-423 , FICO-Platform-Http-429 , FICO-Platform-Http-500 , FICO-Platform-Http-503 }

  The unique code for this error

  Example:

      "FICO-Platform-Http-409"

desc: string

  A description of this error for client information, not intended for display to the end user

  Example:

      "Conflict"

details: object[]

  Details about specific errors that led to this reported error

  Array of ErrorDetail
innerError:

  More specific error information

  InnerError
message: string

  A message providing further information which may be displayed to the end user

  Example:

      "Conflict"

parentId: string

  An OpenTracing parent-span ID

  Example:

      "0020000000000001"

spanId: string

  An OpenTracing span ID

  Example:

      "b2fb4a1d1a96d312"

timestamp: string (date-time)

  When the error was first detected

traceId: string

  An OpenTracing trace ID

  Example:

      "463ac35c9f6413ad48485a3953bb6125"

Parent Topic Executor 4 REST API

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