Initializing help system before first use

xpressinsight.scenario.InsightRestClient.get_children

Purpose
Get the folders and scenarios that are the immediate children of the given folder or app.
Synopsis
xpressinsight.scenario.InsightRestClient.get_children(self, parent: Reference) -> Sequence[Union[Scenario, Folder]]
Argument
parent 
A Reference of type FOLDER or APP.
Return value

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:
...     APP_ID = '570b9100-46e3-4643-baee-2e24aa538f25'
...     children = client.get_children(Reference.to_app(APP_ID)
...     for child in children:
...         if isinstance(child, ins.Folder):
...             print(f'Found folder {child.name}')
...         else:
...             print(f'Found scenario {child.name}')
Further information
1. The method get_children is part of the class xpressinsight.scenario.InsightRestClient.
2. Pass a reference to a Folder to return the scenarios and immediate subfolders of that folder. Pass a reference to an App to return the scenarios and folders in the application root.
Related topics
scenario.Folder,
scenario.Reference,
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.