Additional Information

Attribute Request Payload Parameters

Field (Mandatory or Optional)

Data Type

Description

<internalId>(Mandatory)

String

a mandatory field that defines a unique ID for the attribute.

<Id>

String

a unique identifier generated by the system for an attribute.

<Description>

String
a description for an attribute. It has the following subfields:
  • <Id>: unique identifier that is system generated for an attribute
  • <short>: defines a short description for an attribute
  • <long>: defines a long description for an attribute

<dataType>

String

Defines the kind of data types that can be assigned for an attribute.

List of supported data types are:

  • boolean
  • string
  • numeric
  • date
  • enum
  • picture

    For more information on using the data types and defining additional properties for these data types, see Defining Additional Properties for a Data Type

dimension1

String

a field that defines a unit of measurement for an numeric attribute

For more information on supported dimensions, refer the list provided in dimension2 description.

dimension2

String

a field that defines additional unit of measurement for an numeric attribute.

List of supported dimensions are:
  • weight
  • length
  • time
  • force
  • mass
  • pressure
  • current
  • energy
  • power
  • accleration
  • electric current
  • temperature

<enumValues>

array

Allows you to specify an array of values which serves as an enumeration for enum attribute.

unitOfMeasure1

array

Specifies the allowed values for dimension1

unitOfMeasure2

array

Specifies the allowed values for dimension2

<isMultivalue>

boolean

Specifies if the enum attribute can support multiple values.

<isLanguage>

boolean

Specifies if the value supported by a string attribute is language-dependent or not.

<isRange>

boolean

Specifies if the numeric attribute can support a range.

<industryStandards>

array

Specifies the supported industry standards at the attribute level. Possible values:

  • ISO 15926

  • IEC 60050

  • ISO 14224

  • IO-LINK

  • MIMOSA

    It has the following sub fields:

    • industryStandard: specifies the name of the industry standard.

    • standard ID: a unique identifier corresponding to an industry standard specified by the user.

<hasNormalValue>

boolean

Specifies if the numeric attribute can support a normal value. This flag can be used only if <isRange> is set to true.

optionCode

Integer

Specifies the priority - Optional, Mandatory or Recommended
Attribute Group Fields

Field (Mandatory or Optional)

Data Type

Description

<internalId>(Mandatory)

String

a mandatory field that defines a unique ID for the attribute group.

<Id>

String

a unique identifier for an attribute group that is generated by the system.

<Description>

String

a description for an attribute group. It has the following subfields:

Id: unique identifier for an attribute group

short: defines a short description for an attribute group

long: defines a long description for an attribute group

<attributes>

array

An array of IDs that uniquely identifies each attribute.
Template Attributes

Field (Mandatory or Optional)

Data Type

Description

<internalId>(Mandatory)

String

a mandatory field and defines a unique ID for the template.

<Id (Optional)>

String

a system generated unique identifier for a template.

<description (Optional)>

String

Defines a description for a template. It has the following subfields:

  • <Id>: unique identifier for the template

  • <short>: defines a short description for a template

  • <long>: defines a long description for a template.

<parentId (Optional)>

String

a unique identifier of a parent template.

<isAbstract (Optional)>

boolean

a flag that identifies if a template is abstract or non-abstract.

<type (Mandatory)>

String
a mandatory field that defines the type of a template. It can take any of the following three values:
  • class (1): A class template is a base template.
  • subclass (2): A subclass template inherits from a class template.
  • model template (3): A model template inherits either from a subclass template or another model template.
  • equipment template (4): An equipment template is independent of class or subclass. It can have separate attributes of its own.
  • location template (5): A location template contains location-specific attributes and attribute groups related to a location.

<attributeGroups (Optional)>

array

An array of IDs that uniquely identifies each attribute group.

<changedOn (Optional)>

String

Specifies the date when the template was last updated.
Indicators

Field (Mandatory or Optional)

Data Type

Description

<internalId>(Mandatory)

String

a mandatory field and defines a unique ID for the indicator.

<description>

String

Defines a description for a template. It has the following subfields:

  • <short> (Madatory): defines a short description for an indicator

  • <long>: defines a long description for an indicator

<desctriptions>

 Sstring Specifies the list of descriptions of the object in various languages. This takes priority over <description> field

  • <language>: Defines a language for the description object.

  • <short> (Madatory): defines a short description for an indicator

  • <long>: defines a long description for an indicator

<dataType> (Madatory)

String

Defines the kind of data types that can be assigned for an indicator.

<aggregationConcept>(Madatory)

String

The aggregation concept used to show the indicator values.

<indicatorGroup>

String

  

<isInstantiationRequired>

array

An array of IDs that uniquely identifies each attribute group.

<scale>

Integer

Reserves the number of significant places after decimal.

<precision>

Integer

Specifies the maximum number of digits numeric flexible value can have including decimal places.

<hasThreshold>

Boolean

To be set if user wants to specify threshold as Min/Max/Normal. Should be used along with isRange.

<dimension1>

String

Dimension 1 of the indicator in case of numeric data type only.

<expectedBehaviour>

String

The expected behaviour of the indicator.
Indicator Groups

Field (Mandatory or Optional)

Data Type

Description

<description (Optional)>

String

Specifies the list of descriptions of the object in various languages. This takes priority over <description> field

  • <short>: defines a short description for a template

  • <long>: defines a long description for a template.

  • <language>: unique identifier for the template

<internalId>

String

 A mandatory field that defines a unique internal ID for the indicator group.

<indicators>

String

List of IDs of attributes which are to be added to the indicator group.
Code Lists

Field (Mandatory or Optional)

Data Type

Description

<internalId>(Mandatory)

String

A mandatory field that defines a unique internal ID for a codelist.

<dataType>

String

Defines the kind of data types that can be assigned for a codelist.

<description (Optional)>

String

Defines a description for a template. It has the following subfields:

  • <language>: unique identifier for the template

  • <short>: defines a short description for a template

  • <long>: defines a long description for a template.

<items>

array

Specifies the list of descriptions of the codes.

<industryStandards>

String

The list of industry standards the code list is complaint to.