Update BP Record

PUT /ws/rest/service/v1/bp/record/{project_number}

Purpose

Update record in a specific BP in a shell based on shell number or from company level if project/shell number is not provided.

Path Parameter

project_number: Specify the Project number in which the records exists; if not provided, records are from Company Level.

Request Parameters

All parameters should be URL encoded. The input JSON provides various options to be considered for fetching the data.

Notes:

Auto-Creation setting is mandatory in Shell or Company BP Setup in Admin mode.
The "record_no" is mandatory and is part of the data for the UpdateBPRecord call.
The "bpname" is mandatory and is part of options form parameter.
The system validates whether the selected user's company exists. If not, the system adds the Partner Company as a Member Company.
The WFCurrentStepName and WFActionName are part of the "workflow_details" and are for Workflow-type BPs. If the values for the WFCurrentStepName and WFActionName are provided, the record will be updated and sent to the next step of the workflow. If the values for the WFCurrentStepName and WFActionName are not provided, the record will be updated but will remain in same workflow step.
The LineItemIdentifier is a part of options form parameter. The LineItemIdentifier value will be the DE name present in the lineItem. The DE name present in the lineItem should be present in the "data" (input record JSON) with its value.
When you update a record using this REST service to add standard lines, do not include LineItemIdentifier as part of the options in the request. Updating the standard lines in a Payment Application BP is not currently supported.
You cannot modify the BP Data Picker alone if it has an associated Line Item Data Picker value. You must provide both the BP Data Picker value and BP Line Item Data Picker value to modify any one of them.
The "Enable Step for Integration" option in the Workflow BP setup is not available for the REST integration.
Summary CBS codes cannot be included in Cost allocation line items when creating or updating commits of SPA BP records through REST services.
When a data element (DE) is set to auto-populate from a Base Commit, Change Commit, or an SOV, the auto-populated values takes precedence when 0 value is sent for those DEs in CSV or Excel or REST API. Any value specified in the input request is ignored and auto-populated values from Base and Change Commit or SOV are used.
When a required DE is not included or included with a blank value in the request, a successful response is returned by the REST service. However, an error message is displayed when a required Rich Text Editor (RTE) DE is not included in the request, or included with a blank value.

Behavior of the Due Date (due_date) Field

When you create workflow BP records through a REST service, the system currently sets the Due Date automatically based on the Workflow Settings; the Due Date provided in the input request is ignored.

When you update workflow BP records through a REST service, you cannot change the Due Date.

Additional Information

The "record_no" is mandatory, and it is a part of data for the UpdateBPRecord call.

The "bpname" is mandatory, and it is a part of options form parameter.

The "WFCurrentStepName" and "WFActionName" are part of the "workflow_details," and they are for Workflow type BPs.

If the values for "WFCurrentStepName" and "WFActionName" are provided, the record will be updated and sent to the next step of workflow.

If the values for "WFCurrentStepName" and "WFActionName" are not provided, the record will be updated but will remain in the same workflow step.

The "LineItemIdentifier" is a part of options form parameter. The "LineItemIdentifier" value will be the DE name that is present in the "lineItem." The DE is present in the "data" (input record JSON) along with its value.

In the "_bp_lineitems" section, if "row_id" is modified along with other attributes, update the Fund Code for the line item in the "data" (with the "Lineitemidentifier" specified).

Any auto-populate DEs that are based on the "row_id" (Fund Code) will be populated by means of the update.

Formulas based on auto-populate DES will be evaluated in the line item.

When a record is routed to next step for workflow BPs, if the "work_flow" details are specified, verify that in the Fund sheet the line item amount is rolled up to the modified Fund Code.

The rules that are based on the Fund Code will be evaluated when routing the record through the "UpdateBPRecord" call.

For non-workflow Fund BP, if in the input request the status is specified along with the Fund Code in the line item, upon successful request the existing line item will be updated with the specified Fund Code, and the Fund Sheet will show the line item amount against the modified Fund Code.

Note: For the line item with both Fund Code and CBS Code BPs, only the Fund Code for the existing line items can be modified, by using the "UpdateBPRecord" call.

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 Request

PUT

{

"options":{

"bpname":"line6",

"LineItemIdentifier":"upwoLISAS",

"workflow_details" :

{

"WFCurrentStepName":"Step 4",

"WFActionName":"Line 3"

}

},

"data": [

{

"ugenUserIDPK":null,

"_bp_lineitems":

[

{

"ugenShellPK":"/AP1",

"uuu_tab_id":"Standard",

"short_desc":"desc3_m11",

"upwoLISAS":"0001",

"uuu_line_item_status":"Active"

}

],

"record_no":"uxli6-0020",

"title":"new title"

}

]

}

Adding LineItemIdentifiers in the BP Design

To add LineItemIdentifier in the BP design:

