Initializing help system before first use

xpressinsight.scenario.InsightRestClient.get_scenario_run_log

Purpose
Get the run log captured during the completed scenario execution.
Synopsis
xpressinsight.scenario.InsightRestClient.get_scenario_run_log(self, scenario_id: str) -> str
Argument
scenario_id 
The ID of the scenario to query.
Return value

The full run log of the scenario

This function may raise the following errors:

  scenario.ItemNotFoundError

If there is no scenario with this ID, or it did not have a completed run log, or the REST API client credentials do not have permission to access it.

  scenario.InsightServerError

If there is an issue communicating with the Insight server.

Example 
>>> with ins.InsightRestClient(insight_url='http://localhost:8080/') as client:
...     SCENARIO_ID = '570b9100-46e3-4643-baee-2e24aa538f25'
...     run_log = client.get_scenario_run_log(SCENARIO_ID)
...     print(run_log)
Further information
This function cannot be used to read the run log of a currently executing scenario.

Parent Topic The InsightRestClient classes

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