You can learn more about Asset Properties in the Overview ⟶ Concepts page.

Note

In brief, Asset Properties will be created automatically when creating an Asset using the Kelvin UI.

If you create via Kelvin API then you will need to create the Asset Property before creating the Asset.

Creating Asset Properties¶

To create a new Property Definition, you can use the /properties/create API endpoint.

Reference:

Field	Mandatory	Description
name	Yes	Unique identifier name for the Property. It must contain only lowercase alphanumeric characters. The characters `.`, `_` and `-` are allowed to separate words instead of a space BUT can not be at the beginning or end of the name. Between 1 and 64 characters.
title	Yes	Unique title for the Property. Between 1 and 64 characters.
primitive_type	Yes	The type of data held by the Property. Allowed values: boolean, number, string, timestamp, list[boolean], list[number], list[string], list[timestamp].

Unlike Titles in Assets, Data Streams and other areas of the Kelvin Platform, Titles in Properties must be unique. A repeated title will cause the request to fail.

Note

You can only create a Property Definition in the Kelvin API.

Kelvin UIKelvin SDKKelvin API

You can not create a Property Definition in the Kelvin UI.

You can not create a Property Definition in the Kelvin SDK.

API cURL Example
curl -X "POST" \
"https://<url.kelvin.ai>/api/v4/properties/create" \
-H "Authorization: Bearer <Your Current Token>" \
-H "Content-Type: application/json" \
-H 'accept: */*' \
-d '{
    "name": "plc_manufacturer",
    "title": "PLC Manufacturer",
    "primitive_type": "string"
}'