Initializing help system before first use

App resources

Operation Description
GET /api/apps

Get all apps
GET /api/apps/{appId}

Get 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

PageOfApp

GET /api/apps/{appId}

Get an app

Get an app by ID.

Request Parameters

Name Description Type Data Type
appId

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

Example: 
false
executionModes: object

The app's execution modes, mapped by name

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

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"

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"
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
threads: integer (int32)

The number of threads that this execution mode uses, or null for unlimited

Example: 
1

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

PageOfApp: 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 App
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

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)

Example: 
false
clone: boolean

Cloning the scenario

Example: 
false
create: boolean

Creating a scenario of a certain type

Example: 
false
delete: boolean

Deleting the scenario

Example: 
false
drag: boolean

Dragging the scenario to a different shelf location

Example: 
false
export: boolean

Exporting the scenario

Example: 
false
load: boolean

Loading the scenario

Example: 
false
location: boolean

Changing the location of the scenario

Example: 
false
owner: boolean

Changing the owner of the scenario

Example: 
false
properties: boolean

Viewing the properties of the scenario

Example: 
false
rename: boolean

Changing the name of the scenario

Example: 
false
run: boolean

Running the scenario

Example: 
false
runLog: boolean

Viewing the run log of the scenario

Example: 
false
select: boolean

Selecting and deselecting the scenario from the shelf

Example: 
false
share: boolean

Changing the share status of the scenario

Example: 
false

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

Example: 
false
sorted: boolean

True if the results are sorted

Example: 
false
unsorted: boolean

True if the results are not sorted

Example: 
false
Parent Topic Insight 5 REST API

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