Initializing help system before first use

Jobs Operations

insightapi2~cancel_job
Cancel a job by ID.
insightapi2~cancel_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.
insightapi2~create_job
Create a job for a scenario.
insightapi2~get_app_message_file
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.
insightapi2~get_job
Get a job by ID.
insightapi2~get_job_metrics
Get the metrics that are generated for a job while it is going through the execution process.
insightapi2~get_job_run_log
Get the contents of the run log for a job. The current user must have read access for the provided job.
insightapi2~get_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.
insightapi2~query_jobs
Get all jobs that match the provided query. Only jobs for scenarios that are visible to the current user will be returned.
insightapi2~send_message_to_job
Send a custom message to the job.
Covered Topics
Parent Topic Insight REST API client

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