Skip to main content

AggregatedAdditionalProperty

Extended additional property with metadata from the template.

type AggregatedAdditionalProperty {
  entityType: EntityType!
  groupId: String
  isHiiRetailServiceRequirement: Boolean!
  requiresItemCategory: Boolean!
  itemCategoryId: String
  id: String
  name: String
  code: String
  description: String
  value: String
  defaultValue: String
  dataType: AdditionalPropertyValueType!
  isMandatory: Boolean!
}

Fields​

AggregatedAdditionalProperty.entityType ● EntityType! non-null enum​

The type of entity this additional property applies to.

AggregatedAdditionalProperty.groupId ● String scalar​

QUESTION: Isn't group property only applicable to templates themselves? Optional grouping for use in a frontend application.

AggregatedAdditionalProperty.isHiiRetailServiceRequirement ● Boolean! non-null scalar​

Specifies if these properties are required by an internal Hii Retail service or integration and cannot be modified by the tenant.

AggregatedAdditionalProperty.requiresItemCategory ● Boolean! non-null scalar​

If set to true the UI must FORCE the user to select an Item Category that this template applies to.

AggregatedAdditionalProperty.itemCategoryId ● String scalar​

The ID of the Item Category that this template applies to.

AggregatedAdditionalProperty.id ● String scalar​

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

AggregatedAdditionalProperty.name ● String scalar​

The Name of the additional property object. Accepts spaces and can be used for display purposes.

AggregatedAdditionalProperty.code ● String scalar​

An optional Code of additional property object.

AggregatedAdditionalProperty.description ● String scalar​

An optional Description of the content in the additional property object. Can hold instructions or just a description of the value means.

AggregatedAdditionalProperty.value ● String scalar​

The actual Value of the additional property object. This is the value that has meaning to the recipient and the value that will be used when performing logic on the data.

AggregatedAdditionalProperty.defaultValue ● String scalar​

The default value of the additional property. Will be used in UI for setting Value if it will not be provided.

AggregatedAdditionalProperty.dataType ● AdditionalPropertyValueType! non-null enum​

The Data Type of the value. This is important to specify for anyone using the data. They need to know what the data is and how to interpret it. This is particularly important when the data will be used in logic or in a UI.

AggregatedAdditionalProperty.isMandatory ● Boolean! non-null scalar​

Indicates if property is mandatory.

Returned By​

aggregatedAdditionalProperties query