Update/Modify BP Records Permission
PUT /ws/rest/service/v1/bp/record/permission/{project_number}
Purpose
Update non-workflow records permission (in user mode) of a specific BP in a shell based on shell number or from company level if project/shell number is not provided.
The input JSON shall provide various options to be considered for fetching the data
Request Format
All parameters should be URL encoded.
Path Parameter
project_number: Specify the Project number in which the records exists; if not provided, records are fetched from Company Level.
POST body is a JSON
Note: POST call has input & output both as JSON in the body.
{
"options":{
"bpname" : "simple1"
},
"data": {
"record_no": ["uxss1-0007", "uxss1-0006", "uxss1-0005"]
"permissions": [
{
"login_name": "coadmin",
"type": "U",
"full_name": "Company Administrator",
"permission": {
"edit_data": "1",
"modify_permission": "0",
"view": "1"
}
}
{
"full_name": "Building Managers",
"group_name": "Building Managers",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "0"
},
"type": "PG"
}
]
}
}
Here "bpname" & "record_no" are mandatory in options.
In the request body record_no can be provided in below two formats
1. "record_no": ["uxss1-0007", "uxss1-0006", "uxss1-0005"] For one or more records.
2. "record_no": "uxss1-0007" For only one record.
If record_no not provided, error response will be provided to user to provide record_number.
Response Format
A JSON object is returned in the following format.
{
"data": [],
"message": [],
"status": <REST status code value>
}
A successful response displays a status code 200.
A failed response displays a message with a status code.
Sample Success Response
{
"data": {
"uxss1-0007": {
"record_status": "Active",
"permissions": [
{
"login_name": "firstname",
"full_name": "Firstname Lastname",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "1"
},
"type": "U"
},
{
"login_name": "coadmin",
"full_name": "Company Administrator",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "0"
},
"type": "U"
},
{
"full_name": "Building Managers",
"group_name": "Building Managers",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "0"
},
"type": "PG"
}
],
"updated_users": [
"coadmin"
],
"updated_groups": [
"Building Managers"
]
},
"uxss1-0005": {
"record_status": "Terminated",
"permissions": [
{
"login_name": "coadmin",
"full_name": "Company Administrator",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "1"
},
"type": "U"
}
],
"updated_users": [],
"updated_groups": []
},
"uxss1-0006": {
"record_status": "Active",
"permissions": [
{
"login_name": "coadmin",
"full_name": "Company Administrator",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "0"
},
"type": "U"
},
{
"login_name": "firstname",
"full_name": "Firstname Lastname",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "1"
},
"type": "U"
},
{
"full_name": "Building Managers",
"group_name": "Building Managers",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "0"
},
"type": "PG"
}
],
"updated_users": [
"coadmin"
],
"updated_groups": [
"Building Managers"
]
}
},
"message": [
"success"
],
"status": 200
}
See Also
Create (Add User/Group) BP Records Permission
Delete (Remove User/Group) BP Records Permission
Last Published Tuesday, April 15, 2025