Projects Export File Format: Difference between revisions
Jump to navigation
Jump to search
(Created page with "This article describes the projects export file format (file extension .json). == Spec == The outmost level is a json object with '''Project''' property containing array of #Project objects: === Project === The Project objects have following properties: ** '''Name''' (String): String representing the project name. (Required) ** '''Description''' (String): String describing the project. ** '''Configuration''' (Object): Project configuration object. === Data...") |
No edit summary |
||
| Line 6: | Line 6: | ||
=== Project === | === Project === | ||
The Project objects have following properties: | The Project objects have following properties: | ||
* '''Name''' (String): String representing the project name. (Required) | |||
* '''Description''' (String): String describing the project. | |||
* '''Configuration''' (Object): Project configuration object. | |||
* '''Datatables''' (Datatable*): Array of [[datatable|#Datatable]] objects describing the project's datatables. | |||
* '''Models''' (Model*): Array of [[model|#Model]] objects describing the project's models. | |||
* '''Dashboards''' (Dashboard*): Array of [[dashboard|#Dashboard]] objects describing the project's dashboards. | |||
* '''Scripts''' (Script*): Array of [[script|#Script]] objects describing the project's scripts. | |||
=== Datatable === | === Datatable === | ||
Datatable objects has following properties: | Datatable objects has following properties: | ||
* '''Name''' (String): Datatble name. (required) | |||
* '''Description''' (String): Datatable description text. | |||
* '''Configuration''' (Object): Datatable configuration object. | |||
=== Model === | === Model === | ||
Model objects has following properties: | Model objects has following properties: | ||
* '''Name''' (String): Model name. (required) | |||
* '''Description''' (String): Model description text. | |||
* '''Configuration''' (Object): Model configuration object. | |||
* '''Attributes''' (Object*): Array of [[model attribute|#Model_attribute]] objects describing the model's attributes. | |||
=== Model attribute === | === Model attribute === | ||
Model attribute objects has following properties: | Model attribute objects has following properties: | ||
* '''Type''': String representing the attribute type. Supported value: '''Diagram'''. | |||
* '''Name''': String representing the attribute name. (required) | |||
* '''Description''': String describing the attribute. | |||
* '''Content''': String representing the attribute content. (required) | |||
=== Dashboard === | === Dashboard === | ||
Dashboard objects has following properties: | Dashboard objects has following properties: | ||
* '''Name''' (String): Dashboard name. (required) | |||
* '''Description''' (String): Dashboard description text. | |||
* '''Identifier''' (String): Dashboard identifier. | |||
* '''Content''' (Object): Dashboard content as object. (required) | |||
=== Script === | === Script === | ||
Script objects has following properties: | Script objects has following properties: | ||
* '''Name''' (String): Script name. (required) | |||
* '''Description''' (String): Script description text. | |||
* '''Code''' (String): Script code. | |||
* '''Language''' (String): Script language, either '''Expression''' or '''SQL'''. (required) | |||
== Examples == | == Examples == | ||
<syntaxhighlight lang="typescript" line> | |||
let result = ScriptById(123).Run(#{ | |||
"parameter1": "value1", | |||
"parameter2": false, | |||
"parameter2": 123.45 | |||
}) | |||
</syntaxhighlight> | |||
Revision as of 13:46, 10 May 2025
This article describes the projects export file format (file extension .json).
Spec
The outmost level is a json object with Project property containing array of #Project objects:
Project
The Project objects have following properties:
- Name (String): String representing the project name. (Required)
- Description (String): String describing the project.
- Configuration (Object): Project configuration object.
- Datatables (Datatable*): Array of #Datatable objects describing the project's datatables.
- Models (Model*): Array of #Model objects describing the project's models.
- Dashboards (Dashboard*): Array of #Dashboard objects describing the project's dashboards.
- Scripts (Script*): Array of #Script objects describing the project's scripts.
Datatable
Datatable objects has following properties:
- Name (String): Datatble name. (required)
- Description (String): Datatable description text.
- Configuration (Object): Datatable configuration object.
Model
Model objects has following properties:
- Name (String): Model name. (required)
- Description (String): Model description text.
- Configuration (Object): Model configuration object.
- Attributes (Object*): Array of #Model_attribute objects describing the model's attributes.
Model attribute
Model attribute objects has following properties:
- Type: String representing the attribute type. Supported value: Diagram.
- Name: String representing the attribute name. (required)
- Description: String describing the attribute.
- Content: String representing the attribute content. (required)
Dashboard
Dashboard objects has following properties:
- Name (String): Dashboard name. (required)
- Description (String): Dashboard description text.
- Identifier (String): Dashboard identifier.
- Content (Object): Dashboard content as object. (required)
Script
Script objects has following properties:
- Name (String): Script name. (required)
- Description (String): Script description text.
- Code (String): Script code.
- Language (String): Script language, either Expression or SQL. (required)
Examples
let result = ScriptById(123).Run(#{
"parameter1": "value1",
"parameter2": false,
"parameter2": 123.45
})