Initializing help system before first use

Configuration resources

Operation Description
DELETE /api/config

Delete the configuration
GET /api/config

Get the configuration
PATCH /api/config

Update the configuration

DELETE /api/config

Delete the configuration

Delete the configuration, resetting it to defaults.

Responses

200 OK

The configuration was deleted successfully

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

ExecutorConfiguration

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
423 Locked

The configuration could not be deleted as it was locked elsewhere

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-423",
        "desc": "Locked",
        "innerError": {
            "code": "OPTI-Executor-Locks-AcquisitionFailure",
            "desc": "Processing failed as configuration in use elsewhere",
            "message": "The executor configuration is locked."
        },
        "message": "Locked",
        "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

GET /api/config

Get the configuration

Get the configuration.

Responses

200 OK

OK

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

ExecutorConfiguration

FICO-Execution-Configuration-Is-Editable boolean
FICO-Execution-Host

The hostname of the Executor that handled the request

 string

PATCH /api/config

Update the configuration

Update the configuration.

Request Body

The updated configuration

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

ExecutorConfiguration

Responses

200 OK

The configuration was updated

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

ExecutorConfiguration

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
422 Unprocessable Entity

The new configuration is not valid

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

ErrorResponse

FICO-Execution-Host

The hostname of the Executor that handled the request

 string
423 Locked

The configuration could not be updated as it was in use elsewhere

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-423",
        "desc": "Locked",
        "innerError": {
            "code": "OPTI-Executor-Locks-AcquisitionFailure",
            "desc": "Processing failed as configuration in use elsewhere",
            "message": "The executor configuration is locked."
        },
        "message": "Locked",
        "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

ExecutorConfiguration: object

The Executor Configuration

Properties

concurrencyLevel: integer (int32) , { x ∈ ℤ | 1 ≤ x ≤ 256 }

The total allowed concurrent executions per node

Example: 
4
executionTimeout: integer (int32) , { x ∈ ℤ | x ≥ 1 }

The timeout in seconds for executing models

Example: 
6000
parameters:
persistRunLogToS3: boolean

Whether to persist completed runlog to S3

Example: 
true
runWarmup: boolean

Whether to run a warmup execution

Example: 
true

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

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"

Parameters: object

The model parameters

Example: 
"{ \"FACTOR\": 1.23, \"VERBOSE\": false, \"MODE\": \"Simulation\" }"
string
boolean
number
Parent Topic Executor 4 REST API

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