BaseDynamicEntityTemplate

Dynamic Entity Template is a structure to facilitate the setup of entities to comply with the expectations of surrounding services and UIs.

A base template is for Extenda Retail only.

Some base templates contain properties that are not editable by the tenant because they reference internal Hii Retail requirements and cannot be modified. Others refer to domain areas or functionalities that the tenant has or wants to have, and are only best-practice recommendations from Extenda Retail. These can be modified and/or extended as required by the tenant.

type BaseDynamicEntityTemplate {
  id: String
  tenantId: String
  correlationId: String
  status: DynamicEntityTemplateStatus!
  name: String
  description: String
  groupId: String
  parentId: String
  created: DateTime!
  createdBy: String
  modified: DateTime!
  modifiedBy: String
  entityProperties: [EntityAdditionalProperties]
  isHiiRetailServiceRequirement: Boolean!
  requiresItemCategory: Boolean!
  revision: Long!
  version: String
}

Fields

BaseDynamicEntityTemplate.id ● String scalar

The ID for the base template.

BaseDynamicEntityTemplate.tenantId ● String scalar

The ID of the Extenda tenant.

BaseDynamicEntityTemplate.correlationId ● String scalar

ID for tracing an entity and/or a group of sub entities through the application.

BaseDynamicEntityTemplate.status ● DynamicEntityTemplateStatus! non-null enum

The status of the template.

BaseDynamicEntityTemplate.name ● String scalar

The name of the template.

BaseDynamicEntityTemplate.description ● String scalar

A description of the properties in this template and their intended use.

BaseDynamicEntityTemplate.groupId ● String scalar

Optional grouping for use in a frontend application. This property can be used to group templates that belong together under the same "tab".

BaseDynamicEntityTemplate.parentId ● String scalar

Reference to a parent template to build and maintain a hierarchical structure of templates.

BaseDynamicEntityTemplate.created ● DateTime! non-null scalar

When the object was first created.

BaseDynamicEntityTemplate.createdBy ● String scalar

Who created the object.

BaseDynamicEntityTemplate.modified ● DateTime! non-null scalar

When the object was modified.

BaseDynamicEntityTemplate.modifiedBy ● String scalar

Who created or modified the object.

BaseDynamicEntityTemplate.entityProperties ● [EntityAdditionalProperties] list object

The list of additional properties per entity.

BaseDynamicEntityTemplate.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.

BaseDynamicEntityTemplate.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.

BaseDynamicEntityTemplate.revision ● Long! non-null scalar

The version of the template. Must be updated when there is a change to the entity. An ever-increasing Long.

BaseDynamicEntityTemplate.version ● String scalar

The public version used in announcements and notifications about changes to base templates.

Returned By

baseDynamicEntityTemplate query

Member Of

BaseDynamicEntityTemplatesConnection object ● BaseDynamicEntityTemplatesEdge object