WebID Type

Indicates the format in which WebIDs should be returned. The default type is configurable using the WebIDType configuration setting. The following values are accepted:

WebIdType Description
Full Encodes all information, similar to WebID version 1.0. Full WebIDs are longer, but are more resistant to items being moved, renamed, or deleted.
IDOnly Encodes only object IDs into the WebID. IDOnly WebIDs are shorter, and will always refer to the same item, even if it is moved. However, IDOnly WebIDs will no longer be valid if the item is deleted.
PathOnly Encodes only path information into the WebID. PathOnly WebIDs will always refer to the same location in the AF hierarchy, regardless of which item is located there.
LocalIDOnly This type is similar to IDOnly, but is dedicated to resources on the local (relative to the PI Web API instance) asset or data server. The local asset/data server ID and path information is left out.
Note: This type is not persistent or unique, and could represent different items on different servers. It is not compatible with load balancer configurations.
DefaultIDOnly This type is similar to IDOnly, but is dedicated to resources on the default asset server or data server. The default asset/data server ID and path information is left out.
Note: This type is not persistent or unique, and could represent different items on different servers. It is not compatible with load balancer configurations.

Some of the WebID 2.0 formats can be generated in client application code rather than querying PI Web API for them. If this is necessary in your application, please contact Technical Support for more information.

Enabling Operational Intelligence