Initializing help system before first use

Execution admin resources

Operation Description
GET /api/admin/execution/environments

List all execution environments
PATCH /api/admin/execution/environments/{appId}

Update the app execution environment
GET /api/admin/execution/modes

Get all execution modes
PATCH /api/admin/execution/modes/{appId}

Update an app execution mode
GET /api/admin/execution/resource-groups

Get all execution resource groups
PATCH /api/admin/execution/resource-groups/{appId}

Update an app execution resource group
GET /api/admin/execution/service-worker-mappings

Get all service-to-worker mappings
DELETE /api/admin/execution/service-worker-mappings/{serviceId}/{workerId}

Delete a service-to-worker mapping
GET /api/admin/execution/service-worker-mappings/{serviceId}/{workerId}

Get a service-to-worker mapping
POST /api/admin/execution/service-worker-mappings/{serviceId}/{workerId}

Create or update a service-to-worker mapping
GET /api/admin/execution/services

Get all services
POST /api/admin/execution/services

Create a service
DELETE /api/admin/execution/services/{id}

Delete a service
GET /api/admin/execution/services/{id}

Get a service
PATCH /api/admin/execution/services/{id}

Update a service
GET /api/admin/execution/workers

Get all workers
POST /api/admin/execution/workers

Create a worker
DELETE /api/admin/execution/workers/{id}

Delete a worker
GET /api/admin/execution/workers/{id}

Get a worker
PATCH /api/admin/execution/workers/{id}

Update a worker

GET /api/admin/execution/environments

List all execution environments

This will return the execution environments configured for the apps in the system.

Request Parameters

Name Description Type Data Type
page

Number of the page, starting at zero

 query integer (int32)
size

Number of elements per page

 query integer (int32)

Responses

200 OK

The page of execution modes

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

Properties

content: object[]
Array of AppExecutionEnvironment

403 Forbidden

The user did not have authorization to view the execution environments

PATCH /api/admin/execution/environments/{appId}

Update the app execution environment

Updates the app execution environment used during scenario execution.

Request Body

The execution environment to use during the execution of scenarios within this app

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

AppExecutionEnvironment

Request Parameters

Name Description Type Data Type
appId

The app ID to update the execution mode on

 path string (uuid) required

Responses

200 OK

The updated app execution environment

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

AppExecutionEnvironment

403 Forbidden

The user did not have authorization to update this app execution environment

404 Not Found

The app did not exist

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-404",
        "desc": "Not Found",
        "innerError": {
            "code": "OPTI-Insight-Persistence-DocumentNotFound",
            "desc": "Document not found",
            "message": "Unable to find document"
        },
        "message": "Not Found",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}
422 Unprocessable Entity

The execution environment name was too short or too long.

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-422",
        "desc": "Unprocessable Entity",
        "innerError": {
            "code": "FICO-Platform-Validation-InvalidValue",
            "desc": "Entity processing failed",
            "message": "Entity processing failed"
        },
        "message": "Unprocessable Entity",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

GET /api/admin/execution/modes

Get all execution modes

Get all execution modes.

Request Parameters

Name Description Type Data Type
page

Number of the page, starting at zero

 query integer (int32)
size

Number of elements per page

 query integer (int32)

Responses

200 OK

The page of execution modes

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

Properties

content: object[]
Array of AppExecutionMode

403 Forbidden

The user did not have authorization to view the execution modes

PATCH /api/admin/execution/modes/{appId}

Update an app execution mode

Update the preferred execution service assigned to an app execution mode.

Request Body

The app execution mode with the updated preferred execution service

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

AppExecutionMode

Request Parameters

Name Description Type Data Type
appId

The app ID

 path string (uuid) required

Responses

200 OK

The updated app execution mode

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

AppExecutionMode

403 Forbidden

The user did not have authorization to update this app execution mode

404 Not Found

The app or execution mode did not exist

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-404",
        "desc": "Not Found",
        "innerError": {
            "code": "OPTI-Insight-Persistence-DocumentNotFound",
            "desc": "Document not found",
            "message": "Unable to find document"
        },
        "message": "Not Found",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}
422 Unprocessable Entity

The execution mode did not exist in the app, or the preferred name was too short or too long.

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-422",
        "desc": "Unprocessable Entity",
        "innerError": {
            "code": "FICO-Platform-Validation-InvalidValue",
            "desc": "Invalid execution mode",
            "message": "Execution mode must be one of [LOAD, RUN, CUSTOM_LOAD], not CUSTOM_RUN"
        },
        "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": "Entity processing failed",
            "message": "Entity processing failed"
        },
        "message": "Unprocessable Entity",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

