Create (Add User/Group) BP Records Permission
POST /ws/rest/service/v1/bp/record/permission/{project_number}
Purpose
Add User/Group to 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" : "Vendors"
},
"data": {
"record_no": ["VEN-002598"],
"permissions": [
{
"login_name": "PU1",
"type": "U",
"full_name": "P1 user",
"permission": {
"edit_data": "1",
"modify_permission": "1",
"view": "1"
}
}
]
}
}
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": {
"VEN-0025": {
"record_status": "Active",
"added_users": [PU1],
"permissions": [
{
"login_name": "PU1",
"full_name": "PU1 P",
"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": "1"
},
"type": "U"
},
{
"full_name": "Space Planners",
"group_name": "Space Planners",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "1"
},
"type": "CG"
}
],
"added_groups": []
}
},
"message": [
"success"
],
"status": 200
}
See Also
Update/Modify BP Records Permission
Delete (Remove User/Group) BP Records Permission
Last Published Wednesday, April 9, 2025