Initializing help system before first use

xpressinsight.scenario.InsightRestClient.create_folder

Purpose
Create a new folder within an app.
Synopsis
xpressinsight.scenario.InsightRestClient.create_folder(self, name: str, parent: Reference) -> Folder
Arguments
name 
The desired name for the folder. A suffix is applied to ensure the name is unique among its siblings.
parent 
A Reference of type FOLDER containing the ID of the folder in which to create the folder, or a reference of type APP containing the app ID if the folder is to be created in the app root.
Return value

Information about the newly-created folder.

This function may raise the following errors:

  scenario.InsightServerError

If the folder could not be created in the requested location, the REST client credentials do not have permission to perform this operation, or there is an issue communicating with the Insight server.

Example 
>>> with ins.InsightRestClient(insight_url='http://localhost:8080/') as client:
...     PARENT_ID = '570b9100-46e3-4643-baee-2e24aa538f25'
...     folder = client.create_folder(name='My New Folder',
...         parent=Reference.to_folder(PARENT_ID))
...     print(f'Created folder with ID {folder.id}')
Further information
The method create_folder is part of the class xpressinsight.scenario.InsightRestClient.
Related topics
scenario.Folder,
scenario.Reference

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.