Initializing help system before first use

# Job resources

Operation | Description
--- | ---
DELETE /api/jobs | Cancel multiple jobs
GET /api/jobs | Get all jobs
POST /api/jobs | Create a new job
POST /api/jobs/query | Get jobs matching a query
DELETE /api/jobs/{id} | Cancel a job
GET /api/jobs/{id} | Get a job
GET /api/jobs/{id}/job-metrics | Get the metrics for a job
POST /api/jobs/{id}/messages | Send a message to a job
GET /api/jobs/{id}/run-log | Get the run log for a job
GET /api/jobs/{jobId}/messages/{appMessageId}/file | Get the message file for a job

# DELETE /api/jobs

Cancel multiple jobs

Cancel all jobs, all jobs owned by the current user, or all jobs for a given scenario.

If a provided owner ID matches the current user, all jobs owned by that user will be cancelled.

If a scenario ID is provided, the job belonging to that scenario will be cancelled.

If neither owner nor scenario ID is provided, all jobs will be cancelled if the current user has sufficient authority to do so.

## Request Parameters

Name | Description | Type | Data Type |
--- | --- | --- | --- | ---
ownerId | The owner ID | query | string (uuid) |
scenarioId | The scenario ID | query | string (uuid) |

## Responses

202 Accepted

  The request to cancel the jobs has been accepted

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

    Empty response body

403 Forbidden

  The user did not have authority to cancel the jobs, or an owner ID was supplied but it did not match the current user, or a scenario ID was supplied but the user did not have authority for that scenario

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

429 Too Many Requests

  The jobs were already being cancelled.

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

    ErrorResponse

  Example:

      {
          "error": {
              "code": "FICO-Platform-Http-429",
              "desc": "Too Many Requests",
              "innerError": {
                  "code": "OPTI-Insight-Locks-AlreadyCancellingJob",
                  "desc": "A cancellation task already exists for this job",
                  "message": "Cannot cancel requested jobs. A cancel jobs task is already in progress."
              },
              "message": "Too Many Requests",
              "parentId": "0000000000000def",
              "spanId": "0000000000000123",
              "timestamp": "1970-01-03T02:01:33.219Z",
              "traceId": "0000000000000abc"
          }
      }

# 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 |
--- | --- | --- | --- | ---
scenarioId | The scenario ID | query | string (uuid) |
includeFinished | Whether to include jobs that have finished | query | boolean |
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 jobs

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

    Page

    ### Properties

    content: object[]
      Array of Job

# POST /api/jobs

Create a new job

Create a job for a scenario.

## Request Body

The job to create

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

  JobCreationRequest

## Responses

201 Created

  The job was successfully created

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

    Job

  Location | The URL of the created resource | string

403 Forbidden

  The user did not have authority to create the job, or did not have authority to execute the compute job on the execution service

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

422 Unprocessable Entity

  The job's execution mode did not exist in its app, or the request was not well-formed. This may be because:

  - The request contains an incorrect object type
  - The app cannot be executed
  - The execution mode did not exist for this scenario's app
  - The attachment tag rules are not met
  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-OutOfBounds",
                  "desc": "Compute scenario can only be executed once",
                  "message": "A compute scenario can only be executed once"
              },
              "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": "Input data not loaded",
                  "message": "Cannot execute scenario: execution mode custom-mode-7 requires the scenario input data to have been loaded first"
              },
              "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 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": "Mandatory attachment tags missing",
                  "message": "Mandatory tags have not been applied to any attachments: [tag1, tag2]"
              },
              "message": "Unprocessable Entity",
              "parentId": "0000000000000def",
              "spanId": "0000000000000123",
              "timestamp": "1970-01-03T02:01:33.219Z",
              "traceId": "0000000000000abc"
          }
      }

423 Locked

  The scenario is already in the job queue

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

    ErrorResponse

  Example:

      {
          "error": {
              "code": "FICO-Platform-Http-423",
              "desc": "Locked",
              "innerError": {
                  "code": "OPTI-Insight-Locks-JobExists",
                  "desc": "Job already exists for scenario",
                  "message": "Scenario is already in the job queue"
              },
              "message": "Locked",
              "parentId": "0000000000000def",
              "spanId": "0000000000000123",
              "timestamp": "1970-01-03T02:01:33.219Z",
              "traceId": "0000000000000abc"
          }
      }

429 Too Many Requests

  There are currently more jobs than the configured maximum

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

    ErrorResponse

  Example:

      {
          "error": {
              "code": "FICO-Platform-Http-429",
              "desc": "Too Many Requests",
              "innerError": {
                  "code": "OPTI-Insight-Validation-TooManyJobs",
                  "desc": "Maximum job queue length cannot be exceeded",
                  "message": "There are currently too many jobs in the queue to submit another one."
              },
              "message": "Too Many Requests",
              "parentId": "0000000000000def",
              "spanId": "0000000000000123",
              "timestamp": "1970-01-03T02:01:33.219Z",
              "traceId": "0000000000000abc"
          }
      }

