Projects Export File Format - Revision history

TeeHiet: TK-63223

2026-03-31T11:32:37Z

TK-63223

← Older revision		Revision as of 11:32, 31 March 2026
Line 22:		Line 22:
	=== Model ===		=== Model ===
	Model objects has following properties:		Model objects has following properties:
	* '''Name''' (String): Model name. (~~required~~)		* '''Name''' (String): Model name. (Required)
	* '''Description''' (String): Model description text.		* '''Description''' (String): Model description text.
	* '''Configuration''' (Object): Model configuration object.		* '''Configuration''' (Object): Model configuration object.
	* '''Attributes''' (ModelAttribute*): Array of [[#Model_attribute\|model attribute]] objects describing the model's attributes.		* '''Attributes''' (ModelAttribute*): Array of [[#Model_attribute\|model attribute]] objects describing the model's attributes.
			* '''Filters''' (Array): An array of objects, each representing a model filter with:
			** '''Name''' (String): Filter name. (Required)
			** '''Description''' (String): Description of the filter.
			** '''PublishMode''' (String): The filter publishing mode. Possible modes are '''Default''' and '''Public'''. Note that only one filter in the model can be default. (Required)
			** '''Rules''' (Object): An object representing filter rules.

	=== Model attribute ===		=== Model attribute ===

2025-05-10T17:11:44Z

Examples

← Older revision		Revision as of 17:11, 10 May 2025
Line 49:		Line 49:

	== Examples ==		== Examples ==
			Project connected to a Snowflake database and schema, and project doesn't have any content:
	<syntaxhighlight lang="json" line>		<syntaxhighlight lang="json" line>
	{		{

2025-05-10T17:08:07Z

Examples

← Older revision		Revision as of 17:08, 10 May 2025
Line 51:		Line 51:
	<syntaxhighlight lang="json" line>		<syntaxhighlight lang="json" line>
	{		{
	"Projects": [		"Projects": [
	{		{
	"Name": "My project",		"Name": "My project",
	"Configuration": {		"Configuration": {
	"DefaultLocationInDataSource": {		"DefaultLocationInDataSource": {
	"Database": "My Snowflake database",		"Database": "My Snowflake database",
	"Schema": "My Snowflake schema"		"Schema": "My Snowflake schema"
	}		}
	},		},
	"DataTables": [],		"DataTables": [],
	"Models": [],		"Models": [],
	"Dashboards": [],		"Dashboards": [],
	"Scripts": []		"Scripts": []
	}		}
	]		]
	}		}
	</syntaxhighlight>		</syntaxhighlight>

2025-05-10T17:07:45Z

Examples

← Older revision		Revision as of 17:07, 10 May 2025
Line 49:		Line 49:

	== Examples ==		== Examples ==
	<syntaxhighlight lang="~~typescript~~" line>		<syntaxhighlight lang="json" line>
	{		{
	"Projects": [		"Projects": [
	{		{
	"Name": "~~Another Snowflake schema~~",		"Name": "My project",
	"Configuration": {		"Configuration": {
	"DefaultLocationInDataSource": {		"DefaultLocationInDataSource": {

2025-05-10T17:07:33Z

Examples

@@ Line 50: / Line 50: @@
 == Examples ==
 <syntaxhighlight lang="typescript" line>
+{
 </syntaxhighlight>

2025-05-10T17:05:53Z

Project

← Older revision		Revision as of 17:05, 10 May 2025
Line 9:		Line 9:
	* '''Description''' (String): Project description text.		* '''Description''' (String): Project description text.
	* '''Configuration''' (Object): Project configuration object.		* '''Configuration''' (Object): Project configuration object.
	* '''~~Datatables~~''' (Datatable*): Array of [[#Datatable\|datatable]] objects for the project's datatables.		* '''DataTables''' (Datatable*): Array of [[#Datatable\|datatable]] objects for the project's datatables.
	* '''Models''' (Model*): Array of [[#Model\|nodel]] objects for the project's models.		* '''Models''' (Model*): Array of [[#Model\|nodel]] objects for the project's models.
	* '''Dashboards''' (Dashboard*): Array of [[#Dashboard\|dashboard]] objects for the project's dashboards.		* '''Dashboards''' (Dashboard*): Array of [[#Dashboard\|dashboard]] objects for the project's dashboards.

2025-05-10T17:03:51Z

Project

← Older revision		Revision as of 17:03, 10 May 2025
Line 9:		Line 9:
	* '''Description''' (String): Project description text.		* '''Description''' (String): Project description text.
	* '''Configuration''' (Object): Project configuration object.		* '''Configuration''' (Object): Project configuration object.
	* '''Datatables''' (Datatable*): Array of [[#Datatable\|datatable]] objects ~~describing~~ the project's datatables.		* '''Datatables''' (Datatable*): Array of [[#Datatable\|datatable]] objects for the project's datatables.
	* '''Models''' (Model*): Array of [[#Model\|nodel]] objects ~~describing~~ the project's models.		* '''Models''' (Model*): Array of [[#Model\|nodel]] objects for the project's models.
	* '''Dashboards''' (Dashboard*): Array of [[#Dashboard\|dashboard]] objects ~~describing~~ the project's dashboards.		* '''Dashboards''' (Dashboard*): Array of [[#Dashboard\|dashboard]] objects for the project's dashboards.
	* '''Scripts''' (Script*): Array of [[#Script\|script]] objects ~~describing~~ the project's scripts.		* '''Scripts''' (Script*): Array of [[#Script\|script]] objects for the project's scripts.

	=== Datatable ===		=== Datatable ===

2025-05-10T17:03:30Z

Project

← Older revision		Revision as of 17:03, 10 May 2025
Line 5:		Line 5:

	=== Project ===		=== Project ===
	~~The~~ Project objects have following properties:		Project objects have following properties:
	* '''Name''' (String): ~~String representing the project~~ name. (Required)		* '''Name''' (String): Project name. (Required)
	* '''Description''' (String): ~~String describing the project~~.		* '''Description''' (String): Project description text.
	* '''Configuration''' (Object): Project configuration object.		* '''Configuration''' (Object): Project configuration object.
	* '''Datatables''' (Datatable*): Array of [[#Datatable\|datatable]] objects describing the project's datatables.		* '''Datatables''' (Datatable*): Array of [[#Datatable\|datatable]] objects describing the project's datatables.

2025-05-10T17:02:50Z

Specification

← Older revision		Revision as of 17:02, 10 May 2025
Line 2:		Line 2:

	== Specification ==		== Specification ==
	The project file format is a UTF-8 formatted text file containing json. The topmost level is a json object with '''Projects''' property containing an array of [[Project\|~~#Project~~]] objects:		The project file format is a UTF-8 formatted text file containing json. The topmost level is a json object with '''Projects''' property containing an array of [[#Project\|project]] objects:

	=== Project ===		=== Project ===

2025-05-10T17:02:38Z

← Older revision		Revision as of 17:02, 10 May 2025
Line 1:		Line 1:
	This ~~article~~ describes the projects export file format (file extension .json).		This page describes the projects export file format (file extension .json). Projects can be exported and imported using this file format.

	== ~~Spec~~ ==		== Specification ==
	The ~~outmost~~ level is a json object with '''~~Project~~''' property containing array of [[Project\|#Project]] objects:		The project file format is a UTF-8 formatted text file containing json. The topmost level is a json object with '''Projects''' property containing an array of [[Project\|#Project]] objects:

	=== Project ===		=== Project ===