AdditionalProperty

AdditionalProperty is an entity for providing dynamic information to other entities. Additional properties can be considered as key value pairs with some additional metadata.

type AdditionalProperty {
  uniqueId: String @deprecated
  id: String
  name: String
  code: String
  description: String
  dataType: AdditionalPropertyValueType!
  value: String
  isMandatory: Boolean!
}

Fields

AdditionalProperty.uniqueId ● String deprecated scalar

[DEPRECATED]

UniqueId will be removed on 01 Jan 2023. Use Id instead.

A unique id for the value object. This is only for global uniqueness and not the key of the additional information

AdditionalProperty.id ● String scalar

Id of the value object. The Id has to be unique within the entity.

AdditionalProperty.name ● String scalar

Name of the value object. This should be considered to be the key used to translate, sort, display, search, etc.

AdditionalProperty.code ● String scalar

An optional user defined code to accompany the value.

AdditionalProperty.description ● String scalar

A description to follow the value. This can be used to explain what the content is for or what a specific value means.

AdditionalProperty.dataType ● AdditionalPropertyValueType! non-null enum

Data type of the value object

AdditionalProperty.value ● String scalar

The actual value as string. DataType must be evaluated to present it correctly in a UI

AdditionalProperty.isMandatory ● Boolean! non-null scalar

Is it mandatory to provide a value when using the data in a UI

Member Of

AdditionalItemId object ● ItemIdentifier object