Web ID 2.0 Specification

 

These tables will help you encode and decode a PI Web API 2.0 Web ID so that you can both compose and deconstruct a Web ID yourself.   Visit How to Optimize your Applications for Web ID 2.0 to learn how the encoding works and how you can use Web ID to optimize your web application with PI Web API.

 

Web ID 2.0 first became available in PI Web API 2017 R2 (1.10 and later).   You can check your installed version by browsing to your PI Web API System endpoint  {yourwebapiserver}/piwebapi/system .

 

AFAnalysis

The Web ID for an AFAnalysis consists of the following data:

Full Type

Field Name

Value

Encoded Width

Encoding Method

Type

‘F’

1

None

Version

‘1’

1

None

Marker

“Xs”

2

None

System ID

analysis.PISystem.ID

22

Urlencoded Guid

Analysis ID

analysis.ID

22

Urlencoded Guid

Name Payload

analysis.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()

var

Urlencoded UTF8 String

 

ID Only Type

Field Name

Value

Encoded Width

Encoding Method

Type

‘I’

1

None

Version

‘1’

1

None

Marker

“Xs”

2

None

System ID

analysis.PISystem.ID

22

Urlencoded Guid

Analysis ID

analysis.ID

22

Urlencoded Guid

 

Path Only Type

Field Name

Value

Encoded Width

Encoding Method

Type

‘P’

1

None

Version

‘1’

1

None

Marker

“Xs”

2

None

Name Payload

analysis.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()

var

Urlencoded UTF8 String

 

Local ID Only Type

Field Name

Value

Encoded Width

Encoding Method

Type

‘L’

1

None

Version

‘1’

1

None

Marker

“Xs”

2

None

Analysis ID

analysis.ID

22

Urlencoded Guid

 

Default ID Only Type

Field Name

Value

Encoded Width

Encoding Method

Type

‘D’

1

None

Version

‘1’

1

None

Marker

“Xs”

2

None

Analysis ID

analysis.ID

22

Urlencoded Guid

 

 

AFCategory for Analysis

The Web ID for an AFCategory, whose Identity is CategoryAnalysis, consists of the following data:

Full Type

Field Name

Value

Encoded Width

Encoding Method

Type

‘F’

1

None

Version

‘1’

1

None

Marker

“XC”

2

None

System ID

category.PISystem.ID

22

Urlencoded Guid

Analysis Template

ID

category.ID

22

Urlencoded Guid

Name Payloadcategory.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

ID Only Type

Field Name

Value

Encoded Width

Encoding Method

Type

‘I’

1

None

Version

‘1’

1

None

Marker

“XC”

2

None

System ID

category.PISystem.ID

22

Urlencoded Guid

Analysis Template

ID

category.ID

22

Urlencoded Guid

 

Path Only Type

Field Name

Value

Encoded Width

Encoding Method

Type

‘P’

1

None

Version

‘1’

1

None

Marker

“XC”

2

None

Name Payload

category.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()

var

Urlencoded UTF8 String

 

Local ID Only Type

Field Name

Value

Encoded Width

Encoding Method

Type

‘L’

1

None

Version

‘1’

1

None

Marker

“XC”

2

None

Analysis Template

ID

category.ID

22

Urlencoded Guid

 

Default ID Only Type

Field Name

Value

Encoded Width

Encoding Method

Type

‘D’

1

None

Version

‘1’

1

None

Marker

“XC”

2

None

Analysis Template

ID

category.ID

22

Urlencoded Guid

 

 

AFAnalysisTemplate

The Web ID for an AFAnalysisTemplate consists of the following data:

 

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“XT”2None
System ID

template.PISystem.ID

22Urlencoded Guid
Analysis TemplateID

template.ID

22Urlencoded Guid
Name Payload

template.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()

varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“XT”2None
System ID

template.PISystem.ID

22Urlencoded Guid
Analysis TemplateID

template.ID

22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“XT”2None
Name Payload

template.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()

varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“XT”2None
Analysis TemplateID

template.ID

22Urlencoded Guid
  1. 5.   Default ID Only Type
Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“XT”2None
Analysis TemplateIDtemplate.ID22Urlencoded Guid

 

AFAnalysisRule

