Get BP Record Permission

POST /ws/rest/service/v2/bp/record/wf/permission

Purpose

Retrieve a list of users associated to a single workflow business process record of an active project/shell with Active, View-Only, or On-Hold statuses, including the assignee as well as CCs of the record.

Request Format

Request parameters are specified as a JSON Map {} - structure : { "options":{} }

In options JSON map : "options":{ "project_number": "<value>", "bpname": "<value>", "record_no": "<value>" },

Any other fields in the options map will be ignored.

Project number is an optional input. BP name and record number are mandatory.

Get BP Record Permission - Sample Input JSON

{

"options": {

"project_number" : "RE00000",

"bpname" : "Action Items",

"record_no" : "AI-000734"

}

}

Response Format

A JSON object is returned in the following format.

{

"data": [],

"message": [],

"status": <REST status code value>,

"rest_audit_id": <rest_audit_id value>

}

A successful response displays a status code 200.

A failed response displays a message with a status code.

Response Format

{

"data": [

{

"record_id" : "<Internal record ID for the specified BP record>",

"record_no" : "<Record number for the specified BP record>",

"record_status" : "<BP record status>",

"users" : <List of maps>

}

],

"message": [ "<message string>"],

"status":<integer value>,

"rest_audit_id" : <ID from the rest audit table matching this request>

}

Message will be present if status is not 200; otherwise, it will be "success".

Sample Success Response

{

"data":

[

{

"record_id" : "798",

"record_no" : "AI-000734",

"record_status" : "Pending",

"users" : [

{

"username", "coadmin",

"fullname", "Company Administrator"

},

{

"username", "testuser1",

"fullname", "Test User1"

}

]

}

],

"message":

[

"success"

],

"status":200,

"rest_audit_id" : 720

}

Sample Failed Response

{

"data": [],

"message": [

"Business Process Name is required."

],

"status": 603,

"rest_audit_id": 721

}

Supported Validation Messages and Status Codes

The following validation messages and status codes display in the response when incorrect values are provided in the request:

Field Name

Use-case Scenario

Status Code

Error Message

 

Project status is inactive.

 

Update cannot be performed when project/shell status is Inactive or View-Only or On-Hold.

Related Topics

Business Processes

Create BP Record

Update BP Record

Create BP Record with Attachment

Update BP Record with Attachment

Payment Application with Auto-populate from SOV and Commits

Update BP Record Permission

Add Assignees to Workflow BP Records

Bulk Create Records

Bulk Create Workflow BPs

Bulk Update Records

Bulk Reverse Auto-populate Records

Terminate Workflow and Non-Workflow BP Records

Response Error Codes



Last Published Tuesday, July 1, 2025