GET /api/admin/execution/resource-groups

Get all execution resource groups

Get all execution resource groups.

Request Parameters

Name Description Type Data Type
page

Number of the page, starting at zero

 query integer (int32)
size

Number of elements per page

 query integer (int32)

Responses

200 OK

The page of execution resource groups

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

Properties

content: object[]
Array of AppExecutionResourceGroup

403 Forbidden

The user did not have authorization to view the execution resource groups

PATCH /api/admin/execution/resource-groups/{appId}

Update an app execution resource group

Update the threads and memory assigned to a resource group

Request Body

The app execution resource group with the updated threads and / or memory

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

AppExecutionResourceGroup

Request Parameters

Name Description Type Data Type
appId

The app ID

 path string (uuid) required

Responses

200 OK

The updated app execution resource group

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

AppExecutionResourceGroup

403 Forbidden

The user did not have authorization to update this app execution resource group

404 Not Found

The app or execution resource group did not exist

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-404",
        "desc": "Not Found",
        "innerError": {
            "code": "OPTI-Insight-Persistence-DocumentNotFound",
            "desc": "Document not found",
            "message": "Unable to find document"
        },
        "message": "Not Found",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}
422 Unprocessable Entity

The threads or memory are below the minimum permitted values or otherwise invalid

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-422",
        "desc": "Unprocessable Entity",
        "innerError": {
            "code": "FICO-Platform-Validation-InvalidValue",
            "desc": "Invalid execution mode",
            "message": "Execution mode must be one of [LOAD, RUN, CUSTOM_LOAD], not CUSTOM_RUN"
        },
        "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": "Entity processing failed",
            "message": "Entity processing failed"
        },
        "message": "Unprocessable Entity",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

GET /api/admin/execution/service-worker-mappings

Get all service-to-worker mappings

Get all mappings from execution services to execution workers.

Request Parameters

Name Description Type Data Type
page

Number of the page, starting at zero

 query integer (int32)
size

Number of elements per page

 query integer (int32)

Responses

200 OK

The page of service to worker mappings

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

Properties

content: object[]
Array of ExecutionServiceWorkerMapping

403 Forbidden

The user did not have authority to list mappings

DELETE /api/admin/execution/service-worker-mappings/{serviceId}/{workerId}

Delete a service-to-worker mapping

Delete an existing mapping between an execution service and an execution worker.

Request Parameters

Name Description Type Data Type
serviceId

The service ID

 path string (uuid) required
workerId

The worker ID

 path string (uuid) required

Responses

204 No Content

The mapping was successfully deleted

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

Empty response body

403 Forbidden

The user did not have authorization to delete this mapping

404 Not Found

The mapping did not exist

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-404",
        "desc": "Not Found",
        "innerError": {
            "code": "OPTI-Insight-Persistence-DocumentNotFound",
            "desc": "Document not found",
            "message": "Unable to find document"
        },
        "message": "Not Found",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

GET /api/admin/execution/service-worker-mappings/{serviceId}/{workerId}

Get a service-to-worker mapping

Get a mapping from an execution service to an execution worker.

Request Parameters

Name Description Type Data Type
serviceId

The service ID

 path string (uuid) required
workerId

The worker ID

 path string (uuid) required

Responses

200 OK

The mapping

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

ExecutionServiceWorkerMapping

404 Not Found

The mapping did not exist or was unavailable to the current user

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-404",
        "desc": "Not Found",
        "innerError": {
            "code": "OPTI-Insight-Persistence-DocumentNotFound",
            "desc": "Document not found",
            "message": "Unable to find document"
        },
        "message": "Not Found",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

POST /api/admin/execution/service-worker-mappings/{serviceId}/{workerId}

Create or update a service-to-worker mapping

Create a new mapping if one did not already exist for this worker and service combination, or update an existing mapping. The request body need not supply the worker and service, but if it does the IDs must match this URL.

Request Body

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

ExecutionServiceWorkerMapping

Request Parameters

Name Description Type Data Type
serviceId

The service ID

 path string (uuid) required
workerId

The worker ID

 path string (uuid) required

Responses

200 OK

The created or updated mapping

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

ExecutionServiceWorkerMapping

403 Forbidden

The user did not have authorization to create or update this mapping

422 Unprocessable Entity

