Skip to content

Class: CustomProperty

A custom property is a key-value pair that can be used to store additional information about an asset that is not covered by the predefined slots. Custom properties are flexible and can be used to store any kind of information that might be relevant for an asset, but is not part of the core schema.

URI: base:CustomProperty

 classDiagram
    class CustomProperty
    click CustomProperty href "../CustomProperty/"
      CustomProperty : key

      CustomProperty : value

Slots

Name Cardinality and Range Description Inheritance
key 1
String
The key of a custom property as uuid direct
value 1
String
The value of the source direct

Usages

used by used in type used
Asset custom_properties range CustomProperty
Device custom_properties range CustomProperty
Gateway custom_properties range CustomProperty
SoftwareArtifact custom_properties range CustomProperty

Identifier and Mapping Information

Schema Source

  • from schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml

Mappings

Mapping Type Mapped Value
self base:CustomProperty
native base:CustomProperty

LinkML Source

Direct

name: CustomProperty
description: A custom property is a key-value pair that can be used to store additional
  information about an asset that is not covered by the predefined slots. Custom properties
  are flexible and can be used to store any kind of information that might be relevant
  for an asset, but is not part of the core schema.
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
slots:
- key
- value

Induced

name: CustomProperty
description: A custom property is a key-value pair that can be used to store additional
  information about an asset that is not covered by the predefined slots. Custom properties
  are flexible and can be used to store any kind of information that might be relevant
  for an asset, but is not part of the core schema.
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
attributes:
  key:
    name: key
    description: The key of a custom property as uuid. It is a string that can be
      used to identify the type of information being stored in the custom property.
    title: key
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: key
    owner: CustomProperty
    domain_of:
    - InstanceAnnotation
    - CustomProperty
    range: string
    required: true
  value:
    name: value
    description: The value of the source. It is a string that can be used to specify
      the value of the source, for example the name of the asset link.
    title: source value
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: value
    owner: CustomProperty
    domain_of:
    - InstanceAnnotation
    - Source
    - CustomProperty
    range: string
    required: true

Any questions left?

Ask the community