Initializing help system before first use

App resources

Operation Description
GET /api/apps

Get all apps
POST /api/apps

Create a new app
DELETE /api/apps/{id}

Delete an app
GET /api/apps/{id}

Get an app
PATCH /api/apps/{id}

Update an app
POST /api/apps/{id}

Upgrade an app
GET /api/apps/{id}/children

Get the root folders and scenarios of an app
POST /api/apps/{id}/children

Move an existing folder or scenario to its app root
GET /api/apps/{id}/members

Get the members of an app
GET /api/apps/{id}/model-schema

Get the model schema of an app

GET /api/apps

Get all apps

Get all apps that are visible to the current user.

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 apps

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

Properties

content: object[]
Array of App

POST /api/apps

Create a new app

Create a new app from the given app file, optionally providing the name of the new app. If the name is not present in the configuration, it will be taken from the appName parameter. If the overrideAppName parameter is supplied, this will be used instead.

Request Body

Content-Type multipart/form-data

Properties

appFile: string (binary) required

The app zip file used to create the app

appName: string required

The app name to use if none is present in the app configuration

overrideAppName: string

The app name override, used as the new app name regardless of any other app configuration

Responses

201 Created

The app was successfully created

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

AppCreationResponse

Location

The URL of the created resource

 string
403 Forbidden

The user did not have authority to create the app

413 Request Entity Too Large

The app file size exceeded the maximum app upload file size

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-413",
        "desc": "Payload Too Large",
        "innerError": {
            "code": "FICO-Platform-Validation-FileTooLarge",
            "desc": "App 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"
    }
}
422 Unprocessable Entity

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

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": "App upload failure",
            "message": "Failed to import App."
        },
        "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": "App zip file invalid",
            "message": "Failed to import app: 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": "App filename missing",
            "message": "Failed to import app: App filename must be supplied"
        },
        "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": "App zip file missing",
            "message": "Failed to import app: null input"
        },
        "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": "Invalid app folder hierarchy",
            "message": "Invalid insight file: folders.json is invalid. Circular reference detected"
        },
        "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": "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": "Missing companion file",
            "message": "The companion 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"
    }
}

DELETE /api/apps/{id}

Delete an app

Delete the app together with all its scenarios, jobs and custom authorities.

Request Parameters

Name Description Type Data Type
id

The app ID

 path string (uuid) required

Responses

204 No Content

The app was successfully deleted

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

Empty response body

403 Forbidden

The user did not have authority to delete the app

404 Not Found

The app did not exist, or the user was not a member of it

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/apps/{id}

Get an app

Get an app by ID.

Request Parameters

Name Description Type Data Type
id

The app ID

 path string (uuid) required

Responses

200 OK

The app

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

App

404 Not Found

The app did not exist, or the user was not a member of it

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/apps/{id}

Update an app

Update the name of this app by supplying the desired new name.

Request Body

The app with its new name

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

App

Request Parameters

Name Description Type Data Type
id

The app ID

 path string (uuid) required

Responses

200 OK

The updated app

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

App

403 Forbidden

The user did not have authority to update the app

404 Not Found

The app did not exist, or the user was not a member of it

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 updated name was invalid, or the ID in the request body did not match the ID in the request URL

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"
    }
}

POST /api/apps/{id}

Upgrade an app

Upgrading an app will augment all the resources in the app with the contents of the zip. This endpoint is now deprecated. Its replacement is within Portations. See "/api/portations" for updated usage.

Request Body

Content-Type multipart/form-data

Properties

appFile: string (binary) required

The app file

appUpgradeRequest:

The AppUpgradeRequest to specify options for the upgrade.

Request Parameters

Name Description Type Data Type
id

The app ID

 path string (uuid) required

Responses

200 OK

The upgraded app

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

AppUpgradeResponse

403 Forbidden

The user did not have authority to upgrade the app

404 Not Found

The app did not exist, or the user was not a member of it

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"
    }
}
413 Request Entity Too Large

The app file size exceeded the maximum app upload file size

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

ErrorResponse

Example: 
{
    "error": {
        "code": "FICO-Platform-Http-413",
        "desc": "Payload Too Large",
        "innerError": {
            "code": "FICO-Platform-Validation-FileTooLarge",
            "desc": "App 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"
    }
}
422 Unprocessable Entity

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

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": "App upgrade failure",
            "message": "Unexpected error during upgrade. Failed to upgrade app."
        },
        "message": "Unprocessable Entity",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

GET /api/apps/{id}/children

Get the root folders and scenarios of an app

Get the immediate child folders and scenarios of the app root.

Request Parameters

Name Description Type Data Type
id

The app ID

 path string (uuid) required
page

Number of the page, starting at zero

 query integer (int32)
size

Number of elements per page

 query integer (int32)

Responses

200 OK

The app's children

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

Properties

content: []
Array of

404 Not Found

The app did not exist, or the user was not a member of it

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/apps/{id}/children

Move an existing folder or scenario to its app root

Move the given folder or scenario to the root (top level) of this app. The folder or scenario must already belong to this app.

Request Body

The folder or scenario to move, with its ID and object type

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

Empty response body

Request Parameters