The request was not well-formed. For example, if the request contained worker or service IDs and these did not match the URL.

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-422",
        "desc": "Unprocessable Entity",
        "innerError": {
            "code": "FICO-Platform-Validation-InvalidValue",
            "desc": "Mismatched ID in request path and content",
            "message": "IDs must match, found \\'00000000-4995-29d9-0000-000194a8f472\\' in URL but \\'00000001-94a8-f472-0000-0000499529d9\\' in request body"
        },
        "message": "Unprocessable Entity",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

GET /api/admin/execution/services

Get all services

Get all execution services.

Request Parameters

Name Description Type Data Type
page

Number of the page, starting at zero

 query integer (int32)
size

Number of elements per page

 query integer (int32)

Responses

200 OK

The page of services

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

Properties

content: object[]
Array of ExecutionService

403 Forbidden

The user did not have authority to list services

POST /api/admin/execution/services

Create a service

Create a new execution service.

Request Body

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

ExecutionServiceCreationRequest

Responses

201 Created

The service

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

ExecutionService

Location

The URL of the created resource

 string
422 Unprocessable Entity

The request was not well-formed

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-422",
        "desc": "Unprocessable Entity",
        "details": [
            {
                "code": "FICO-Platform-Http-422",
                "desc": "Unprocessable Entity",
                "message": "Must not be empty, and must not start or end with space characters",
                "target": "name",
                "timestamp": "1970-01-03T02:01:33.219Z"
            }
        ],
        "message": "Validation failed",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

DELETE /api/admin/execution/services/{id}

Delete a service

Delete an execution service and its mappings.

Request Parameters

Name Description Type Data Type
id

The service ID

 path string (uuid) required

Responses

204 No Content

The service was successfully deleted

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

Empty response body

403 Forbidden

The user did not have authorization to delete this service

404 Not Found

The service did not exist

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-404",
        "desc": "Not Found",
        "innerError": {
            "code": "OPTI-Insight-Persistence-DocumentNotFound",
            "desc": "Document not found",
            "message": "Unable to find document"
        },
        "message": "Not Found",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

GET /api/admin/execution/services/{id}

Get a service

Get an execution service by ID.

Request Parameters

Name Description Type Data Type
id

The service ID

 path string (uuid) required

Responses

200 OK

The service

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

ExecutionService

404 Not Found

The service did not exist or was unavailable to the current user

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-404",
        "desc": "Not Found",
        "innerError": {
            "code": "OPTI-Insight-Persistence-DocumentNotFound",
            "desc": "Document not found",
            "message": "Unable to find document"
        },
        "message": "Not Found",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

PATCH /api/admin/execution/services/{id}

Update a service

Update an execution service. If supplied, the name and flags (default, enabled, and restricted) will be updated.

Request Body

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

ExecutionService

Request Parameters

Name Description Type Data Type
id

The service ID

 path string (uuid) required

Responses

200 OK

The updated service

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

ExecutionService

403 Forbidden

The user did not have authorization to update this service

404 Not Found

The service did not exist

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-404",
        "desc": "Not Found",
        "innerError": {
            "code": "OPTI-Insight-Persistence-DocumentNotFound",
            "desc": "Document not found",
            "message": "Unable to find document"
        },
        "message": "Not Found",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}
409 Conflict

The updated name was already in use

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-409",
        "desc": "Conflict",
        "innerError": {
            "code": "OPTI-Insight-Locks-ConflictingNameUpdate",
            "desc": "Conflicting naming operation",
            "message": "An item with the same name already exists"
        },
        "message": "Conflict",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}
422 Unprocessable Entity

The IDs did not match, or the updated fields did not meet their constraints

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-422",
        "desc": "Unprocessable Entity",
        "innerError": {
            "code": "FICO-Platform-Validation-InvalidValue",
            "desc": "Mismatched ID in request path and content",
            "message": "IDs must match, found \\'00000000-4995-29d9-0000-000194a8f472\\' in URL but \\'00000001-94a8-f472-0000-0000499529d9\\' in request body"
        },
        "message": "Unprocessable Entity",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

GET /api/admin/execution/workers

Get all workers

Get all execution workers.

Request Parameters

Name Description Type Data Type
page

Number of the page, starting at zero

 query integer (int32)
size

Number of elements per page

 query integer (int32)

Responses

200 OK

The page of workers

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

Properties

content: object[]
Array of ExecutionWorker

403 Forbidden

The user did not have authority to list workers

POST /api/admin/execution/workers

Create a worker

Create a new execution worker.

Request Body

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

ExecutionWorkerCreationRequest

