xpressinsight.scenario.InsightRestClient
Allows interaction with an Insight v5 server through its REST API. Supports a commonly-used subset of the Insight 5 REST API operations, allowing a Python script to create, update, and delete apps, folders and scenarios; to read and write entity data; to access and update scenario and app attachments, as well as to execute scenarios.
InsightRestClient can be used both inside and outside Insight apps. When used within an Insight scenario, there is no relationship between the calls made through xpressinsight.scenario and the currently running scenario (any reads or writes behave as though they came from outside the scenario).
class xpressinsight.scenario.InsightRestClient(AbstractContextManager)
>>> with ins.InsightRestClient(insight_url='http://localhost:8080/') as client:
... user = client.get_user('570b9100-46e3-4643-baee-2e24aa538f25')
... print(f'Found user {user.name} <{user.email}>')
>>> with self.insight.get_rest_client() as client:
... user = client.get_user('570b9100-46e3-4643-baee-2e24aa538f25')
... print(f'Found user {user.name} <{user.email}>')
scenario.InsightRestClient.__init__,
scenario.InsightRestClient.cancel_scenario_execution,
scenario.InsightRestClient.clone_scenario,
scenario.InsightRestClient.create_app,
scenario.InsightRestClient.create_folder,
scenario.InsightRestClient.create_scenario,
scenario.InsightRestClient.delete_app,
scenario.InsightRestClient.delete_app_attachment,
scenario.InsightRestClient.delete_folder,
scenario.InsightRestClient.delete_scenario,
scenario.InsightRestClient.delete_scenario_attachment,
scenario.InsightRestClient.execute_scenario,
scenario.InsightRestClient.get_all_app_attachment_info,
scenario.InsightRestClient.get_all_apps,
scenario.InsightRestClient.get_all_scenario_attachment_info,
scenario.InsightRestClient.get_app,
scenario.InsightRestClient.get_app_attachment,
scenario.InsightRestClient.get_app_attachment_info,
scenario.InsightRestClient.get_app_members,
scenario.InsightRestClient.get_attachment_tags,
scenario.InsightRestClient.get_children,
scenario.InsightRestClient.get_folder,
scenario.InsightRestClient.get_item_by_path,
scenario.InsightRestClient.get_scenario,
scenario.InsightRestClient.get_scenario_attachment,
scenario.InsightRestClient.get_scenario_attachment_info,
scenario.InsightRestClient.get_scenario_data,
scenario.InsightRestClient.get_scenario_run_log,
scenario.InsightRestClient.get_user,
scenario.InsightRestClient.is_scenario_executing,
scenario.InsightRestClient.move_folder,
scenario.InsightRestClient.move_scenario,
scenario.InsightRestClient.put_app_attachment,
scenario.InsightRestClient.put_scenario_attachment,
scenario.InsightRestClient.rename_folder,
scenario.InsightRestClient.rename_scenario,
scenario.InsightRestClient.set_app_attachment_info,
scenario.InsightRestClient.set_folder_owner,
scenario.InsightRestClient.set_folder_share_status,
scenario.InsightRestClient.set_scenario_attachment_info,
scenario.InsightRestClient.set_scenario_owner,
scenario.InsightRestClient.set_scenario_share_status,
scenario.InsightRestClient.update_scenario_data,
scenario.InsightRestClient.upgrade_app,
scenario.InsightRestClient.wait_for_scenario
© 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.