Name Description Type Data Type
id

The app ID

 path string (uuid) required

Responses

200 OK

The moved folder or scenario

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

Empty response body

403 Forbidden

The user did not have authority to move the folder or scenario

404 Not Found

The app did not exist, or the user was not a member of it

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 user is trying to move some other type of object (not a folder or scenario), or the scenario is unavailable to the current user

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/apps/{id}/members

Get the members of an app

Get all direct members, and users who have authority to access all apps.

Request Parameters

Name Description Type Data Type
id

The app ID

 path string (uuid) required
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 members

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

Properties

content: object[]
Array of AppMember

404 Not Found

The app did not exist, or the user was not a member of it

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/apps/{id}/model-schema

Get the model schema of an app

Get the model schema, which is the description of the scenario data model.

Request Parameters

Name Description Type Data Type
id

The app ID

 path string (uuid) required

Responses

200 OK

The app model schema

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

ModelSchema

404 Not Found

The app did not exist, or the user was not a member of it

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"
    }
}

App: object

This object represents one app in the system. See the wider product documentation for an explanation of what an app is used for.

Properties

customScenarioTypes: boolean

Whether this app defines custom scenario types. False if the only scenario type is the default SCENARIO.

executionModes: object

The app's execution modes, mapped by name

ExecutionMode
executionResourceGroups: object

The app's execution resource groups, mapped by name

ExecutionResourceGroup
helpUrl: string (uri)

The URL of this app's help documentation. This can either be a path relative to client resources or an absolute URL.

Example: 
"help.html"
id: string (uuid)

The ID of this app

Example: 
"00007eff-83f9-05fe-ffff-81007c05fc01"
managed: boolean

Whether this app is managed by insight and therefore cannot be deleted, upgraded, renamed or exported by an end user

Example: 
true
mirrorDefined: boolean

Whether a mirror has been defined within the companion file for this app

Example: 
true
model:

Additional attributes of the main model

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 }
path: string

The path within the repository

Example: 
"/app-name"
scenarioTypes: object

The app's scenario types, mapped by type ID

ScenarioType
url: string (uri)

The URL of this app

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

AppCreationResponse: object

Properties

app:

The newly created app

messages: string[]

Information messages about the app creation which can be displayed to a user

Example: 
[
    "An execution service referred to by this app does not exist"
]
Array of string
url: string (uri)

The URL of newly created app

AppMember: object

A user who has access to the app.

Properties

authorities: string[]

The authorities granted to this app member

Array of string
authorityGroups: object[]

The authority groups granted to this app member

Array of ReferenceAuthorityGroup
firstName: string

This app member's first name

Example: 
"William"
id: string (uuid)

The ID of this app member

Example: 
"fd7ea4ed-4ec9-db28-0281-5b12b60a3a40"
lastName: string

This app member's last name

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

This app member's name

Example: 
"William Sweet"
objectType: string , one of { APP_MEMBER }
url: string (uri)

The URL of this app member

Example: 
"/api/admin/users/fd7ea4ed-4ec9-db28-0281-5b12b60a3a40"

AppModel: object

Properties

dataVersion: integer (int32)

The model data version

Example: 
2
name: string

The model name

Example: 
"My Insight App"
version: string

The model version

Example: 
"1.0.0"

AppUpgradeRequest: object

Used to provide options affecting how an upgrade request is treated. This object is now deprecated. See UpgradeRequest for updated usage.

Properties

upgradeType: string , one of { FULL , PARTIAL (default) }

Whether the upgrade app file should be considered to represent the full app or a partial. A full upgrade will replace the existing app with the app being uploaded, deleting any existing app content that is not in the app being uploaded. A partial upgrade will add and/or replace content in the existing app.

Example: 
"PARTIAL"
validateModelName: boolean true

Whether to validate that the new model name matches the previous model name

Example: 
true

AppUpgradeResponse: object

This object is now deprecated. See Upgrade for updated usage.

Properties

messages: string[]

The messages describing the result of the upgrade

Array of string
url: string (uri)

The URL of the upgraded app

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

ExecutionMode: object

A standard or custom mode by which a job is executed which provides additional control by either altering the code path of the model itself or routing the job to particular execution services

Properties

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

ExecutionResourceGroup: object

A group which defines the resources (memory and threads) used by execution modes which reference this group. Each group defines the minimum, default and current values for threads and memory.

Properties

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

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."

ModelEntity: object

Represents one data entity and its attributes in the data schema of the app.

Properties

abbreviatedName: string

The abbreviated name of this entity

alias: string

The alias of this entity

alwaysHidden: boolean

Indicates whether this entity is always hidden

constant: boolean

Indicates whether this entity is a constant

dataType: string , one of { UNSUPPORTED , BOOLEAN , INTEGER , REAL , STRING , SET , ARRAY , DECISION_VARIABLE , CONSTRAINT , MODEL , CONSTRAINT_TYPE , VARIABLE_TYPE , PROBLEM_STATUS }

The data type of this entity

elementType: string , one of { UNSUPPORTED , BOOLEAN , INTEGER , REAL , STRING , SET , ARRAY , DECISION_VARIABLE , CONSTRAINT , MODEL , CONSTRAINT_TYPE , VARIABLE_TYPE , PROBLEM_STATUS }

