EntityMetadataV1

Base information present on all entities.

type EntityMetadataV1 {
  globalUniqueId: String
  id: String
  correlationId: String
  tenantId: String
  name: String
  description: String
  businessUnitGroupId: String
  version: Int!
  displayId: String @deprecated
  created: DateTime!
  createdBy: String
  modified: DateTime!
  modifiedBy: String
  status: EntityStatusV1!
}

Fields

EntityMetadataV1.globalUniqueId ● String scalar

Internal unique ID for CRUD operations and relations. A typical example is: TenantId_itemId_BusinessUnitGroupId

EntityMetadataV1.id ● String scalar

Id for the entity. Either external or internal

EntityMetadataV1.correlationId ● String scalar

ID for tracing an entity and/or a group of sub entities through the application. Might be external, and if missing from the producer of data the API will add an ID. Must be used in all logging and tracing.

EntityMetadataV1.tenantId ● String scalar

To support multi tenancy we need to be able to identify the customer that owns this information.

EntityMetadataV1.name ● String scalar

The name of the entity. This general property can replace the previous ArticleName, StoreName, CampaignName, etc.

EntityMetadataV1.description ● String scalar

The description of the entity.

EntityMetadataV1.businessUnitGroupId ● String scalar

Used to assign the entity to a specific level in a store group hierarchy specific to the tenant.

EntityMetadataV1.version ● Int! non-null scalar

Version of the entity. Must be updated when there is a change to the entity. An ever increasing Integer.

EntityMetadataV1.displayId ● String deprecated scalar

[DEPRECATED]

DisplayId is obsolete and will be removed on 01 Jan 2023.

ID set in an external system. Specifically used for searching for external IDs. Must not be used for anything except search.

EntityMetadataV1.created ● DateTime! non-null scalar

When the object was first created. This timestamp will be set by the input API POST-endpoints before creating the AVRO data for processing.

EntityMetadataV1.createdBy ● String scalar

Who created. Will be an ID and must be looked up in the user DB. This ID will be set by the input API POST-endpoints before creating the AVRO data for processing.

EntityMetadataV1.modified ● DateTime! non-null scalar

When the object was modified. Will be updated along with the Version property. This timestamp will be set by the input API PUT and PATCH-endpoints before creating the AVRO data for processing.

EntityMetadataV1.modifiedBy ● String scalar

Who created or modified the object. Will be an ID and must be looked up in the user DB. This ID will be set by the input API PUT and PATCH-endpoints before creating the AVRO data for processing.

EntityMetadataV1.status ● EntityStatusV1! non-null enum

The status of the entity.

Member Of

Item object