| Name |
0:String |
Yes |
It is the name of the entity identifier.
Examples: VIN, Program Id, etc.
Note: Application can send custom names which could be a combination of different terms in the system. |
| Description |
0:String |
Yes |
It is the description of the entity. Any additional information for the entity can be sent using this property.
Examples: Name of the program in the given system. |
| EntityId |
0:TrimmedString |
|
It is the identifier of the given entity.
Examples: JoiningProcessId, JointId, etc. |
| EntityOriginId |
0:TrimmedString |
Yes |
It is the origin identifier of the given entity. It is provided only when it is applicable and available for a given entity.
Examples: JoiningProcessOriginId, JointOriginId, etc. |
| IsExternal |
0:Boolean |
Yes |
It indicates if the EntityId is provided by the external system or not.
Example: VIN is provided by an external system. |
| EntityType |
0:Int16 |
|
It provides the type of the Entity. It has the following pre-defined values which shall be used for each instance of this type.
Important Note: EntityType >=0 is defined as part of this specification.
For application specific extensions, EntityType < 0 can be used. |