The type of elements this array or set contains

format: string

The formatting of this entity

hidden: boolean

Indicates whether this entity is hidden

indexGrouping: boolean

Indicates whether this entity is used to group an index

indexGroupings: string[]

The index groupings for this set

Array of string
indexSets: string[]

The name of the index sets that index this array

Array of string
labelsEntity: boolean

Indicates whether this entity is used as the labels for another entity

labelsEntityName: string

The name of the entity that holds the labels for this entity

managementType: string , one of { DEFAULT , INPUT , RESULT , IGNORE }

Indicates whether entity is part of the input or the results data

name: string

The name of this entity

updateStrategy: string , one of { DEFAULT , AFTER_EXECUTION , PROGRESS }

The update strategy of this entity

ModelSchema: object

The data schema of the scenarios in the app, derived from the model.

Properties

app:

The app that owns this schema

entities: object

The entities defined by this schema, keyed by entity name

ModelEntity
id: string (uuid)

The ID of this model schema

Example: 
"0d7ff026-ea2a-ad58-f280-0fd8ef21fb11"
name: string (1 to 255 chars) , must match ^[^\p{Cntrl}]*$ & ^\S(?:[\s\S]*\S)?$

The name of this model schema

Example: 
"My model schema"
objectType: string , one of { MODEL_SCHEMA }
url: string (uri)

The URL of this model schema

Example: 
"/api/apps/0d7ff026-ea2a-ad58-f280-0fd8ef21fb11/model-schema"

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"

ReferenceAuthorityGroup: object

The basic details of an authority group

Properties

id: string (uuid)

The ID of this authority group

Example: 
"e41f940c-f974-b034-1be0-6bf33086fd89"
name: string (1 to 255 chars) , must match ^[^\p{Cntrl}]*$ & ^\S(?:[\s\S]*\S)?$

The name of this authority group

Example: 
"My authority group"
objectType: string , one of { AUTHORITY_GROUP }
url: string (uri)

The URL of this authority group

Example: 
"/api/admin/authority-groups/e41f940c-f974-b034-1be0-6bf33086fd89"

ScenarioType: object

Defines a custom scenario type. See the wider product documentation for an explanation of what a custom scenario type is used for.

Properties

icons:

Overrides for icons which can be used to customise the appearance of this scenario type

id: string

The unique ID of this scenario type

Example: 
"SCENARIO"
name: string

The display name of this scenario type

Example: 
"Scenario"
operations:

Operations that can be performed on this scenario type and whether they are enabled (true) or disabled (false)

style:

A map of CSS style properties to values which can be used to customise the appearance of this scenario type

ScenarioTypeIcons: object

Icon overrides for customising the appearance of a scenario type

Properties

executed: string

The icon to display when the scenario is executed

Example: 
"icons/my-custom-executed-icon.png"
executedHover: string

The icon to display when the scenario is executed and the mouse is hovering over the icon

Example: 
"icons/my-custom-executed-on-hover-icon.png"
loaded: string

The icon to display when the scenario is loaded

Example: 
"icons/my-custom-loaded-icon.png"
loadedHover: string

The icon to display when the scenario is loaded and the mouse is hovering over the icon

Example: 
"icons/my-custom-loaded-on-hover-icon.png"
unloaded: string

The icon to display when the scenario is unloaded

Example: 
"icons/my-custom-unloaded-icon.png"
unloadedHover: string

The icon to display when the scenario is unloaded and the mouse is hovering over the icon

Example: 
"icons/my-custom-unloaded-on-hover-icon.png"

ScenarioTypeOperation: object

Defines the operations that a user is allowed to perform on a scenario of this custom scenario type via the user interface.

Properties

attachments: boolean

Viewing the attachments of the scenario (through the attachments dialog)

clone: boolean

Cloning the scenario

create: boolean

Creating a scenario of a certain type

delete: boolean

Deleting the scenario

drag: boolean

Dragging the scenario to a different shelf location

export: boolean

Exporting the scenario

load: boolean

Loading the scenario

location: boolean

Changing the location of the scenario

owner: boolean

Changing the owner of the scenario

properties: boolean

Viewing the properties of the scenario

rename: boolean

Changing the name of the scenario

run: boolean

Running the scenario

runLog: boolean

Viewing the run log of the scenario

select: boolean

Selecting and deselecting the scenario from the shelf

share: boolean

Changing the share status of the scenario

ScenarioTypeStyle: object

Style overrides for customising the appearance of a scenario of this scenario type when rendered on the user interface

Properties

activeBackgroundColor: string

Background color of the pill when the scenario is active

Example: 
"rgba(255,255,255,0)"
borderColor: string

Color of the pill border

Example: 
"#A4A4A4"
inactiveBackgroundColor: string

Background color of the pill when the scenario is inactive

Example: 
"rgba(255,255,255,0)"
textColor: string

Color of the text within the pill

Example: 
"#FFFFFF"
textColorHover: string

Color of the text within the pill when the mouse is hovering over the pill

Example: 
"#FFFFFF"

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-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.