ExternalIdentifier
ExternalIdentifier
Data type: Extensible
An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list.
Name | Type | Description | Example |
---|---|---|---|
@type (1) | string | When sub-classing, this defines the sub-class Extensible name | |
@baseType | string | When sub-classing, this defines the super-class | |
@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | |
id | string | Unique identifier | 2d7ed5fd-9f62-4211-bc84-357f5f7b80f5 |
href | URI | Hyperlink reference | https://example.org/resource/id |
externalIdentifierType | string | Type of the identification, typically would be the type of the entity within the external system | ProductOrder |
owner | string | Name of the external system that owns the entity. | AcmeCommerce |