Responses

201 Created

The worker

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

ExecutionWorker

Location

The URL of the created resource

 string
422 Unprocessable Entity

The request was not well-formed

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-422",
        "desc": "Unprocessable Entity",
        "details": [
            {
                "code": "FICO-Platform-Http-422",
                "desc": "Unprocessable Entity",
                "message": "Must not be empty, and must not start or end with space characters",
                "target": "name",
                "timestamp": "1970-01-03T02:01:33.219Z"
            }
        ],
        "message": "Validation failed",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

DELETE /api/admin/execution/workers/{id}

Delete a worker

Delete an execution worker and its mappings.

Request Parameters

Name Description Type Data Type
id

The worker ID

 path string (uuid) required

Responses

204 No Content

The worker was successfully deleted

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

Empty response body

403 Forbidden

The user did not have authorization to delete this worker

404 Not Found

The worker did not exist

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-404",
        "desc": "Not Found",
        "innerError": {
            "code": "OPTI-Insight-Persistence-DocumentNotFound",
            "desc": "Document not found",
            "message": "Unable to find document"
        },
        "message": "Not Found",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

GET /api/admin/execution/workers/{id}

Get a worker

Get an execution worker by ID.

Request Parameters

Name Description Type Data Type
id

The worker ID

 path string (uuid) required

Responses

200 OK

The worker

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

ExecutionWorker

404 Not Found

The worker did not exist or was unavailable to the current user

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-404",
        "desc": "Not Found",
        "innerError": {
            "code": "OPTI-Insight-Persistence-DocumentNotFound",
            "desc": "Document not found",
            "message": "Unable to find document"
        },
        "message": "Not Found",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

PATCH /api/admin/execution/workers/{id}

Update a worker

If supplied, the name, worker URL, job and thread capacities, and unlimited threads flag will be updated.

Request Body

The worker updates to apply

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

ExecutionWorker

Request Parameters

Name Description Type Data Type
id

The worker ID

 path string (uuid) required

Responses

200 OK

The updated worker

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

ExecutionWorker

403 Forbidden

The user did not have authorization to update this worker

404 Not Found

The worker did not exist

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-404",
        "desc": "Not Found",
        "innerError": {
            "code": "OPTI-Insight-Persistence-DocumentNotFound",
            "desc": "Document not found",
            "message": "Unable to find document"
        },
        "message": "Not Found",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}
409 Conflict

The updated name was already in use

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-409",
        "desc": "Conflict",
        "innerError": {
            "code": "OPTI-Insight-Locks-ConflictingNameUpdate",
            "desc": "Conflicting naming operation",
            "message": "An item with the same name already exists"
        },
        "message": "Conflict",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}
422 Unprocessable Entity

The IDs did not match, or the updated fields did not meet their constraints

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-422",
        "desc": "Unprocessable Entity",
        "innerError": {
            "code": "FICO-Platform-Validation-InvalidValue",
            "desc": "Mismatched ID in request path and content",
            "message": "IDs must match, found \\'00000000-4995-29d9-0000-000194a8f472\\' in URL but \\'00000001-94a8-f472-0000-0000499529d9\\' in request body"
        },
        "message": "Unprocessable Entity",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

AppExecutionEnvironment: object

The execution environment to use when executing scenarios

Properties

app:

The app this execution environment belongs to

name: string (1 to 255 chars) , must match ^[^\p{Cntrl}]*$ & ^\S(?:[\s\S]*\S)?$

The name of the execution environment

Example: 
"CUSTOM_ENV_1"

AppExecutionMode: object

An execution mode for an app

Properties

app:

The app this execution mode belongs to

clearsInputData: boolean

Whether this execution mode causes input data to be cleared when it is run

Example: 
false
description: string

The description of this execution mode

Example: 
"My execution mode description"
executionResourceGroup: string

The name of the execution resource group that defines the resources used by this execution mode

Example: 
"MyExecutionResourceGroup"
name: string

The name of this execution mode

Example: 
"RUN"
preferredExecutionService:

The execution service preferred by this execution mode

preferredExecutionServiceName: string (1 to 255 chars)

The name of this execution mode's preferred service

priority: integer (int32)

The priority of this execution mode. A higher number indicates higher precedence, for example a priority of 100 will be prioritised over a priority of 1.

Example: 
5
sendsProgress: boolean

Whether the execution sends progress when this execution mode is run

Example: 
false
threads: integer (int32)

