Link data message keywords
- Last UpdatedSep 04, 2025
- 2 minute read
Link data message keywords
The following table shows keywords that can be used to create a basic link data message. Additional keywords that add specific details are detailed in the following sections.
|
Keyword |
Type |
Required |
Details |
|---|---|---|---|
|
typeid |
String |
Required |
Value must be __Link. |
|
values |
Array |
Required |
Array of linked objects. |
Link object keywords
The following table shows keywords that can be used to create link objects in a link data message.
|
Keyword |
Type |
Required |
Details |
|---|---|---|---|
|
source |
Object |
Required |
Source of the link. Contains typeid and index keywords. |
|
target |
Object |
Required |
Target of the link. For static-to-static links, contains typeid and index keywords. For static-to-dynamic links, contains containerid. |
The following types of link objects are supported:
-
Static-to-static links, which create parent/child links between assets. These links are shown in the hierarchy (tree structure) in PI AF.
-
Static-to-dynamic links, which attach container properties as PI point attributes.
Note: Type-to-type links are not supported.
Static-to-static link keywords
The following table shows keywords used in static-to-static link data messages. These messages create parent/child links between assets PI AF.
|
Link object keyword |
Keyword |
Type |
Required |
Details |
|---|---|---|---|---|
|
source |
typeid |
String |
Required |
ID of the static type definition for the parent asset. When combined with the index, this identifies the parent asset. |
|
source |
index |
String |
Required |
Value of the keyword for the parent asset, for which isindex is set to True. When combined with the typeid, this identifies the parent asset. |
|
target |
typeid |
String |
Required |
ID of the static type definition for the child asset. When combined with the index, this identifies the child asset. |
|
target |
index |
String |
Required |
Value of the keyword for the asset, for which isindex is set to True. When combined with the typeid, this identifies the child asset. |
Static-to-dynamic link keywords
The following table shows keywords used in a static-to-dynamic link data message. These messages create AF Attributes using PI Point Data References.
|
Link object keyword |
Keyword |
Type |
Required |
Details |
|---|---|---|---|---|
|
source |
typeid |
String |
Required |
ID of the static type definition used by the asset. |
|
source |
index |
String |
Required |
Value of the keyword for the asset, for which isindex is set to True. When combined with the typeid, this identifies the asset. |
|
source |
property |
String |
Optional |
When specified, replaces the CONTAINER_NAME portion of attribute names created by the link message. When property is also specified on the target , this becomes the entire name for the attribute created by the link message. |
|
target |
containerid |
String |
Required |
ID of the container created from dynamic type definition. |
|
target |
property |
String |
Optional |
The index of the property on the container to be linked. If omitted, all container properties are linked. |