Create a custom DE with DD: Sys Auto Sequence.
Add this DE to the Detail Form of the BP with the line items that need to be updated.
Go to the Company Workspace tab and switch to Admin mode.
In the left Navigator, select uDesigner, and then select Business Processes.
Open the BP.
From the toolbar, click Open, and select Data Elements to open the Data Elements Configuration window.
Click the Auto Sequence tab and click Add.
Select the data element added in the Detail Form and select the level as: Per Record.
Provide the start value and click Create.
Add the parameter "Sys Sequence counter" and click OK.
Select Integration, select Detail, and then add the DE.
Set the "Direction" to "Both" for that DE.
Complete and deploy the BP.
In the body of the request, add the DE name as Lineitem identifier and send the request.

Sample Request to Delete a Line-Item

To delete a line-Item using update request, the field "_delete_line_item" should be used (value of which will be comma separated values of LineItemIdentifier DE) as shown in the following example:

Sample: Delete line-item input

{

"options": {

"bpname":"line6",

"LineItemIdentifier":"upwoLISAS"

},

"data": [

{

"ugenUserIDPK":null,

"_delete_bp_lineitems":"0002,0001,0003",

"record_no":"uxli6-0021",

"title":"title_m112244"

}

]

}

Note: PUT call has input & output, both as JSON in the body.

Sample Response

{

"data": [],

"message": [

{

"_record_status": "success",

"record": {

"ugenUserIDPK": null,

"record_no": "uxli6-0021",

"title": "title_m112244"

}

],

"status": 200

}

An Integration user can modify the Fund Code for an existing record line items, by using UpdateBPRecord call.

A user can see the Fund Code for an existing record line items being updated and the line item amount is rolled up to the Fund Sheet, based on updated Fund Code.

Data Elements in Line Items

If the following Data Elements are present in the Line Items, they will not be updated during UpdateBPRecord call.

bitemid
budgetid
sovitemid
uuu_cm0_picker
xid
ds_code
fsm_lineitem_id
asm_lineitem_id
uuu_lat
uuu_long
uuu_company_account_name
uuu_company_account_code
uuu_company_acc_codepicker
uuu_activity_picker
uuu_asset_picker
ref_bpo_lineitem
ref_bpo
ref_rfb
refid
uuu_sovlinum
otherCompanyID
uuu_costcode_picker
scheduled_value
uuu_asset_cum_depreciation
uuu_asset_curr_period_dep
uuu_asset_net_book_value
uuu_unit_price
currencyid
due_date
uuu_asset_calc_as_of_date
uuu_from_date
uuu_issue_date
uuu_last_update_date
uuu_rfb_due_date
uuu_to_date
uuu_week_picker
uuu_datasource
uuu_depreciation_mtd
uuu_line_item_status
row_id
uuu_bid_count
uuu_bidders_count
uuu_planning_item_picker
uuu_proj_picker
record_no
uuu_resc_picker
uuu_role_picker
uuu_commit_short_desc
end_date
uuu_creation_date
uuu_asset_name
uuu_commit_breakdown
uuu_asset_code
uuu_asset_navigation_code
uuu_timescale_units
creator_id
wpid
uuu_cost_costattribute
uuu_cost_external_refid
uuu_cost_status
uuu_cost_cost_type
uuu_cost_description
uuu_cost_item
uuu_cost_owner
uuu_cost_code
uuu_dm_create_date
uuu_file_create_date
uuu_file_issue_date
uuu_dm_percent_complete
uuu_file_size
uuu_file_version
uuu_dm_description
uuu_dm_node_path
uuu_dm_node_name
uuu_file_revision_no
uuu_file_title
uuu_dm_create_by
uuu_file_create_by
uuu_fund_fundcategory
uuu_fund_long_desc
uuu_fund_description
uuu_fund_fundname
uuu_fund_code
uuu_description
uuu_resc_nwd_type
uuu_resc_interest
uuu_resc_proficiency
uuu_resc_skill
uuu_role_status
uuu_role_name
uuu_resc_capacity
uuu_user_address
uuu_user_city
uuu_user_country
uuu_user_email
uuu_user_fax
uuu_user_firstname
uuu_user_homephone
uuu_user_lastname
uuu_user_mobilephone
uuu_user_pager
uuu_user_state
uuu_user_timezone
uuu_user_title
uuu_user_workphone
uuu_user_zip
uuu_resc_status
uuu_resc_code
uuu_resc_name
uuu_early_finish
uuu_early_start,uuu_finish
uuu_late_finish
uuu_late_start
uuu_start
uuu_act_pct_complete
uuu_activity_work_hrs
uuu_duration
uuu_fixed_cost
uuu_float
uuu_labor_cost
uuu_non_labor_cost
uuu_total_cost
uuu_activity_id
uuu_flag_complete
uuu_flag_milestone
uuu_activity_resources
uuu_dependency_type
uuu_activity_name
uuu_outline_code
uuu_cost_li_type

Purpose

Path Parameter

Request Parameters

Additional Information

Response Format

Sample Request

Adding LineItemIdentifiers in the BP Design

Sample Request to Delete a Line-Item

Sample Response

Related Topics