Navigation

The example below shows a browser or Postman call to navigate the root of the namespace. The root is browsed by passing a blank for the fqn.
{"fqn":"" , "propNames": ["fqn","childCount", "type"] , "includeParents": false }
In this example, the fqn, childCount and type properties of top-level elements will be returned. For the namespace shown in the sections above, the following result will be returned:
{
"currentPath": {
"fqn": "",
"type": "TypeSystem.Packages.Core.ItemTypes.Root",
"childCount": 7,
"groups": [],
"props": {
"Children": {
"name": "Children",
"fqn": "Children",
"type": "TypeSystem.Packages.Core.ItemTypes.Object"
},
"Version": {
"name": "Version",
"fqn": "Version",
"type": "TypeSystem.Packages.Core.ItemTypes.Root.Version",
"value": "6.0.10610.0"
}
}
},
"childPaths": [
{
"fqn": "$Global",
"type": "TypeSystem.Packages.OpcDa.ItemTypes.OpcDaConnector",
"childCount": 1,
"groups": []
},
{
"fqn": "FTDirectory",
"type": "TypeSystem.Packages.Core.ItemTypes.Folder",
"childCount": 1,
"groups": []
},
{
"fqn": "Historians",
"type": "TypeSystem.Packages.Core.ItemTypes.Folder",
"childCount": 4,
"groups": []
},
{
"fqn": "MyEnterprise",
"type": "TypeSystem.Packages.Core.ItemTypes.Folder",
"childCount": 0,
"groups": []
},
{
"fqn": "Simulator",
"type": "TypeSystem.Packages.[Connector.Simulator.Package].ItemTypes.[Connector.Simulator.Type]",
"childCount": 1,
"groups": []
},
{
"fqn": "System",
"type": "TypeSystem.Packages.Core.ItemTypes.System",
"childCount": 5,
"groups": []
},
{
"fqn": "TypeSystem",
"type": "TypeSystem.Packages.TypeSystem.ItemTypes.TypeSystem",
"childCount": 3,
"groups": []
}
]
}
Examining this result, it reveals that the Historians collection contains 4 children. This collection can be further explored using the following call:
{"fqn":"Historians" , "propNames": ["fqn", "childCount", "type"] }
Again, based on the examples shown earlier in this document, the following result will be returned:
{
"currentPath": {
"fqn": "Historians",
"type": "TypeSystem.Packages.Core.ItemTypes.Folder",
"childCount": 4,
"groups": [],
"props": {
"Children": {
"name": "Children",
"fqn": "Historians.Children",
"type": "TypeSystem.Packages.Core.ItemTypes.Object"
}
}
},
"childPaths": [
{
"fqn": "Historians.[192.168.1.128]",
"type": "TypeSystem.Packages.FTHistorian.ItemTypes.Connector",
"childCount": 0,
"groups": []
},
{
"fqn": "Historians.APPSERHIST",
"type": "TypeSystem.Packages.FTHistorian.ItemTypes.Connector",
"childCount": 8646,
"groups": []
},
{
"fqn": "Historians.vmhist",
"type": "TypeSystem.Packages.FTHistorian.ItemTypes.Connector",
"childCount": 0,
"groups": []
},
{
"fqn": "Historians.WS2012R2ADSB",
"type": "TypeSystem.Packages.FTHistorian.ItemTypes.Connector",
"childCount": 0,
"groups": []
}
]
}
As before, examining the results reveals that of the 4 historians, only the one called “APPSERHIST” has children. The number of items in the collection is high and browsing this collection may incur some time lag. Use the properties shown below to filter the subsequent call to explore this historian:
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.