Imports

Use imports to create structure and reuse models.

Core concepts:

Create structure in your models. A large model may become complex. With imports, you can break your model down into smaller parts.
Reuse your models. Some models or parts of it might be reusable. Use imports to import these models into other models.

Syntax

In the syntax we use symbols and colors to communicate the meaning more clearly. We'll explain each symbol and color below. We use data types to let you know which data type is used.

Name	Symbol	Color	Description
Blue		Blue	Data type
Red		Red	Reference
Yellow		Yellow	Function
Cyan		Cyan	Condition
Green		Green	Statement
Grey		Grey	Comment
Ellipsis	`...`		Optional repetition

imports:
  string:
    path: string
    model_id: integer
    version_id: integer

Either


        path


        model_id

is required.

Key	Required	Type	Default	Description
path	No	String	-	The relative path to the file including extension.
model_id	No	Integer	-	The model ID.
version_id	No	Integer	-	The model version ID. If it is not specified, the latest version will be used. Only has effect when the model ID is entered.

Methods

File based

Enter the path with the relative path to your file. After that, you can bundle your YAML files together in a ZIP file.

REST API

Send a POST request for each model and use the model ID in the import.

Examples

imports:
  dimensions:
    path: dimensions.yaml
  colors:
    path: colors.yaml