Get BP Records Permission
POST /ws/rest/service/v1/bp/record/permission/list/{project_number}
Purpose
Get 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.
For one or more records
{
"bpname" : "Vendors",
"record_no" : ["VEN-0023","VEN-0024"],
"filter_condition" : "status=Active"
}
For only one record
{
"bpname" : "Vendors",
"record_no" : "VEN-0023",
"filter_condition" : "status=Inactive"
}
"bpname" is mandatory input parameter.
In the request body record_no can be provided in below two formats:
1. "record_no": ["VEN-0023","VEN-0024"] For one or more records.
2. "record_no": "VEN-0023" For only one record.
"record_no" is optional. If no value is specified, all the BP record permission will be returned.
"filter_condition" is optional parameter and filter is supported only on "status" field. It will be "AND" condition between "record_no" & "filter_condition".
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-0024": {
"record_status": "Active",
"permissions": [
{
"login_name": "coadmin",
"full_name": "Company Administrator",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "0"
},
"type": "U"
},
{
"full_name": "Space Planners",
"group_name": "Space Planners",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "1"
},
"type": "CG"
}
]
},
"VEN-0023": {
"record_status": "Terminated",
"permissions": [
{
"login_name": "coadmin",
"full_name": "Company Administrator",
"permission": {
"edit_data": "1",
"view": "1",
"modify_permission": "1"
},
"type": "U"
}
]
}
},
"message": [
"success"
],
"status": 200
}
See Also
Update/Modify BP Records Permission
Create (Add User/Group) BP Records Permission
Delete (Remove User/Group) BP Records Permission
Last Published Tuesday, July 1, 2025