Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Web API Reference

WebID Encoded Datatypes (WebID)

For all WebID instances, the first character is an indicator of the Web ID type (see: WebID Type). The second character is a version character. The third and fourth characters are a two-character marker indicating the datatype to which the identifier refers. Name payloads are converted to uppercase, so that Web ID generation is case-insensitive. (see: WebID Encoding)

Table of Contents

AF Analysis

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

1. 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
2. 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
3. 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
4. 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
5. 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

Back to Table of Contents

AF AnalysisRule

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'XR' 2 None
Owner Marker
  • 'X' if rule's owner is AFAnalysis
  • 'T' if rule's owner is AFAnalysisTemplate
1 None
System ID analysisRule.PISystem.ID 22 Urlencoded Guid
Owner ID analysisRule.Analysis.ID or analysisRule.AnalysisTemplate.ID 22 Urlencoded Guid
Analysis Rule ID analysisRule.ID 22 Urlencoded Guid
Name Payload analysisRule.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'XR' 2 None
Owner Marker
  • 'X' if rule's owner is AFAnalysis
  • 'T' if rule's owner is AFAnalysisTemplate
1 None
System ID analysisRule.PISystem.ID 22 Urlencoded Guid
Owner ID analysisRule.Analysis.ID or analysisRule.AnalysisTemplate.ID 22 Urlencoded Guid
Analysis Rule ID analysisRule.category.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'XR' 2 None
Owner Marker
  • 'X' if rule's owner is AFAnalysis
  • 'T' if rule's owner is AFAnalysisTemplate
1 None
Name Payload analysisRule.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'XR' 2 None
Owner Marker
  • 'X' if rule's owner is AFAnalysis
  • 'T' if rule's owner is AFAnalysisTemplate
1 None
Owner ID analysisRule.Analysis.ID or analysisRule.AnalysisTemplate.ID 22 Urlencoded Guid
Analysis Rule ID analysisRule.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'XR' 2 None
Owner Marker
  • 'X' if rule's owner is AFAnalysis
  • 'T' if rule's owner is AFAnalysisTemplate
1 None
Owner ID analysisRule.Analysis.ID or analysisRule.AnalysisTemplate.ID 22 Urlencoded Guid
Analysis Template ID template.ID 22 Urlencoded Guid

Back to Table of Contents

AFAnalysisTemplate

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'XT' 2 None
System ID template.PISystem.ID 22 Urlencoded Guid
Analysis Template ID template.ID 22 Urlencoded Guid
Name Payload template.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'XT' 2 None
System ID template.PISystem.ID 22 Urlencoded Guid
Analysis Template ID template.category.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'XT' 2 None
Name Payload template.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'XT' 2 None
Analysis Template ID template.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'XT' 2 None
Analysis Template ID template.ID 22 Urlencoded Guid

Back to Table of Contents

AFAttribute

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'Ab' 2 None
Base Element Marker
  • 'E' if attr.Element is AFElement
  • 'F' if attr.Element is AFEventFrame
  • 'N' if attr.Element is AFNotification
1 None
System ID attr.PISystem.ID 22 Urlencoded Guid
Element ID attr.Element.ID 22 Urlencoded Guid
Attribute ID attr.ID 22 Urlencoded Guid
Name Payload attr.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'Ab' 2 None
Base Element Marker
  • 'E' if attr.Element is AFElement
  • 'F' if attr.Element is AFEventFrame
  • 'N' if attr.Element is AFNotification
1 None
System ID attr.PISystem.ID 22 Urlencoded Guid
Element ID attr.Element.ID 22 Urlencoded Guid
Attribute ID attr.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'Ab' 2 None
Base Element Marker
  • 'E' if attr.Element is AFElement
  • 'F' if attr.Element is AFEventFrame
  • 'N' if attr.Element is AFNotification
1 None
Name Payload attr.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'Ab' 2 None
Base Element Marker
  • 'E' if attr.Element is AFElement
  • 'F' if attr.Element is AFEventFrame
  • 'N' if attr.Element is AFNotification
1 None
Element ID attr.Element.ID 22 Urlencoded Guid
Attribute ID attr.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'Ab' 2 None
Event Frame ID analysisRulePlugIn.ID 22 Urlencoded Guid
Base Element Marker
  • 'E' if attr.Element is AFElement
  • 'F' if attr.Element is AFEventFrame
  • 'N' if attr.Element is AFNotification
