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

PI Web API Reference

EventFrame GetSecurityEntries

EventFrame GetSecurityEntries

Retrieve the security entries associated with the event frame based on the specified criteria. By default, all security entries for this event frame are returned.

Request

GET eventframes/{webId}/securityentries

URL Parameters

  • webId

    The ID of the event frame. See WebID 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": {}
}
In This Topic
TitleResults for “How to create a CRG?”Also Available in