| Method | HTTP request | Description |
|---|---|---|
| landing | GET /system | Get system links for this PI System Web API instance. |
| cache_instances | 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. |
| user_info | 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()
Get system links for this PI System Web API instance.
| Name | Type | Description | Notes |
|---|
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
cache_instances()
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.
| Name | Type | Description | Notes |
|---|
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
status()
Get the system uptime, the system state and the number of cache instances for this PI System Web API instance.
| Name | Type | Description | Notes |
|---|
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
user_info()
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.
| Name | Type | Description | Notes |
|---|
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
versions()
Get the current versions of the PI Web API instance and all external plugins.
| Name | Type | Description | Notes |
|---|
dict(str, PIVersion)
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]