Skip to content

Latest commit

 

History

History
95 lines (48 loc) · 3.73 KB

File metadata and controls

95 lines (48 loc) · 3.73 KB

SystemApi

Method HTTP request Description
landing GET /system Get system links for this PI System Web API instance.
cacheInstances GET /system/cacheinstances Get AF cache instances currently in use by the system. These are caches from which user requests are serviced. The number of instances depends on the number of users connected to the service, the service's authentication method, and the cache instance configuration.
status GET /system/status Get the system uptime, the system state and the number of cache instances for this PI System Web API instance.
userInfo GET /system/userinfo Get information about the Windows identity used to fulfill the request. This depends on the service's authentication method and the credentials passed by the client. The impersonation level of the Windows identity is included.
versions GET /system/versions Get the current versions of the PI Web API instance and all external plugins.

landing

landing()

Get system links for this PI System Web API instance.

Parameters

Name Type Description Notes

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

cacheInstances

cacheInstances()

Get AF cache instances currently in use by the system. These are caches from which user requests are serviced. The number of instances depends on the number of users connected to the service, the service's authentication method, and the cache instance configuration.

Parameters

Name Type Description Notes

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

status

status()

Get the system uptime, the system state and the number of cache instances for this PI System Web API instance.

Parameters

Name Type Description Notes

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

userInfo

userInfo()

Get information about the Windows identity used to fulfill the request. This depends on the service's authentication method and the credentials passed by the client. The impersonation level of the Windows identity is included.

Parameters

Name Type Description Notes

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

versions

versions()

Get the current versions of the PI Web API instance and all external plugins.

Parameters

Name Type Description Notes

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]