1 None
Element ID attr.Element.ID 22 Urlencoded Guid
Attribute ID attr.ID 22 Urlencoded Guid

Back to Table of Contents

AFAttributeTemplate

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'AT' 2 None
Element Template Marker 'E' *Preserved here for legacy purposes* 1 None
System ID attrTempl.PISystem.ID 22 Urlencoded Guid
Element Template ID attrTempl.ElementTemplate.ID 22 Urlencoded Guid
Attribute Template ID attrTempl.ID 22 Urlencoded Guid
Name Payload attrTempl.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'AT' 2 None
Element Template Marker 'E' *Preserved here for legacy purposes* 1 None
System ID attrTempl.PISystem.ID 22 Urlencoded Guid
Element Template ID attrTempl.ElementTemplate.ID 22 Urlencoded Guid
Attribute Template ID attrTempl.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'AT' 2 None
Element Template Marker 'E' *Preserved here for legacy purposes* 1 None
Name Payload attrTempl.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'AT' 2 None
Element Template Marker 'E' *Preserved here for legacy purposes* 1 None
Element Template ID attrTempl.ElementTemplate.ID 22 Urlencoded Guid
Attribute Template ID attrTempl.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'AT' 2 None
Element Template Marker 'E' *Preserved here for legacy purposes* 1 None
Element Template ID attrTempl.ElementTemplate.ID 22 Urlencoded Guid
Attribute Template ID attrTempl.ID 22 Urlencoded Guid

Back to Table of Contents

AFCategory for Analysis

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

1. 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 Payload category.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. 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
3. 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
4. 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
5. 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

Back to Table of Contents

AFCategory for Attribute

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'AC' 2 None
System ID category.PISystem.ID 22 Urlencoded Guid
Category ID category.ID 22 Urlencoded Guid
Name Payload category.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'AC' 2 None
System ID category.PISystem.ID 22 Urlencoded Guid
Category ID category.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'AC' 2 None
Name Payload category.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'AC' 2 None
Category ID category.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'AC' 2 None
Category ID category.ID 22 Urlencoded Guid

Back to Table of Contents

AFCategory for Element

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'EC' 2 None
System ID category.PISystem.ID 22 Urlencoded Guid
Category ID category.ID 22 Urlencoded Guid
Name Payload category.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'EC' 2 None
System ID category.PISystem.ID 22 Urlencoded Guid
Category ID category.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'EC' 2 None
Name Payload category.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'EC' 2 None
Category ID category.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'EC' 2 None
Category ID category.ID 22 Urlencoded Guid

Back to Table of Contents

AFCategory for Table

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'BC' 2 None
System ID category.PISystem.ID 22 Urlencoded Guid
Category ID category.ID 22 Urlencoded Guid
Name Payload category.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'BC' 2 None
System ID category.PISystem.ID 22 Urlencoded Guid
Category ID category.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'BC' 2 None
Name Payload category.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'BC' 2 None
Category ID category.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'BC' 2 None
Category ID category.ID 22 Urlencoded Guid

Back to Table of Contents

AFDatabase

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'RD' 2 None
System ID database.PISystem.ID 22 Urlencoded Guid
Database ID database.ID 22 Urlencoded Guid
Name Payload database.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'RD' 2 None
System ID database.PISystem.ID 22 Urlencoded Guid
Database ID database.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'RD' 2 None
Name Payload database.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'RD' 2 None
Database ID database.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'RD' 2 None
Database ID database.ID 22 Urlencoded Guid

Back to Table of Contents

AFElement

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'Em' 2 None
System ID element.PISystem.ID 22 Urlencoded Guid
Element ID element.ID 22 Urlencoded Guid
Name Payload element.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'Em' 2 None
System ID element.PISystem.ID 22 Urlencoded Guid
Element ID element.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'Em' 2 None
Name Payload element.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'Em' 2 None
Element ID element.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'Em' 2 None
Element ID element.ID 22 Urlencoded Guid

Back to Table of Contents

AFElementTemplate

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'ET' 2 None
System ID template.PISystem.ID 22 Urlencoded Guid
Element Template ID template.ID 22 Urlencoded Guid
Name Payload template.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'ET' 2 None
System ID template.PISystem.ID 22 Urlencoded Guid
Element Template ID template.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'ET' 2 None
Name Payload template.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'ET' 2 None
Element Template ID template.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'ET' 2 None
Element Template ID template.ID 22 Urlencoded Guid

