Initializing help system before first use

insightapi2~get_jobs

Purpose
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.
Synopsis
function get_jobs(client:insightapi2~insightconfig, req:insightapi2~httprequest, resp:insightapi2~httpresponse):insightapi2~page_of_job
function get_jobs(client:insightapi2~insightconfig, page:integer, scenario_id:text, size:integer, include_finished:boolean, resp:insightapi2~httpresponse):insightapi2~page_of_job
function get_jobs(client:insightapi2~insightconfig, page:integer, scenario_id:text, size:integer, include_finished:boolean):insightapi2~page_of_job
Arguments
client 
An initialized insightapi2~insightconfig to call
req 
An initialized insightapi2~httprequest record. The params field may contain these indexes:
page 
Number of the page, starting at zero
scenarioId 
The scenario ID
size 
Number of elements per page
includeFinished 
Whether to include jobs that have finished
page 
Number of the page, starting at zero
scenario_id 
The scenario ID
size 
Number of elements per page
include_finished 
Whether to include jobs that have finished
resp 
A insightapi2~httpresponse record into which will be written a description of the response
Return value
The response body of the request, if it was of type insightapi2~page_of_job
Further information
1. Use the status field of the resp record to distinguish between different status codes returned by the operation, or the success attribute to check for 2xx status codes. If the resp record is not passed to this function, the model will abort with a runtime error if the response's status code does not indicate success. The expected responses from this operation are:
HTTP Status Code Response body type Description
200 insightapi2~page_of_job The page of jobs

2. If the response body could be read into a Mosel variable, it would be written to the body field of the resp record (and also returned from this function if it was a insightapi2~page_of_job), and the bodyfilename field of the resp record will be an empty string.
3. If the bodyfilename field of the resp record is set to a non-empty value on return, this will be a file containing the response body; the caller is responsible for deleting this file when it is no longer required.
Related topics
insightapi2~page_of_job
insightapi2~insightconfig
insightapi2~httprequest
insightapi2~httpresponse

Parent Topic Jobs Operations

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