Initializing help system before first use

Job resources

Operation Description
GET /api/jobs

Get all jobs
GET /api/jobs/{id}

Get a job
DELETE /api/jobs/{id}

Cancel a job
GET /api/jobs/{id}/messages/{appMessageId}/file

Get the message file for a job

GET /api/jobs

Get all jobs

Get all jobs. This will include all queued jobs, currently executing jobs and (if requested) those finished jobs currently retained in the job history. If the job scenario is not visible to the user, redacted information will be returned. The jobs can be filtered by scenario ID. When including finished jobs, the filters are not applied to the finished jobs.

Request Parameters

Name Description Type Data Type
page

Number of the page, starting at zero

 query integer (int32)
scenarioId

The scenario ID

 query string (uuid)
size

Number of elements per page

 query integer (int32)
includeFinished

Whether to include jobs that have finished

 query boolean

Responses

200 OK

The page of jobs

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

PageOfJob

GET /api/jobs/{id}

Get a job

Get a job by ID.

Request Parameters

Name Description Type Data Type
id

The job ID

 path string (uuid) required

Responses

200 OK

The job

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

Job

404 Not Found

The job 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",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

DELETE /api/jobs/{id}

Cancel a job

Cancel a job by ID.

Request Parameters

Name Description Type Data Type
id

The job ID

 path string (uuid) required

Responses

202 Accepted

The request to cancel the job has been accepted

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

Job

403 Forbidden

The user did not have authority to cancel the job

404 Not Found

The job 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",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

GET /api/jobs/{id}/messages/{appMessageId}/file

Get the message file for a job

Get the message file for a job.

Request Parameters

Name Description Type Data Type
id

The job ID

 path string (uuid) required
appMessageId

appMessageId

 path string (uuid) required

Responses

200 OK

The file contents

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

string (binary)

404 Not Found

The job or app message did not exist or was unavailable to the current user

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

Empty response body

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

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

Job: object

The state of a job

Properties

app:

The app this job belongs to

created: string (date-time)

When the job was created

duration: integer (int64)

The duration of this job. This is only present when the job is finished

executionAttempts: integer (int32)

The number of attempts to execute this job

Example: 
1
executionMode:

The execution mode this job will run in

executionService:

The execution service for this job

executionWorker:

The execution worker for this job

finished: string (date-time)

When the job was finished

id: string (uuid)

The ID of this job state

Example: 
"0f7acba9-713d-2c50-f085-34565a4d6e61"
modelStatus: string , one of { BREAK , ERROR , EXIT , INSTR , IOERR , LICERR , MATHERR , NA , NIFCT , NULL , OK , PROB , STOP , UNKNOWN , UNKN_PF , UNKN_SYS }

The model status

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

The name of this job state

Example: 
"My job state"
objectType: string , one of { JOB_STATE }
objective: number (double)

The objective

owner:

The user who owns this job

scenario:

The scenario this job belongs to

solverStatus: string , one of { INFEASIBLE , NA , OPTIMAL , OTHER , SOLUTION , UNBOUNDED , UNFINISHED , UNKNOWN }

The solver status

started: string (date-time)

When the job was started

status: string , one of { CANCELLED , CANCELLING , COMPLETED , COMPLETING , DELETED , DELETING , EXECUTING , FAILED , INACTIVE , QUEUED }

The status of this job

Example: 
"EXECUTING"
url: string (uri)

The URL of this job state

Example: 
"/api/jobs/0f7acba9-713d-2c50-f085-34565a4d6e61"

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"

PageOfJob: 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 Job
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"

ReferenceScenario: object

The basic details of a scenario

Properties

id: string (uuid)

The ID of this scenario

Example: 
"003584bb-9e7b-eb70-ffca-7b446118b100"
name: string (1 to 255 chars) , must match ^[^\p{Cntrl}]*$ & ^\S(?:[\s\S]*\S)?$

The name of this scenario

Example: 
"My scenario"
objectType: string , one of { SCENARIO }
url: string (uri)

The URL of this scenario

Example: 
"/api/scenarios/003584bb-9e7b-eb70-ffca-7b446118b100"

ReferenceUser: object

The basic details of a user

Properties

id: string (uuid)

The ID of this user

Example: 
"0013ebae-4d4c-793c-ffec-1451b28ba2f9"
name: string (1 to 255 chars) , must match ^[^\p{Cntrl}]*$ & ^\S(?:[\s\S]*\S)?$

The name of this user

Example: 
"My user"
objectType: string , one of { USER }
url: string (uri)

The URL of this user

Example: 
"/api/admin/users/0013ebae-4d4c-793c-ffec-1451b28ba2f9"

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.