Initializing help system before first use

xpressinsight.scenario.InsightRestClient.get_item_by_path

Purpose
Get the scenario, folder, or app record for the given repository path.
Synopsis
xpressinsight.scenario.InsightRestClient.get_item_by_path(self, path: str) -> scenario.App | scenario.Folder | scenario.Scenario
Argument
path 
The repository path to query
Return value

Information about the app, folder, or scenario.

This function may raise the following errors:

  scenario.ItemNotFoundError

If there is nothing at this path, 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 = client.get_item_by_path('/MyApp/MyFolder/MyPath')
...     if not isinstance(scenario, ins.Scenario):
...         raise RuntimeError(f'Expected Scenario, found {type(scenario)}')
...     print(f'Found scenario {scenario.id} at path {scenario.path}')
Further information
The method get_item_by_path is part of the class xpressinsight.scenario.InsightRestClient.
Related topics
scenario.App,
scenario.Folder,
scenario.Scenario

Parent Topic The InsightRestClient classes

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