AssetDatabase GetSecurityEntries
- Last UpdatedJun 15, 2023
- 1 minute read
- PI System
- PI Web API Reference
- Developer
AssetDatabase GetSecurityEntries
Retrieve the security entries of the specified security item associated with the asset database based on the specified criteria. By default, all security entries for this asset database are returned.
Request
GET assetdatabases/{webId}/securityentries
URL Parameters
-
webId The ID of the asset database. See WebID for more information.
-
securityItem The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the 'Default' security item will be returned. See Security Item for more information.
-
nameFilter The name query string used for filtering security entries. The default is no filter. See Query String for more information.
-
selectedFields List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned. See Selected Fields for more information.
-
webIdType Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType". See WebID Type for more information.
Status Codes
200: A list of security entries matching the specified condition.
Sample Response Body
{
"Items": [
{
"Name": "domain\\user1",
"SecurityIdentityName": "domain\\user1",
"AllowRights": [
"Read",
"ReadData"
],
"DenyRights": [
"Write",
"Execute",
"Admin"
],
"Links": {}
},
{
"Name": "domain\\user1",
"SecurityIdentityName": "domain\\user1",
"AllowRights": [
"Read",
"ReadData"
],
"DenyRights": [
"Write",
"Execute",
"Admin"
],
"Links": {}
}
],
"Links": {}
}