Delete (Remove User or Group) Cash Flow Permission

DELETE /ws/rest/service/v1/cashflow/permission/{project_number}

Purpose:

Add User/Group to cash flow 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

Input:

All parameters should be URL encoded.

Path Parameter

project_number: Specify the Project number in which the cash flow exists, if not provided, then cash flows are considered to be fetched from Company level.

POST body is a JSON

Note: POST call has input & output both as JSON in the body

Input JSON

{

"data" :

{

"names": ["cash flow 1"],

"user_names" : ["coadmin","donna","PU1"],

"group_names" : [ "group1", "group2" ]

}

Here "cash_flow" are mandatory in options.

In the request body names can be provided in below two formats

1. "names": ["cash flow 1", "cash flow 2", "cash flow 3"] For one or more cash flows.

2. "names": "cash flow 1" For only one cash flow.

If names not provided, then error response will be provided to user to provide cash flows .

Output:

JSON object containing 'status', 'data', 'message'

message will be present if status is not 200 otherwise it will be "success".

Delete (Remove User/Group) Cash flow Permission Sample Response

1) Response for success case:

{

"data": {

"cash flow 1": {

"deleted_groups": [],

"deleted_users": [

"PU1 P"

]

}

},

"message": [

"success"

],

"status": 200

}

2) Response for partial success case:

{

"data": {

"cash flow 1": {

"deleted_groups": [],

"deleted_users": [

"PU1 P"

]

}

},

"message": [

{

"name": "cash flow 2",

"status": "delete permission error message"

},

{

"name": "cash flow 3",

"status": "delete permission error message"

}

],

"status": 3000

}

Related Topics