Properties

Each blueprint has a properties section under its schema. In this section, you can define all of the unique properties that describe your asset.

Structure

{
  "myProp": {
    "title": "My property",
    "icon": "My icon",
    "description": "My property",
    "type": "property_type"
  }
}

The different components that make up a basic property definition are listed in the following table:

Field	Description
title	Property title
type	Mandatory field. The data type of the property.
icon	Icon for the property See the full icon list.
description	Description of the property. This value is visible to users when hovering on the info icon in the UI. It provides detailed information about the use of a specific property.
default	Default value for this property in case an entity is created without explicitly providing a value.

tip

The name of the property is the key of the property object. For example, in the code block above, the name of the property is myProp

Supported properties

📄️ String

String is a primitive data type used to save text data

📄️ Number

Number is a primitive data type used to save numeric data

📄️ Boolean

Boolean is a primitive data type that has one of two possible values - true and false

📄️ Object

Object is a data type used to save object definitions in JSON

📄️ Array

Array is a data type used to save lists of data

📄️ URL

URL is a data type used to save links to websites

📄️ Email

Email is a data type used to save Email addresses

📄️ User

User is a data type used to reference users that exist in Port

📄️ Team

Team is a data type used to reference teams that exist in Port

📄️ Datetime

Datetime is a data type used to reference a date and time

📄️ Timer

Timer is a data type used to define an expiration date/lifespan of a specific entity

📄️ Yaml

Yaml is a data type used to save object definitions in YAML

📄️ Proto

Proto is a data type used to save proto definitions in Port

📄️ ⚓️ Meta

A meta-property is a property that exists on every entity in Port by default.

🗃️ ➕ Calculation

1 items

📄️ 🪞 Mirror

Mirror Property allows you to map data from related entities to your entity

📄️ 🧬 Aggregation

Aggregation Property allows you to calculate metrics based on the relations in your catalog

Miscellaneous

Available enum colors

Properties defined using enum can also include specific colors for the different values available in the property definition, the available enum colors are:

blue
turquoise
orange
purple
pink
yellow
green
red
darkGray
lightGray
bronze