Initializing help system before first use

Querying the Job Execution Status

You can send a request to return the details of a submitted job.

The details include the original request configuration, the current execution status and URLs to retrieve the results/log.

Send a GET request to the following endpoint: 
https://<INSIGHTURL>/api/compute-jobs/[computeJobId]
Example response 
{
  "id": "myId",
  "objectType": "COMPUTE_JOB",
  "computeJobType": "SOLVER",
  "url": "/path/to/job",
  "app": {
    "objectType": "APP",
    "id": "23f5ac9c-24b9-4cf2-9a47-880c195ea854",
    "url": "/api/apps/23f5ac9c-24b9-4cf2-9a47-880c195ea854",
    "name": "My app"
  },
  "scenario": {
    "objectType": "SCENARIO",
    "id": "99612136-8dd0-4869-93ff-6a91e0be5796",
    "url": "/api/scenarios/99612136-8dd0-4869-93ff-6a91e0be5796",
    "name": "My scenario"
  },
  "owner": {
    "id": "5ab6f1b7-a167-4bf5-992b-2963a2ef4745",
    "name": "My user",
    "objectType": "USER",
    "url": "/api/admin/users/5ab6f1b7-a167-4bf5-992b-2963a2ef4745"
  },
  "dependency": "my attachment.zip",
  "runLogMessages": true,
  "execution": {
    "executionService": "SECONDARY",
    "threads": 2,
    "priority": 10
  },
  "solver": {
    "action": "OPTIMIZE",
    "problemType": "MIP",
    "flags": [],
    "controls": {
      "control1": 1234
    },
    "resultsToInclude": [
      "SOLUTION",
      "ATTRIBUTES"
    ],
    "callbacks": []
  },
  "status": "COMPLETED",
  "modelStatus": "OK",
  "payloadUrl": "/path/to/payload/attachment",
  "resultUrl": "/path/to/results/attachment",
  "runLogUrl": "/path/to/runlog",
  "jobMetricsUrl": "/path/to/metrics"
}

The JSON response contains the original job request properties, information about the job's scenario and project (compute interface app) ancestors, the status of the job and URLs to retrieve files relevant to the job including job submission payload, result files and the run log file.

Job Status

The status property of the GET response can take one of the following values:
  • QUEUED: Job is waiting in the queue for an available worker.
  • EXECUTING: Job is executing on a worker.
  • COMPLETING: Job has finished executing and results are being processed by the server.
  • CANCELLING: Job is in the process of being cancelled.
  • DELETING: Job is in the process of being deleted.
  • COMPLETED: Job has completed with no errors.
  • CANCELLED: Job was cancelled.
  • DELETED: Job was deleted.
  • FAILED: Job has completed with errors.
A client that is using polling rather than progress notifications to determine when the job has finished would typically begin polling for status once the job has been successfully submitted and stop polling on one of the following finish states:
  • COMPLETED
  • CANCELLED
  • DELETED
  • FAILED
Parent Topic Compute Interface REST API

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