The number of threads that this execution mode uses, or null for unlimited. Threads is deprecated and is now defined on the associated execution resource group.

Example: 
1
unlimitedThreads: boolean

Whether this execution mode places any restriction on number of threads

url: string (uri)

The URL of this execution mode

AppExecutionResourceGroup: object

An execution resource group for an app

Properties

app:

The app this resource group belongs to

defaultMemory: string

The default amount of memory that this resource group defines, as set by the app developer.

Example: 
"2Gi"
defaultThreads: integer (int32)

The default number of threads that this resource group defines, as set by the app developer.

Example: 
2
description: string

The description of this resource group

Example: 
"My execution resource group description"
memory: string

The amount of memory that this resource group currently defines. This will default to the value of defaultMemory but can be modified by an insight administrator.

Example: 
"8Gi"
minMemory: string

The minimum amount of memory that this resource group can define. Memory cannot be set below this value.

Example: 
"1Gi"
minThreads: integer (int32)

The minimum number of threads that this resource group can define. Threads cannot be set below this number.

Example: 
1
name: string

The name of this resource group

Example: 
"MyResourceGroup"
readOnly: boolean

Whether or not this resource group is read only

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

The number of threads that this resource group currently defines. This will default to the value of defaultThreads but can be modified by an insight administrator.

Example: 
8

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

ExecutionService: object

An execution service running on an execution worker

Properties

default: boolean

Whether this service is the default for models which do not nominate a specific service

Example: 
true
enabled: boolean

Whether this service is enabled

Example: 
true
id: string (uuid)

The ID of this execution service

Example: 
"8aadc318-75b3-3bee-7552-3ce8030b27c4"
name: string (1 to 255 chars) , must match ^[^\p{Cntrl}]*$ & ^\S(?:[\s\S]*\S)?$

The name of this execution service

Example: 
"My execution service"
objectType: string , one of { EXECUTION_SERVICE }
restricted: boolean

Whether this service is restricted to certain users via user authorities

Example: 
false
url: string (uri)

The URL of this execution service

Example: 
"/api/admin/execution/services/8aadc318-75b3-3bee-7552-3ce8030b27c4"

ExecutionServiceCreationRequest: object

A request to create a new execution service

Properties

default: boolean

Whether this service is the default for models which do not nominate a specific service

Example: 
true
enabled: boolean

Whether this service is enabled

Example: 
true
name: string (1 to 255 chars) , must match ^[^\p{Cntrl}]*$ & ^\S(?:[\s\S]*\S)?$

The name of the new service

Example: 
"Fast Lane"
restricted: boolean

Whether this service is restricted to certain users via user authorities

Example: 
false

ExecutionServiceWorkerMapping: object

Properties

enabled: boolean

Whether this mapping is enabled

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

The maximum number of jobs that can run at once

Example: 
4
memoryCapacity: string

The maximum amount of memory that can be consumed by jobs running on this mapping. This is a number followed by either Mi or Gi to specify megabytes or gigabytes

Example: 
"4Gi"
objectType: string , one of { EXECUTION_SERVICE_WORKER_MAPPING }

The type of reference

service:

A reference to the execution service

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

The maximum number of threads that can run at once

Example: 
16
unlimitedJobs: boolean

Whether this mapping places any restriction on the number of jobs

unlimitedMemory: boolean

Whether this mapping places any restriction on the amount of memory

unlimitedThreads: boolean

Whether this mapping places any restriction on the number of threads

url: string (uri)

The URL of this mapping

worker:

A reference to the execution worker

ExecutionWorker: object

A worker which executes jobs

Properties

enabled: boolean

Whether this worker is enabled

Example: 
true
id: string (uuid)

The ID of this execution worker

Example: 
"c0025fa4-889a-df02-3ffd-a05bc67ebe59"
jobCapacity: integer (int32) , { x ∈ ℤ | 1 ≤ x ≤ 256 }

The maximum number of jobs that this worker can run at once

Example: 
2
memoryCapacity: string

The maximum amount of memory that can be consumed by jobs running on this worker. This is a number followed by either Mi or Gi to specify megabytes or gigabytes

Example: 
"3Gi"
name: string (1 to 255 chars) , must match ^[^\p{Cntrl}]*$ & ^\S(?:[\s\S]*\S)?$

The name of this execution worker

Example: 
"My execution worker"
objectType: string , one of { EXECUTION_WORKER }
state:

The current state of this worker

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

The maximum number of threads that this worker can run at once

Example: 
4
unlimitedMemory: boolean

