Update BP Record
PUT /ws/rest/service/v2/bp/record
Purpose:
Update a record in a specific business process (BP) in a shell by using the project_number value provided from the input JSON options.) If project_number is not provided, update the record at the company level.
To avoid errors and maintain data integrity when using multiple data elements (DEs) with the same field label, ensure that the applicable DEs have the same direction—Input, Output, or Both—or that the combinations of Both/Output or Input/Output are not used.
The input JSON must provide the options used to fetch the data.
This V2 service uses the step form to update the BP record. Required fields and validation rules run against the step form used in the workflow details. If the end step includes a view form, you cannot update it.
Input:
All parameters should be URL encoded.
Both input & output in JSON format in the body.
Note
- Field properties such as read-only in step form are retained. Mandatory fields in the step form must be present in the Integration Form with Direction set as "Both" or "Input."
- Field direction provided in the Integration form is retained.
- In input JSON options, "project_number" specifies the shell where the records exist. If the "project_number" is not provided, records are assumed to be at the company level.
- The "record_no" is mandatory and included in the data.
- The "bpname" is mandatory and included in the options form parameter.
- The system validates whether the selected user's company exists. If not, the Partner Company is added as a Member Company.
- If a Workflow BP record has already been accepted by an assignee, the REST call fails with the error message: Record has already been accepted by Task Assignee.
- WFCurrentStepName and WFActionName are part of "workflow_details" and apply to Workflow-type BPs. If both values are provided, the record is updated and sent to the next workflow step. If not provided, the record is updated but remains in the same workflow step.
Update BP Record Input
{
"options":{
"project_number" : "P-0002",
"bpname":"line6",
"LineItemIdentifier":"upwoLISAS",
"optimizedPickerExecution" : "true",
"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"
}
]
}
Notes:
- 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.
- The optimizedPickerExecution is a part of the options form parameter. The optimizedPickerExecution controls the pickers 'populate' execution, on the existing line items. The values can be True or False.
When the value is True, the Upper Form, or the Lineitem Form, input JSON is required to send the Datapicker DE tag (with values) to trigger 'populate' on the other DEs that are configured per design. If the input JSON does not contain the Datapicker DE property, the system will not process the Datapicker DE as a part of the update to 'populate' the values from the data picker record to the current record and lineitems that get updated.
When the value is False, or non-existent, the system will continue to process according to the existing behavior.
- The "Enable Step for Integration" option in the Workflow BP setup is not available for the REST integration.
Steps to add LineItemIdentifier in the BP design:
- Create a custom DE whose Data definition is 'Sys Auto Sequence'.
- Add this DE to the detail form of the BP whose line items needs to be updated.
- Navigate to Company Workspace > Business Processes and open the BP.
- Navigate to the BP-Home > click Open drop-down > Data Elements. A data element configuration screen appears
- 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 (next to format), add the parameter 'Sys Sequence counter', and click OK.
- Add the DE to Integration > Detail and select "Direction" to "Both" for the DE.
- Complete and deploy the BP.
- In the body of the request add this DE name as Lineitem identifier and send the request.
Delete the Line-Item, using Update Request:
To delete the 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":{
"project_number" : "P-0002",
"bpname":"line6",
"LineItemIdentifier":"upwoLISAS"
},
"data":[
{
"ugenUserIDPK":null,
"_delete_bp_lineitems":"0002,0001,0003",
"record_no":"uxli6-0021",
"title":"title_m112244"
}
]
}
Output:
JSON object containing 'status', 'data', 'message'
A message will be present if status is not 200 .
Status codes are:
1>200 OK, if all update succeeds.
2>3000, if any of records update fails.
Sample: Update BP Record Response
{
"data": [],
"message": [
{
"_record_status": "success",
"record": {
"ugenUserIDPK": null,
"record_no": "uxli6-0021",
"title": "title_m112244"
}
}
],
"status": 200
}
Data Elements in Line Items
If the following Data Elements are present in the Line Items, they will not be updated.
bitemidbudgetidsovitemiduuu_cm0_pickerxidds_codefsm_lineitem_idasm_lineitem_iduuu_latuuu_longuuu_company_account_nameuuu_company_account_codeuuu_company_acc_codepickeruuu_activity_pickeruuu_asset_pickerref_bpo_lineitemref_bporef_rfbrefiduuu_sovlinumotherCompanyIDuuu_costcode_pickerscheduled_valueuuu_asset_cum_depreciationuuu_asset_curr_period_depuuu_asset_net_book_valueuuu_unit_pricecurrencyiddue_dateuuu_asset_calc_as_of_dateuuu_from_dateuuu_issue_dateuuu_last_update_dateuuu_rfb_due_dateuuu_to_dateuuu_week_pickeruuu_datasourceuuu_depreciation_mtduuu_line_item_statusrow_iduuu_bid_countuuu_bidders_countuuu_planning_item_pickeruuu_proj_pickerrecord_nouuu_resc_pickeruuu_role_pickeruuu_commit_short_descend_dateuuu_creation_dateuuu_asset_nameuuu_commit_breakdownuuu_asset_codeuuu_asset_navigation_codeuuu_timescale_unitscreator_idwpiduuu_cost_costattributeuuu_cost_external_refiduuu_cost_statusuuu_cost_cost_typeuuu_cost_descriptionuuu_cost_itemuuu_cost_owneruuu_cost_codeuuu_dm_create_dateuuu_file_create_dateuuu_file_issue_dateuuu_dm_percent_completeuuu_file_sizeuuu_file_versionuuu_dm_descriptionuuu_dm_node_pathuuu_dm_node_nameuuu_file_revision_nouuu_file_titleuuu_dm_create_byuuu_file_create_byuuu_fund_fundcategoryuuu_fund_long_descuuu_fund_descriptionuuu_fund_fundnameuuu_fund_codeuuu_descriptionuuu_resc_nwd_typeuuu_resc_interestuuu_resc_proficiencyuuu_resc_skilluuu_role_statusuuu_role_nameuuu_resc_capacityuuu_user_addressuuu_user_cityuuu_user_countryuuu_user_emailuuu_user_faxuuu_user_firstnameuuu_user_homephoneuuu_user_lastnameuuu_user_mobilephoneuuu_user_pageruuu_user_stateuuu_user_timezoneuuu_user_titleuuu_user_workphoneuuu_user_zipuuu_resc_statusuuu_resc_codeuuu_resc_nameuuu_early_finishuuu_early_start,uuu_finishuuu_late_finishuuu_late_startuuu_startuuu_act_pct_completeuuu_activity_work_hrsuuu_durationuuu_fixed_costuuu_floatuuu_labor_costuuu_non_labor_costuuu_total_costuuu_activity_iduuu_flag_completeuuu_flag_milestoneuuu_activity_resourcesuuu_dependency_typeuuu_activity_nameuuu_outline_codeuuu_cost_li_type
Related Topics
Update BP Record with Attachment
Create BP Record with Attachment
Bulk Reverse Auto-populate Records
Payment Application with Auto-populate from SOV and Commits
Add Assignees to Workflow BP Records
Last Published Tuesday, June 23, 2026