Reference specifications
Specification data structures carry a reference to a specific data object instance. They are used to link objects together.
Entity identifiers
The system supports two types of identifiers: internal (UID) and external (Origin Specification).
UID
The UID is a numeric identifier generated by SDP upon creation of an Entity.
Origin specification
An OriginSpecification structure allows API clients to provide an identifier with the creation requests, as well as to identify an existing entity. Both the originId and originKey must be provided.
Name | Type | Description |
|---|---|---|
originId | Integer | The origin ID of the entity (that is, the identifier used by SDP for the system that owns the object). |
originKey | String | The origin key of the entity (that is, the identifier used for the object by the system that owns it). |
Unless stated otherwise, the API allows the client to use either identifier to refer to an existing entity in the system.
In addition, some specific entities may hold additional identifiers (for example, an account number). Please refer to the relevant entity definition