EntityMetadata

Base information present on all entities

type EntityMetadata {
  globalUniqueId: String
  id: String
  correlationId: String
  businessUnitGroupId: String
  version: Int!
  displayId: String
  created: DateTime
  createdBy: String
  modified: DateTime
  modifiedBy: String
  status: Status!
  statusName: String
  name: String
  description: String
}

Fields

EntityMetadata.globalUniqueId ● String scalar

Internal unique ID for CRUD operations and relations. For pnp clan the field have following structure: TenantId_EntityId_BusinessUnitGroupId. Example of GlobalUniqueId of a Mid Level Entity: 10000_45232_200

EntityMetadata.id ● String scalar

Id for the entity. Either external or internal

EntityMetadata.correlationId ● String scalar

ID for tracing an entity and/or a group of sub entities through the application. Might be external, and if missing externally an internal ID should be added. Could very well be used in audit logging as well

EntityMetadata.businessUnitGroupId ● String scalar

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

EntityMetadata.version ● Int! non-null scalar

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

EntityMetadata.displayId ● String scalar

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

EntityMetadata.created ● DateTime scalar

When the object was first created

EntityMetadata.createdBy ● String scalar

Who created the entity. It is an ID that can be looked up in the user DB

EntityMetadata.modified ● DateTime scalar

When the object was modified

EntityMetadata.modifiedBy ● String scalar

Who created or modified the object

EntityMetadata.status ● Status! non-null enum

The status of the entity

EntityMetadata.statusName ● String scalar

The actual name of the status

EntityMetadata.name ● String scalar

The name of the entity

EntityMetadata.description ● String scalar

The description of the entity

Member Of

EntityApproval object