# POST /api/jobs/query

Get jobs matching a query

Get all jobs that match the provided query. Only jobs for scenarios that are visible to the current user will be returned.

## Request Body

The query to match jobs against

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

  JobQuery

## 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 all visible jobs matching the query

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

    Page

    ### Properties

    content: object[]
      Array of Job

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

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

# GET /api/jobs/{id}/job-metrics

Get the metrics for a job

Get the metrics that are generated for a job while it is going through the execution process.

## Request Parameters

Name | Description | Type | Data Type |
--- | --- | --- | --- | ---
id | The job 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 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",
              "parentId": "0000000000000def",
              "spanId": "0000000000000123",
              "timestamp": "1970-01-03T02:01:33.219Z",
              "traceId": "0000000000000abc"
          }
      }

# POST /api/jobs/{id}/messages

Send a message to a job

Send a custom message to the job.

## Request Body

The job message

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

  JobMessage

## Request Parameters

Name | Description | Type | Data Type |
--- | --- | --- | --- | ---
id | The job ID | path | string (uuid) | required

## Responses

202 Accepted

  The message for the job has been accepted

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

    Empty response body

403 Forbidden

  The user did not have authority to send a message

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

422 Unprocessable Entity

  The request was not well-formed. This may be because:

  - The request contains an incorrect executionId
  - The message is 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"
          }
      }

429 Too Many Requests

  There are currently too many messages waiting to be retrieved from the job

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

    ErrorResponse

  Example:

      {
          "error": {
              "code": "FICO-Platform-Http-429",
              "desc": "Too Many Requests",
              "innerError": {
                  "code": "OPTI-Insight-Validation-TooManyJobMessageRequests",
                  "desc": "Too many job message requests",
                  "message": "There are too many queued job message requests."
              },
              "message": "Too Many Requests",
              "parentId": "0000000000000def",
              "spanId": "0000000000000123",
              "timestamp": "1970-01-03T02:01:33.219Z",
              "traceId": "0000000000000abc"
          }
      }

# GET /api/jobs/{id}/run-log

Get the run log for a job

Get the contents of the run log for a job. The current user must have read access for the provided job.

## Request Parameters

Name | Description | Type | Data Type |
--- | --- | --- | --- | ---
id | The job ID | path | string (uuid) | required

## Responses

200 OK

  The requested run log or a message that it was not available

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

    string (binary)

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

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

    Empty response body

# GET /api/jobs/{jobId}/messages/{appMessageId}/file

Get the message file for a job

Get the message file for a job. This endpoint is now deprecated. Its replacement is within Compute jobs. See "/api/compute-job/{id}/messages/{messageId}/file" for updated usage.

## Request Parameters

Name | Description | Type | Data Type |
--- | --- | --- | --- | ---
jobId | The job ID | path | string (uuid) | required
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+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"
          }
      }

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

    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

  OuterError

# 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

  InnerError
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

  ReferenceApp
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

executionId: string (uuid)

  The current execution ID for this job. This changes if a job is rescheduled and executed again

executionMode:

  The execution mode this job will run in

  ExecutionMode
executionResourceGroup:

  The execution resource group that defines the resources this job will run with

  ExecutionResourceGroup
executionService:

  The execution service for this job

  ReferenceExecutionService
executionWorker:

  The execution worker for this job

  ReferenceExecutionWorker
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 { NA , OK , INSTR , MATHERR , UNKN_PF , UNKN_SYS , PROB , ERROR , EXIT , IOERR , BREAK , NIFCT , NULL , LICERR , STOP , UNKNOWN }

  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

  ReferenceUser
scenario:

  The scenario this job belongs to

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

  The solver status

started: string (date-time)

  When the job was started

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

  The status of this job

  Example:

      "EXECUTING"

url: string (uri)

  The URL of this job state

  Example:

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

# JobCreationRequest: object

A request to create a new job

### Properties

executionMode: string

  The execution mode (standard or user-defined) of the job

  Example:

      "RUN"

scenario:

  The scenario to create the job for

  ReferenceScenario

# JobMessage: object

A message sent from a client to an executing job. Messages are used to send commands to the model.

### Properties

executionId: string (uuid)

  The execution id of the job to send a message to

message: string

  The message to send to the model

# 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

  JobStage
queued:

  The queued stage

  JobStage
started: string (date-time)

  When this job started

worker:

  The worker stage

  JobStage

# 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

# JobQuery: object

### Properties

scenarioIds: string[]

  The IDs of the scenarios to find jobs for

  Example:

      [
          "3b59b9ee-a41d-11eb-bcbc-0242ac130002",
          "42b550e0-a41d-11eb-bcbc-0242ac130002"
      ]

  Array of string (uuid)

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

  InnerError
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

  Sort
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

sorted: boolean

  True if the results are sorted

unsorted: boolean

  True if the results are not sorted

Parent Topic Insight 5 REST API

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