Whether this worker has unlimited memory capacity

Example: 
false
unlimitedThreads: boolean

Whether this worker has unlimited thread capacity

Example: 
false
url: string (uri)

The URL of this execution worker

Example: 
"/api/admin/execution/workers/c0025fa4-889a-df02-3ffd-a05bc67ebe59"
version: string

The version of this worker

Example: 
"1.2.3"
workerUrl: string (uri)

The URL that this worker is available on

Example: 
"https://my-worker:9080"

ExecutionWorkerCreationRequest: object

A request to create a new execution worker

Properties

enabled: boolean

Whether this worker is enabled

Example: 
true
jobCapacity: integer (int32) , { x ∈ ℤ | 1 ≤ x ≤ 256 }

The maximum number of jobs that this worker can run at once

Example: 
2
memoryCapacity: string

The maximum amount of memory that can be consumed by jobs running on this worker. This is a number followed by either Mi or Gi to specify megabytes or gigabytes

Example: 
"3Gi"
name: string (1 to 255 chars) , must match ^[^\p{Cntrl}]*$ & ^\S(?:[\s\S]*\S)?$

The name for this worker

Example: 
"worker1"
threadCapacity: integer (int32) , { x ∈ ℤ | 1 ≤ x ≤ 256 }

The maximum number of threads that this worker can run at once

Example: 
4
unlimitedMemory: boolean

Whether this worker has unlimited memory capacity

Example: 
false
unlimitedThreads: boolean

Whether this worker has unlimited thread capacity

Example: 
false
workerUrl: string (uri)

The URL that this worker is available on

Example: 
"https://my-worker:9080"

ExecutionWorkerState: object

Properties

message: string

A message containing information about this worker's status

Example: 
"Status check passed"
status: string , one of { ONLINE , OFFLINE , IDLE , PROVISIONING }

The current status of this worker

Example: 
"ONLINE"
statusLastModified: string (date-time)

When this worker's status was last modified

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:

More specific error information

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-502 , 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"

Page: object

A page containing a subset of content which can be paginated through

Properties

content: object[]

The items in this page of results

Array of object
first: boolean

Whether this is the first page

Example: 
false
last: boolean

Whether this is the last page

Example: 
true
number: integer (int32)

The page number, starting at 0

Example: 
4
numberOfElements: integer (int32)

The number of elements in this page of results

Example: 
18
size: integer (int32)

The number of results per page

Example: 
20
sort:

The sort order applied to the results

totalElements: integer (int32)

The total number of elements in all the pages

Example: 
98
totalPages: integer (int32)

The total number of pages

Example: 
5

ReferenceApp: object

The basic details of an app

Properties

id: string (uuid)

The ID of this app

Example: 
"00007eff-83f9-05fe-ffff-81007c05fc01"
name: string (1 to 255 chars) , must match ^[^\p{Cntrl}]*$ & ^\S(?:[\s\S]*\S)?$

The name of this app

Example: 
"My app"
objectType: string , one of { APP }
url: string (uri)

The URL of this app

Example: 
"/api/apps/00007eff-83f9-05fe-ffff-81007c05fc01"

ReferenceExecutionService: object

Properties

id: string (uuid)

The ID of this execution service

Example: 
"8aadc318-75b3-3bee-7552-3ce8030b27c4"
name: string (1 to 255 chars) , must match ^[^\p{Cntrl}]*$ & ^\S(?:[\s\S]*\S)?$

The name of this execution service

Example: 
"My execution service"
objectType: string , one of { EXECUTION_SERVICE }
url: string (uri)

The URL of this execution service

Example: 
"/api/admin/execution/services/8aadc318-75b3-3bee-7552-3ce8030b27c4"

ReferenceExecutionWorker: object

Properties

id: string (uuid)

The ID of this execution worker

Example: 
"c0025fa4-889a-df02-3ffd-a05bc67ebe59"
name: string (1 to 255 chars) , must match ^[^\p{Cntrl}]*$ & ^\S(?:[\s\S]*\S)?$

The name of this execution worker

Example: 
"My execution worker"
objectType: string , one of { EXECUTION_WORKER }
url: string (uri)

The URL of this execution worker

Example: 
"/api/admin/execution/workers/c0025fa4-889a-df02-3ffd-a05bc67ebe59"

Sort: object

Details of how paged results were sorted

Properties

empty: boolean

True if there are no results

sorted: boolean

True if the results are sorted

unsorted: boolean

True if the results are not sorted

Parent Topic Insight 5 REST API

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