Access Rights
- Last UpdatedJul 15, 2022
- 1 minute read
- PI System
- PI Vision API Reference
- Developer
Return access rights for the current user.
Get Access Rights
Calculate and return current user permissions to perform import/export operations.
Read- Indicates that user can only read, but cannot write any data.ReadWrite- Indicates that user has full access to read and write data.
Request
GET /api/v1/AccessRights
Request Headers
| Required | Header | Type | Description |
|---|---|---|---|
| yes | X-Requested-With | string | Any value. |
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | AccessRights | Success. |
| 401 | None | Unauthorized. |
| 403 | None | Forbidden. |
| 500 | None | Internal server error. |
Example response body
200 Response
{
"AccessLevel": "ReadWrite"
}
Definitions
AccessRights
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| AccessLevel | AccessLevel | true | false | UtilityAccessKey values |
{
"AccessLevel": "None"
}
AccessLevel
UtilityAccessKey values
Enumerated Values
| Property | Value | Description |
|---|---|---|
| None | None | Access not granted. |
| Read | Read | Read-only access. |
| ReadWrite | ReadWrite | Read-write access. |