Initializing help system before first use

Scenario resources

Operation Description
GET /api/scenarios/{id}/job-metrics

Get the job metrics
GET /api/scenarios/{id}/run-log

Get the scenario run log

GET /api/scenarios/{id}/job-metrics

Get the job metrics

Get the job metrics generated for the last execution of this scenario.

Request Parameters

Name Description Type Data Type
id

The scenario ID

 path string (uuid) required

Responses

200 OK

The requested job metrics

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

JobMetrics

404 Not Found

The scenario 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/scenarios/{id}/run-log

Get the scenario run log

The run log is generated by the job during execution and captured against the scenario when execution completes.

Request Parameters

Name Description Type Data Type
id

The scenario ID

 path string (uuid) required

Responses

200 OK

The requested run log

Content-Type text/vnd.com.fico.xpress.insight.v2+plain

string (binary)

404 Not Found

The scenario did not exist or was unavailable to the current user or there was no completed run log

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"
    }
}
Content-Type text/vnd.com.fico.xpress.insight.v2+plain

Empty response body

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

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

JobMetrics: object

Metrics for a job that is either executing or has completed execution. Job metrics consist of 3 distinct stages that a job progresses through in order to complete execution.

Properties

duration: integer (int64)

The current duration of this job

execution:

The execution stage

queued:

The queued stage

started: string (date-time)

When this job started

worker:

The worker stage

JobPhase: object

A phase of a job stage. Each phase may have one or more phase metrics.

Properties

duration: integer (int64)

The current duration of this job phase

metrics: object

This phase's metrics, keyed by name

JobPhaseMetric
name: string

The name of this phase

started: string (date-time)

When this phase started

JobPhaseMetric: object

A metric of a job phase

Properties

count: integer (int32)

The count of this phase metric

dataSize: integer (int64)

The size of this phase metric

duration: integer (int64)

The current duration of this job phase metric

name: string

The name of this phase metric

started: string (date-time)

When this phase metric started

JobStage: object

A stage of a job metric. A stage is sub-divided into phases.

Properties

duration: integer (int64)

The current duration of this job stage

name: string

The name of this job stage

phases: object[]

This stage's phases

Array of JobPhase
started: string (date-time)

When this stage started

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"
Parent Topic Insight 5 REST API

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