Update BP Record Permission

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

Purpose

Add or remove users from a single workflow business process record of an active project/shell.

Note: When a user from a company is removed from a record and that user is the only representative of their company on that record, the company’s permission to access the record is also removed to maintain data security and integrity. If a user from the same company is added back to the record at any other phase, the previously removed user will begin to see the entry in the log again.

Request Format

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

In options JSON map : { "project_number": "<value>", "bpname": "<value>", "record_no": "<value>", "add_users" : <List of user names>, "remove_users" : <List of user names> }

Project number is an optional input. Add users and remove users are also optional, but one or the other is required. If using add users or remove users, user name is a mandatory input. BP name and record number are mandatory.

Sample Request

{

"options": {

"project_number" : "RE00000",

"bpname" : "Action Items",

"record_no" : "AI-000734",

"add_users" : ["testuser1", "coadmin"],

"remove_users" : ["testuser2", "testuser3"]

}

Response Format

A JSON object is returned in the following format.

{

"data": [{"record_id" : "<Internal record ID for the specified BP record>"}],

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

"status":<integer value>,

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

}

A successful response displays a status code 200.

A failed response displays a message with a status code.

Sample Success Response

{

"data":[{"record_id" : "798"}],

"message":["success" ],

"status":200,

"rest_audit_id" : 720

}

Sample Failed Response

{

"data": [],

"message": ["AI-000734 specified is in Initiation step"],

"status": 17007,

"rest_audit_id": 721

}

Notes for Removing a User

The user should be part of the project/company.
CC user(s)'s permissions can be removed at any time. They will not be able to view records in the Notification or Record log.
The task will be marked closed if required and Permissions will be removed if the user is an assignee and:
- Is not on the current step.
- Is on the current step, the record is not accepted yet, and the user is not the only assignee on the current step.
- Is on the current step, the record is accepted, and the completion policy is set to Single, but the user has not accepted the task.
You cannot remove a user's permissions if that user is an assignee on the current step and:
- The record is not accepted, and the user is the only assignee on the current step.
- The record is accepted, the completion policy is set to Single, and the user has accepted the task.
- The record is accepted, and the completion policy is set to All-Major or All-Consensus.
No mail/notification will be sent when a user is removed from a workflow BP record.
For the Record Received by Me Log View, permissions must be checked. Only records with the necessary permissions will be available for the user to access.

Notes for Adding a User

The user can only be added as a CC user to the current step and will be able to access records under notifications (for the current step) and the BP record log.
The user should be an active user and part of the project/company.
Adding users will not be dependent on Workflow Setup.
The user will be added to the record if they have not been added either as an assignee or CC.
A user cannot be added if the record is terminated.
A mail/notification will be sent when the user is added in the workflow BP record.
Note: If a user is initially added to in-flight records and is subsequently removed and re-added, no notifications will be generated, and the workflow progress will remain unchanged. However, the user will still be included as a CC user in the current step and will have access to the record from the BP log.

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, view-only, or on-hold		Update cannot be performed when project/shell status is Inactive or View-Only or On-Hold.

Purpose

Request Format

Sample Request

Response Format

Sample Success Response

Sample Failed Response

Notes for Removing a User

Notes for Adding a User

Supported Validation Messages and Status Codes

Related Topics