Back to Table of Contents

AFEnumerationSet

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'MS' 2 None
Source Marker
  • 'R' if enumerationSet.PISystem != null
  • 'D' if enumerationSet.PIServer != null
22 Urlencoded Guid
Server ID enumerationSet.PISystem.ID (if AF), enumerationSet.PIServer.ID (if PI) 22 Urlencoded Guid
Enumeration Set ID enumerationSet.ID 22 Urlencoded Guid
Name Payload enumerationSet.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'MS' 2 None
Source Marker
  • 'R' if enumerationSet.PISystem != null
  • 'D' if enumerationSet.PIServer != null
22 Urlencoded Guid
Server ID
  • enumerationSet.PISystem.ID (if AF)
  • enumerationSet.PIServer.ID (if PI)
22 Urlencoded Guid
Enumeration Set ID enumerationSet.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'MS' 2 None
Source Marker
  • 'R' if enumerationSet.PISystem != null
  • 'D' if enumerationSet.PIServer != null
22 Urlencoded Guid
Name Payload enumerationSet.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'MS' 2 None
Source Marker
  • 'R' if enumerationSet.PISystem != null
  • 'D' if enumerationSet.PIServer != null
22 Urlencoded Guid
Enumeration Set ID enumerationSet.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'MS' 2 None
Source Marker
  • 'R' if enumerationSet.PISystem != null
  • 'D' if enumerationSet.PIServer != null
22 Urlencoded Guid
Enumeration Set ID enumerationSet.ID 22 Urlencoded Guid

Back to Table of Contents

AFEnumerationValue

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'MV' 2 None
Source Marker
  • 'R' if val.EnumerationSet.PISystem != null
  • 'D' if val.EnumerationSet.PIServer != null
22 Urlencoded Guid
Server ID
  • val.EnumerationSet.PISystem.ID (if AF)
  • val.EnumerationSet.PIServer.ID (if PI)
22 Urlencoded Guid
Enumeration Set ID val.EnumerationSet.ID 22 Urlencoded Guid
Enumeration Value ID val.ID 22 Urlencoded Guid
Name Payload (val.EnumerationSet.GetPath(AFEncodeType.Name, null).Substring(2) + '\\' + val.Name) .ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'MV' 2 None
Source Marker
  • 'R' if val.EnumerationSet.PISystem != null
  • 'D' if val.EnumerationSet.PIServer != null
22 Urlencoded Guid
Server ID
  • val.EnumerationSet.PISystem.ID (if AF)
  • val.EnumerationSet.PIServer.ID (if PI)
22 Urlencoded Guid
Enumeration Set ID val.EnumerationSet.ID 22 Urlencoded Guid
Enumeration Value ID val.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'MV' 2 None
Source Marker
  • 'R' if val.EnumerationSet.PISystem != null
  • 'D' if val.EnumerationSet.PIServer != null
22 Urlencoded Guid
Name Payload (val.EnumerationSet.GetPath(AFEncodeType.Name, null).Substring(2) + '\\' + val.Name) .ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'MV' 2 None
Source Marker
  • 'R' if val.EnumerationSet.PISystem != null
  • 'D' if val.EnumerationSet.PIServer != null
22 Urlencoded Guid
Enumeration Set ID val.EnumerationSet.ID 22 Urlencoded Guid
Enumeration Value ID val.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'MV' 2 None
Source Marker
  • 'R' if val.EnumerationSet.PISystem != null
  • 'D' if val.EnumerationSet.PIServer != null
22 Urlencoded Guid
Enumeration Set ID val.EnumerationSet.ID 22 Urlencoded Guid
Enumeration Value ID val.ID 22 Urlencoded Guid

Back to Table of Contents

AFEventFrame

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'Fm' 2 None
System ID eventFrame.PISystem.ID 22 Urlencoded Guid
Event Frame ID eventFrame.ID 22 Urlencoded Guid
Name Payload eventFrame.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'Fm' 2 None
System ID eventFrame.PISystem.ID 22 Urlencoded Guid
Event Frame ID eventFrame.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'Fm' 2 None
Name Payload eventFrame.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'Fm' 2 None
Event Frame ID eventFrame.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'Fm' 2 None
Event Frame ID eventFrame.ID 22 Urlencoded Guid

Back to Table of Contents