The Web ID for an AFAnalysisRule consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“XR”2None
Owner Marker‘X’ if rule’s owner is AFAnalysis‘T’ if rule’s owner is AFAnalysisTemplate1None
System IDanalysisRule.PISystem.ID22Urlencoded Guid
Owner IDanalysisRule.Analysis.ID or analysisRule.AnalysisTemplate.ID22Urlencoded Guid
Analysis Rule IDanalysisRule.ID22Urlencoded Guid
Name PayloadanalysisRule.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“XR”2None
Owner Marker‘X’ if rule’s owner is AFAnalysis‘T’ if rule’s owner is AFAnalysisTemplate1None
System IDanalysisRule.PISystem.ID22Urlencoded Guid
Owner IDanalysisRule.Analysis.ID or analysisRule.AnalysisTemplate.ID22Urlencoded Guid
Analysis Rule IDanalysisRule.ID22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“XR”2None
Owner Marker‘X’ if rule’s owner is AFAnalysis‘T’ if rule’s owner is AFAnalysisTemplate1None
Name PayloadanalysisRule.GetPath(AFEncodeType.Name,null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“XR”2None
Owner Marker‘X’ if rule’s owner is AFAnalysis‘T’ if rule’s owner is AFAnalysisTemplate1None
Owner IDanalysisRule.Analysis.ID oranalysisRule.AnalysisTemplate.ID22Urlencoded Guid
Analysis Rule IDanalysisRule.ID22Urlencoded Guid

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“XR”2None
Owner Marker‘X’ if rule’s owner is AFAnalysis‘T’ if rule’s owner is AFAnalysisTemplate1None
Owner IDanalysisRule.Analysis.ID oranalysisRule.AnalysisTemplate.ID22Urlencoded Guid
Analysis Rule IDanalysisRule.ID22Urlencoded Guid

 

AFPlugIn for Analysis Rule

The Web ID for an AFPlugIn, whose Identity is PlugInAnalysisRule, consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“XP”2None
System IDanalysisRulePlugIn.PISystem.ID22Urlencoded Guid
Event Frame IDanalysisRulePlugIn.ID22Urlencoded Guid
Name PayloadanalysisRulePlugIn.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“XP”2None
System IDanalysisRulePlugIn.PISystem.ID22Urlencoded Guid
Event Frame IDanalysisRulePlugIn.ID22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“XP”2None
Name PayloadanalysisRulePlugIn.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“XP”2None
Event Frame IDanalysisRulePlugIn.ID22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“XP”2None
Event Frame IDanalysisRulePlugIn.ID22Urlencoded Guid

 

AFAttribute

The Web ID for an AFAttribute consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“Ab”2None
Base ElementMarker‘E’ if attr.Element is AFElement‘F’ if attr.Element is AFEventFrame‘N’ if attr.Element is AFNotification1None
System IDattr.PISystem.ID22Urlencoded Guid
Element IDattr.Element.ID22Urlencoded Guid
Attribute IDattr.ID22Urlencoded Guid
Name Payloadattr.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“Ab”2None
Base ElementMarker‘E’ if attr.Element is AFElement‘F’ if attr.Element is AFEventFrame‘N’ if attr.Element is AFNotification1None
System IDattr.PISystem.ID22Urlencoded Guid
Element IDattr.Element.ID22Urlencoded Guid
Attribute IDattr.ID22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“Ab”2None
Base ElementMarker‘E’ if attr.Element is AFElement‘F’ if attr.Element is AFEventFrame‘N’ if attr.Element is AFNotification1None
Name Payloadattr.GetPath(AFEncodeType.Name,null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“Ab”2None
Base ElementMarker‘E’ if attr.Element is AFElement‘F’ if attr.Element is AFEventFrame‘N’ if attr.Element is AFNotification1None
Element IDattr.Element.ID22Urlencoded Guid
Attribute IDattr.ID22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“Ab”2None
Base ElementMarker‘E’ if attr.Element is AFElement‘F’ if attr.Element is AFEventFrame‘N’ if attr.Element is AFNotification1None
Element IDattr.Element.ID22Urlencoded Guid
Attribute IDattr.ID22Urlencoded Guid

 

AFCategory for Attribute

The Web ID for an AFCategory, whose Identity is CategoryAttribute, consists of the following data: 

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“AC”2None
System IDcategory.PISystem.ID22Urlencoded Guid
Category IDcategory.ID22Urlencoded Guid
Name Payloadcategory.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“AC”2None
System IDcategory.PISystem.ID22Urlencoded Guid
Category IDcategory.ID22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“AC”2None
Name Payloadcategory.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“AC”2None
Category IDcategory.ID22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“AC”2None
Category IDcategory.ID22Urlencoded Guid

 

AFAttributeTemplate

The Web ID for an AFAttributeTemplate consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“AT”2None
ElementTemplate Marker‘E’Preserved here for legacy purposes1None
System IDattrTempl.PISystem.ID22Urlencoded Guid
ElementTemplate IDattrTempl.ElementTemplate.ID22Urlencoded Guid
AttributeTemplate IDattrTempl.ID22Urlencoded Guid
Name PayloadattrTempl.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“AT”2None
ElementTemplate Marker‘E’Preserved here for legacy purposes1None
System IDattrTempl.PISystem.ID22Urlencoded Guid
ElementTemplate IDattrTempl.ElementTemplate.ID22Urlencoded Guid
AttributeTemplate IDattrTempl.ID22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“AT”2None
ElementTemplate Marker‘E’Preserved here for legacy purposes1None
Name Payload

attrTempl.GetPath(AFEncodeType.Name,null)

.Substring(2).ToUpperInvariant()

varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“AT”2None
ElementTemplate Marker‘E’Preserved here for legacy purposes1None
ElementTemplate IDattrTempl.ElementTemplate.ID22Urlencoded Guid
AttributeTemplate IDattrTempl.ID22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“AT”2None
ElementTemplate Marker‘E’Preserved here for legacy purposes1None
ElementTemplate IDattrTempl.ElementTemplate.ID22Urlencoded Guid
AttributeTemplate IDattrTempl.ID22Urlencoded Guid

 

AFDatabase

The Web ID for an AFDatabase consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“RD”2None
System IDdatabase.PISystem.ID22Urlencoded Guid
Database IDdatabase.ID22Urlencoded Guid
Name Payloaddatabase.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“RD”2None
System IDdatabase.PISystem.ID22Urlencoded Guid
Database IDdatabase.ID22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“RD”2None
Name Payloaddatabase.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“RD”2None
Database IDdatabase.ID22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“RD”2None
Database IDdatabase.ID22Urlencoded Guid

 
AFElement

The Web ID for an AFElement consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“Em”2None
System IDelement.PISystem.ID22Urlencoded Guid
Element IDelement.ID22Urlencoded Guid
Name Payloadelement.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“Em”2None
System IDelement.PISystem.ID22Urlencoded Guid
Element IDelement.ID22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“Em”2None
Name Payloadelement.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“Em”2None
Element IDelement.ID22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“Em”2None
Element IDelement.ID22Urlencoded Guid

 

AFCategory for Element

The Web ID for an AFCategory, whose Identity is CategoryElement, consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“EC”2None
System IDcategory.PISystem.ID22Urlencoded Guid
Category IDcategory.ID22Urlencoded Guid
Name Payloadcategory.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“EC”2None
System IDcategory.PISystem.ID22Urlencoded Guid
Category IDcategory.ID22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“EC”2None
Name Payloadcategory.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“EC”2None
Category IDcategory.ID22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“EC”2None
Category IDcategory.ID22Urlencoded Guid

 

AFElementTemplate

The Web ID for an AFElementTemplate consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“ET”2None
System IDtemplate.PISystem.ID22Urlencoded Guid
ElementTemplate IDtemplate.ID22Urlencoded Guid
Name Payloadtemplate.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 
   ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“ET”2None
System IDtemplate.PISystem.ID22Urlencoded Guid
ElementTemplate IDtemplate.ID22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“ET”2None
Name Payloadtemplate.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“ET”2None
ElementTemplate IDtemplate.ID22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“ET”2None
ElementTemplate IDtemplate.ID22Urlencoded Guid

 

AFEnumerationSet

The Web ID for an AFEnumerationSet consists of the following data:

Full Type

Field NameValueEncodedWidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“MS”2None
Source Marker‘R’ if enumerationSet.PISystem != null‘D’ if enumerationSet.PIServer != null1None
Server IDenumerationSet.PISystem.ID (if AF)enumerationSet.PIServer.ID (if PI)22Urlencoded Guid
EnumerationSet IDenumerationSet.ID22Urlencoded Guid
Name PayloadenumerationSet.GetPath(AFEncodeType.Name,null).Substring(2).ToUpperInvariant()varUrlencoded UTF8String

 

ID Only Type

Field NameValueEncodedWidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“MS”2None
Source Marker‘R’ if enumerationSet.PISystem != null‘D’ if enumerationSet.PIServer != null1None
Server IDenumerationSet.PISystem.ID (if AF)enumerationSet.PIServer.ID (if PI)22Urlencoded Guid
EnumerationSet IDenumerationSet.ID22Urlencoded Guid

 

Path Only Type

Field NameValueEncodedWidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“MS”2None
Source Marker‘R’ if enumerationSet.PISystem != null‘D’ if enumerationSet.PIServer != null1None
Name PayloadenumerationSet.GetPath(AFEncodeType.Name,null).Substring(2).ToUpperInvariant()varUrlencoded UTF8String

 

Local ID Only Type

Field NameValueEncodedWidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“MS”2None
Source Marker‘R’ if enumerationSet.PISystem != null‘D’ if enumerationSet.PIServer != null1None
EnumerationSet IDenumerationSet.ID22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncodedWidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“MS”2None
Source Marker‘R’ if enumerationSet.PISystem != null‘D’ if enumerationSet.PIServer != null1None
EnumerationSet ID
  1. enumerationSet.ID
22Urlencoded Guid

 

 

AFEnumerationValue

The Web ID for an AFEnumerationValue consists of the following data: 
Full Type

Field NameValueEncodedWidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“MV”2None
Source Marker‘R’ if val.EnumerationSet.PISystem != null‘D’ if val.EnumerationSet.PIServer != null1None
Server IDval.EnumerationSet.PISystem.ID (if AF)val.EnumerationSet.PIServer.ID (if PI)22Urlencoded Guid
EnumerationSet IDval.EnumerationSet.ID22Urlencoded Guid
EnumerationValue IDval.ID22Urlencoded Guid
Name Payload(val.EnumerationSet.GetPath(AFEncodeType.Name, null).Substring(2) + '\\' + val.Name) .ToUpperInvariant()varUrlencoded UTF8String

 

ID Only Type

Field NameValueEncodedWidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“MV”2None
Source Marker‘R’ if val.EnumerationSet.PISystem != null‘D’ if val.EnumerationSet.PIServer != null1None
Server IDval.EnumerationSet.PISystem.ID (if AF)val.EnumerationSet.PIServer.ID (if PI)22Urlencoded Guid
EnumerationSet IDval.EnumerationSet.ID22Urlencoded Guid
EnumerationValue IDval.ID22Urlencoded Guid

 

Path Only Type

Field NameValueEncodedWidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“MV”2None
Source Marker‘R’ if val.EnumerationSet.PISystem != null‘D’ if val.EnumerationSet.PIServer != null1None
Name Payload

(val.EnumerationSet.GetPath(AFEncodeType.Name,null)

.Substring(2) + '\\' + val.Name) .ToUpperInvariant()

varUrlencoded UTF8String

 

Local ID Only Type

Field NameValueEncodedWidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“MV”2None
Source Marker‘R’ if val.EnumerationSet.PISystem != null‘D’ if val.EnumerationSet.PIServer != null1None
EnumerationSet IDval.EnumerationSet.ID22Urlencoded Guid
EnumerationValue IDval.ID22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncodedWidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“MV”2None
Source Marker‘R’ if val.EnumerationSet.PISystem != null‘D’ if val.EnumerationSet.PIServer != null1None
EnumerationSet IDval.EnumerationSet.ID22Urlencoded Guid
EnumerationValue IDval.ID22Urlencoded Guid

 

 

AFEventFrame

The Web ID for an AFEventFrame consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“Fm”2None
System IDeventFrame.PISystem.ID22Urlencoded Guid
Event Frame IDeventFrame.ID22Urlencoded Guid
Name PayloadeventFrame.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“Fm”2None
System IDeventFrame.PISystem.ID22Urlencoded Guid
Event Frame IDeventFrame.ID22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“Fm”2None
Name PayloadeventFrame.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“Fm”2None
Event Frame IDeventFrame.ID22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“Fm”2None
Event Frame IDeventFrame.ID22Urlencoded Guid

 

 

AFNotification

The Web ID for an AFNotification consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“Nf”2None
System IDnotification.PISystem.ID22Urlencoded Guid
Element IDnotification.ID22Urlencoded Guid
Name Payloadnotification.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“Nf”2None
System IDnotification.PISystem.ID22Urlencoded Guid
Element IDnotification.ID22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“Nf”2None
Name Payloadnotification.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“Nf”2None
Element IDnotification.ID22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“Nf”2None
Element IDnotification.ID22Urlencoded Guid

 

 

AFNotificationTemplate

The Web ID for an AFNotificationTemplate consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“NT”2None
System IDtemplate.PISystem.ID22Urlencoded Guid
ElementTemplate IDtemplate.ID22Urlencoded Guid
Name Payloadtemplate.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“NT”2None
System IDtemplate.PISystem.ID22Urlencoded Guid
ElementTemplate IDtemplate.ID22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“NT”2None
Name Payloadtemplate.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“NT”2None
ElementTemplate IDtemplate.ID22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“NT”2None
ElementTemplate IDtemplate.ID22Urlencoded Guid

 
AFTimeRule

The Web ID for an AFTimeRule consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“TR”2None
Owner Marker‘X’ if rule’s owner is AFAnalysis‘T’ if rule’s owner is AFAnalysisTemplate1None
System IDtimeRule.PISystem.ID22Urlencoded Guid
Owner IDtimeRule.Analysis.ID or timeRule.AnalysisTemplate.ID22Urlencoded Guid
Time Rule IDtimeRule.ID22Urlencoded Guid
Name PayloadtimeRule.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“TR”2None
Owner Marker‘X’ if rule’s owner is AFAnalysis‘T’ if rule’s owner is AFAnalysisTemplate1None
System IDtimeRule.PISystem.ID22Urlencoded Guid
Owner IDtimeRule.Analysis.ID or timeRule.AnalysisTemplate.ID22Urlencoded Guid
Time Rule IDtimeRule.ID22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“TR”2None
Owner Marker‘X’ if rule’s owner is AFAnalysis‘T’ if rule’s owner is AFAnalysisTemplate1None
Name Payload

timeRule.GetPath(AFEncodeType.Name,null)

.Substring(2).ToUpperInvariant()

varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“TR”2None
Owner Marker‘X’ if rule’s owner is AFAnalysis‘T’ if rule’s owner is AFAnalysisTemplate1None
Owner IDtimeRule.Analysis.ID ortimeRule.AnalysisTemplate.ID22Urlencoded Guid
Time Rule IDtimeRule.ID22Urlencoded Guid

    

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“TR”2None
Owner Marker‘X’ if rule’s owner is AFAnalysis‘T’ if rule’s owner is AFAnalysisTemplate1None
Owner IDtimeRule.Analysis.ID ortimeRule.AnalysisTemplate.ID22Urlencoded Guid
Time Rule IDtimeRule.ID22Urlencoded Guid

 

 

AFPlugIn for Time Rule

The Web ID for an AFPlugIn, whose Identity is PlugInTimeRule, consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“TP”2None
System IDtimeRulePlugIn.PISystem.ID22Urlencoded Guid
Event Frame IDtimeRulePlugIn.ID22Urlencoded Guid
Name PayloadtimeRulePlugIn.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8String

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“TP”2None
System IDtimeRulePlugIn.PISystem.ID22Urlencoded Guid
Event Frame IDtimeRulePlugIn.ID22Urlencoded Guid

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“TP”2None
Name PayloadtimeRulePlugIn.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8String

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“TP”2None
Event Frame IDtimeRulePlugIn.ID22Urlencoded Guid

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“TP”2None
Event Frame IDtimeRulePlugIn.ID22Urlencoded Guid

 

 

AFSecurityIdentity

The Web ID for an AFSecurityIdentity consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“SI”2None
System IDsecurityIdentity.PISystem.ID22Urlencoded Guid
Security IdentityIDsecurityIdentity.ID22Urlencoded Guid
Name PayloadsecurityIdentity.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“SI”2None
System IDsecurityIdentity.PISystem.ID22Urlencoded Guid
Security IdentityIDsecurityIdentity.ID22Urlencoded Guid

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“SI”2None
Name PayloadsecurityIdentity.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 String

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“SI”2None
Security IdentityIDsecurityIdentity.ID22Urlencoded Guid

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“SI”2None
Security IdentityIDsecurityIdentity.ID22Urlencoded Guid

 

 

AFSecurityMapping

The Web ID for an AFSecurityMapping consists of the following data.

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“SM”2None
System IDsecurityMapping.PISystem.ID22Urlencoded Guid
SecurityMapping IDsecurityMapping.ID22Urlencoded Guid
Name PayloadsecurityMapping.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8String

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“SM”2None
System IDsecurityMapping.PISystem.ID22Urlencoded Guid
SecurityMapping IDsecurityMapping.ID22Urlencoded Guid

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“SM”2None
Name PayloadsecurityMapping.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8String

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“SM”2None
SecurityMapping IDsecurityMapping.ID22Urlencoded Guid

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“SM”2None
SecurityMapping IDsecurityMapping.ID22Urlencoded Guid

 
AFTable

The Web ID for an AFTable consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“Bl”2None
System IDtable.PISystem.ID22Urlencoded Guid
Table IDtable.ID22Urlencoded Guid
Name Payloadtable.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()varUrlencoded UTF8 Strin

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“Bl”2None
System IDtable.PISystem.ID22Urlencoded Guid
Table ID

table.ID

22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“Bl”2None
Name Payload

table.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()

varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“Bl”2None
Table ID

table.ID

22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“Bl”2None
Table ID

table.ID

22Urlencoded Guid

 

 

AFCategory for Table

The Web ID for an AFCategory, whose Identity is CategoryTable, consists of the following data:

 

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“BC”2None
System ID

category.PISystem.ID

22Urlencoded Guid
Category ID

category.ID

22Urlencoded Guid
Name Payload

category.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant()

varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“BC”2None
System ID

category.PISystem.ID

22Urlencoded Guid
Category ID

category.ID

22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“BC”2None
Name Payload

category.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant()

varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“BC”2None
Category ID

category.ID

22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“BC”2None
Category ID

category.ID

22Urlencoded Guid

 

 

PIPoint

The Web ID for a PI Point consists of the following data:

 

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“DP”2None
Server ID

point.Server.ID

22Urlencoded Guid
Point ID

point.ID

6Urlencoded Int32
Name Payload

point.GetPath().Substring(2)

.ToUpperInvariant()
varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“DP”2None
Server ID

point.Server.ID

22Urlencoded Guid
Point ID

point.ID

6Urlencoded Int32

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“DP”2None
Name Payload

point.GetPath().Substring(2)

.ToUpperInvariant()
varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“DP”2None
Point ID

point.ID

6Urlencoded Int32

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“DP”2None
Point ID

point.ID

6Urlencoded Int32

 

 

PIServer

The Web ID for a PI Server consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“DS”2None
Server ID

server.ID

22Urlencoded Guid
Server Name

server.Name.ToUpperInvariant()

varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“DS”2None
Server ID

server.ID

22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“DS”2None
Server Name

server.Name.ToUpperInvariant()

varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“DS”2None

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“DS”2None

 

 

PISystem

The Web ID for a PISystem consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“RS”2None
System ID

piSystem.ID

22Urlencoded Guid
Name Payload

piSystem.GetPath(AFEncodeType.Name,

null).Substring(2).ToUpperInvariant()
varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“RS”2None
System ID

piSystem.ID

22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“RS”2None
Name Payload

piSystem.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()

varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“RS”2None

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“RS”2None

 

 

UOM

The Web ID for a UOM consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“Ut”2None
System ID

uom.PISystem.ID

22Urlencoded Guid
UOM ID

uom.ID

22Urlencoded Guid
Name Payload

uom.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()

varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“Ut”2None
System ID

uom.PISystem.ID

22Urlencoded Guid
UOM ID

uom.ID

22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“Ut”2None
Name Payload

uom.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()

varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“Ut”2None
UOM ID

uom.ID

22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“Ut”2None
UOM ID

uom.ID

22Urlencoded Guid

 
UOMClass

The Web ID for a UOMClass consists of the following data:

Full Type

Field NameValueEncoded WidthEncoding Method
Type‘F’1None
Version‘1’1None
Marker“UC”2None
System ID

uomClass.PISystem.ID

22Urlencoded Guid
UOM ID

uomClass.ID

22Urlencoded Guid
Name Payload

uomClass.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()

varUrlencoded UTF8 String

 

ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘I’1None
Version‘1’1None
Marker“UC”2None
System ID

uomClass.PISystem.ID

22Urlencoded Guid
UOM ID

uomClass.ID

22Urlencoded Guid

 

Path Only Type

Field NameValueEncoded WidthEncoding Method
Type‘P’1None
Version‘1’1None
Marker“UC”2None
Name Payload

uomClass.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant()

varUrlencoded UTF8 String

 

Local ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘L’1None
Version‘1’1None
Marker“UC”2None
UOM ID

uomClass.ID

22Urlencoded Guid

 

Default ID Only Type

Field NameValueEncoded WidthEncoding Method
Type‘D’1None
Version‘1’1None
Marker“UC”2None
UOM ID

uomClass.ID

22

Urlencoded Guid