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.
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.
Auto-Creation setting is mandatory in Shell or Company BP Setup in Admin mode. During autocreation, if the value in a BP picker does not meet the filtering conditions that have been configured for the created BP, the value of the BP picker is not copied and is left blank. Additionally, in the Step Form of the created BP, any data elements that are configured to auto-populate from the picker are cleared.
The system validates whether the selected user's company exists. If not, the system adds the Partner Company as a Member Company.
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.
If provided, the BP Picker value must meet the configured query conditions. Otherwise, the system returns an Invalid value or multiple records found error.
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, select Open, and select Data Elements to open the Data Elements Configuration window.
- Select the Auto Sequence tab, and select Add.
- Select the data element added in the Detail Form and select the level as: Per Record.
- Provide the start value and select Create.
- Add the parameter "Sys Sequence counter" and select 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.
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
Get BP Record With Attachments
Create BP Record with Attachment
Update BP Record with Attachment
Fetch BP Record List with filter_criteria
Payment Application with Auto-populate from SOV and Commits
Asynchronous Bulk BP Operations
Fetch List of Attached Files in a BP
Download a Single Attached File in a BP
Download Multipart or Large Files
Last Published Friday, October 17, 2025