Initializing help system before first use

xpressinsight.scenario.InsightRestClient.get_folder

Purpose
Get the scenario record for the folder with the given ID.
Synopsis
xpressinsight.scenario.InsightRestClient.get_folder(self, folder_id: str) -> Folder
Argument
folder_id 
The ID of the folder to query.
Return value

Information about the folder with the requested ID.

This function may raise the following errors:

  scenario.ItemNotFoundError

If there is no folder with this ID, 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:
...     folder = client.get_folder('570b9100-46e3-4643-baee-2e24aa538f25')
...     print(f'Found folder {folder.name} with path {folder.path}')
Related topics
scenario.Folder

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.