AFNotification

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'Nf' 2 None
System ID notification.PISystem.ID 22 Urlencoded Guid
Element ID notification.ID 22 Urlencoded Guid
Name Payload notification.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'Nf' 2 None
System ID notification.PISystem.ID 22 Urlencoded Guid
Element ID notification.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'Nf' 2 None
Name Payload notification.GetPath(AFEncodeType. Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'Nf' 2 None
Element ID notification.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'Nf' 2 None
Element ID notification.ID 22 Urlencoded Guid

Back to Table of Contents

AFNotificationtemplate

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'NT' 2 None
System ID template.PISystem.ID 22 Urlencoded Guid
Element Template ID template.ID 22 Urlencoded Guid
Name Payload template.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'NT' 2 None
System ID template.PISystem.ID 22 Urlencoded Guid
Element Template ID template.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'NT' 2 None
Name Payload template.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'NT' 2 None
Element Template ID template.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'NT' 2 None
Element Template ID template.ID 22 Urlencoded Guid
[Back to Table of Contents](#toc)

AFPlugIn for Analysis Rule

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'XP' 2 None
System ID analysisRulePlugIn.PISystem.ID 22 Urlencoded Guid
Event Frame ID analysisRulePlugIn.ID 22 Urlencoded Guid
Name Payload analysisRule.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'XP' 2 None
System ID analysisRulePlugIn.PISystem.ID 22 Urlencoded Guid
Event Frame ID analysisRulePlugIn.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'XP' 2 None
Name Payload analysisRulePlugIn.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'XP' 2 None
Event Frame ID analysisRulePlugIn.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'XP' 2 None
Event Frame ID analysisRulePlugIn.ID 22 Urlencoded Guid

Back to Table of Contents

AFPlugIn for Time Rule

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'TP' 2 None
System ID timeRulePlugIn.PISystem.ID 22 Urlencoded Guid
Event Frame ID timeRulePlugIn.ID 22 Urlencoded Guid
Name Payload timeRulePlugIn.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'TP' 2 None
System ID timeRulePlugIn.PISystem.ID 22 Urlencoded Guid
Event Frame ID timeRulePlugIn.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'TP' 2 None
Name Payload timeRulePlugIn.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'TP' 2 None
Event Frame ID timeRulePlugIn.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'TP' 2 None
Event Frame ID timeRulePlugIn.ID 22 Urlencoded Guid

Back to Table of Contents

AFSecurityIdentity

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'SI' 2 None
System ID securityIdentity.PISystem.ID 22 Urlencoded Guid
Security Identity ID securityIdentity.ID 22 Urlencoded Guid
Name Payload securityIdentity.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'SI' 2 None
System ID securityIdentity.PISystem.ID 22 Urlencoded Guid
Security Identity ID securityIdentity.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'SI' 2 None
Name Payload securityIdentity.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'SI' 2 None
Security Identity ID securityIdentity.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'SI' 2 None
Security Identity ID securityIdentity.ID 22 Urlencoded Guid

Back to Table of Contents

AFSecurityMapping

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'SM' 2 None
System ID securityMapping.PISystem.ID 22 Urlencoded Guid
Security Mapping ID securityMapping.ID 22 Urlencoded Guid
Name Payload securityMapping.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'SM' 2 None
System ID securityMapping.PISystem.ID 22 Urlencoded Guid
Security Mapping ID securityMapping.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'SM' 2 None
Name Payload securityMapping.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'SM' 2 None
Security Mapping ID securityMapping.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'SM' 2 None
Security Mapping ID securityMapping.ID 22 Urlencoded Guid

Back to Table of Contents

AFTable

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'BI' 2 None
System ID table.PISystem.ID 22 Urlencoded Guid
Table ID table.ID 22 Urlencoded Guid
Name Payload table.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'BI' 2 None
System ID table.PISystem.ID 22 Urlencoded Guid
Table ID table.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'BI' 2 None
Name Payload table.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'BI' 2 None
Table ID table.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'BI' 2 None
Table ID table.ID 22 Urlencoded Guid

Back to Table of Contents

AFTimeRule

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'TR' 2 None
Owner Marker
  • 'X' if rule's owner is AFAnalysis
  • 'T' if rule's owner is AFAnalysisTemplate
1 None
System ID timeRule.PISystem.ID 22 Urlencoded Guid
Owner ID timeRule.Analysis.ID or timeRule.AnalysisTemplate.ID 22 Urlencoded Guid
Time Rule ID timeRule.ID 22 Urlencoded Guid
Name Payload timeRule.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'TR' 2 None
Owner Marker
  • 'X' if rule's owner is AFAnalysis
  • 'T' if rule's owner is AFAnalysisTemplate
1 None
System ID timeRule.PISystem.ID 22 Urlencoded Guid
Owner ID timeRule.Analysis.ID or timeRule.AnalysisTemplate.ID 22 Urlencoded Guid
Time Rule ID timeRule.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'TR' 2 None
Owner Marker
  • 'X' if rule's owner is AFAnalysis
  • 'T' if rule's owner is AFAnalysisTemplate
1 None
Name Payload timeRule.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'TR' 2 None
Owner Marker
  • 'X' if rule's owner is AFAnalysis
  • 'T' if rule's owner is AFAnalysisTemplate
1 None
Owner ID timeRule.Analysis.ID or timeRule.AnalysisTemplate.ID 22 Urlencoded Guid
Time Rule ID timeRule.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'TR' 2 None
Owner Marker
  • 'X' if rule's owner is AFAnalysis
  • 'T' if rule's owner is AFAnalysisTemplate
1 None
Owner ID timeRule.Analysis.ID or timeRule.AnalysisTemplate.ID 22 Urlencoded Guid
Time Rule ID timeRule.ID 22 Urlencoded Guid

Back to Table of Contents

PIPoint

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'DP' 2 None
Server ID point.Server.ID 22 Urlencoded Guid
Point ID point.ID 6 Urlencoded 32-bit Integer
Name Payload point.GetPath().Substring(2) .ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'DP' 2 None
Server ID point.Server.ID 22 Urlencoded Guid
Point ID point.ID 6 Urlencoded 32-bit Integer
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'DP' 2 None
Name Payload point.GetPath().Substring(2) .ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'DP' 2 None
Point ID point.ID 6 Urlencoded 32-bit Integer
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'DP' 2 None
Point ID point.ID 6 Urlencoded 32-bit Integer

Back to Table of Contents

PIServer

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'DS' 2 None
Server ID server.ID 22 Urlencoded Guid
Server Name server.Name.ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'DS' 2 None
Server ID server.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'DS' 2 None
Server Name server.Name.ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'DS' 2 None
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'DS' 2 None

Back to Table of Contents

PISystem

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'RS' 2 None
System ID piSystem.ID 22 Urlencoded Guid
Name Payload piSystem.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'RS' 2 None
System ID piSystem.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'RS' 2 None
Name Payload piSystem.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'RS' 2 None
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'RS' 2 None

Back to Table of Contents

UOM

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'Ut' 2 None
System ID uom.PISystem.ID 22 Urlencoded Guid
UOM ID uom.ID 22 Urlencoded Guid
Name Payload uom.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'Ut' 2 None
System ID uom.PISystem.ID 22 Urlencoded Guid
UOM ID uom.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'Ut' 2 None
Name Payload uom.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'Ut' 2 None
UOM ID uom.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'Ut' 2 None
UOM ID uom.ID 22 Urlencoded Guid

Back to Table of Contents

UOMClass

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

1. Full Type
Field Name Value Encoded Width Encoding Method
Type 'F' 1 None
Version '1' 1 None
Marker 'UC' 2 None
System ID uomClass.PISystem.ID 22 Urlencoded Guid
UOM ID uomClass.ID 22 Urlencoded Guid
Name Payload uomClass.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
2. ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'I' 1 None
Version '1' 1 None
Marker 'UC' 2 None
System ID uomClass.PISystem.ID 22 Urlencoded Guid
UOM ID uomClass.ID 22 Urlencoded Guid
3. Path Only Type
Field Name Value Encoded Width Encoding Method
Type 'P' 1 None
Version '1' 1 None
Marker 'UC' 2 None
Name Payload uomClass.GetPath(AFEncodeType.Name, null).Substring(2).ToUpperInvariant() var Urlencoded UTF8 String
4. Local ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'L' 1 None
Version '1' 1 None
Marker 'UC' 2 None
UOM ID uomClass.ID 22 Urlencoded Guid
5. Default ID Only Type
Field Name Value Encoded Width Encoding Method
Type 'D' 1 None
Version '1' 1 None
Marker 'UC' 2 None
UOM ID uomClass.ID 22 Urlencoded Guid

Back to Table of Contents

In This Topic
TitleResults for “How to create a CRG?”Also Available in