Upsert BOM Item List
post
/rest/v16/bomItemSetups/actions/upsertBomItemList
Use this endpoint create, update, or delete CPQ BOM hierarchies. This endpoint uses a list format, instead of the hierarchical JSON format.
Request
Supported Media Types
- application/json
Root Schema : BOM Item Setup Upsert BOM Item Tree Collection Request Definitions
Type:
object
Title:
Show Source
BOM Item Setup Upsert BOM Item Tree Collection Request Definitions
-
documents:
object BOM Item List BOM Item Request Definitions
Title:
BOM Item List BOM Item Request Definitions
BOM Item definition for BOM item list upsert requests
Nested Schema : BOM Item List BOM Item Request Definitions
Type:
object
Title:
BOM Item List BOM Item Request Definitions
BOM Item definition for BOM item list upsert requests
Show Source
-
bomItems:
object BOM Item List BOM Item Request Collection Definitions
Title:
BOM Item List BOM Item Request Collection Definitions
BOM Item collection definition for BOM item list upsert requests -
deleteMissingItems:
boolean
Title:
Delete Missing Items
Whether BOM Items and Bom Item Mappings not included in the payload should be deleted.
Nested Schema : BOM Item List BOM Item Request Collection Definitions
Type:
object
Title:
BOM Item List BOM Item Request Collection Definitions
BOM Item collection definition for BOM item list upsert requests
Show Source
Nested Schema : items
Type:
Show Source
array
-
Array of:
object BOM Item List BOM Item Upsert Request Instance Definitions
Title:
BOM Item List BOM Item Upsert Request Instance Definitions
BOM item instance definition for BOM item list upsert requests
Nested Schema : BOM Item List BOM Item Upsert Request Instance Definitions
Type:
object
Title:
BOM Item List BOM Item Upsert Request Instance Definitions
BOM item instance definition for BOM item list upsert requests
Show Source
-
bomItemMappings:
object BOM Item List BOM Item Mapping Request Collection Definitions
Title:
BOM Item List BOM Item Mapping Request Collection Definitions
BOM item mapping collection definition for BOM item list upsert requests -
bomPrice:
number
Title:
BOM Price
BOM Price -
defaultQuantity:
number
Title:
Default Quantity
Default quantity for the BOM item -
effectiveFrom:
string(date)
Title:
Effective From
The effective from date for the BOM item -
effectiveTo:
string(date)
Title:
Effective To
The effective to date for the BOM item -
isIncludedInBasePrice:
boolean
Title:
Is Included In Base Price
Whether the BOM item is included in the base price -
isManufacturingItem:
boolean
Title:
Is Manufacturing Item
Whether the BOM item is a manufacturing item -
isOptional:
boolean
Title:
Is Optional
Whether the BOM item is optional -
isSalesItem:
boolean
Title:
Is Sales Item
Whether the BOM item is a sales item -
itemIdentifier:
string
Title:
Item Identifier
BOM item identifier -
itemType:
string
Title:
Item Type
BOM item type -
label:
string
Title:
Label
BOM item label -
modelPath:
string
Title:
Model Path
The path to a model in the BOM hierarchy -
parentVariableName:
string
Title:
Parent Variable Name
Variable name of the parent BOM item -
partNumber:
string
Title:
Part Number
Part number of the BOM item -
rootVariableName:
string
Title:
Root Variable Name
Variable name of the root BOM item -
sequenceNumber:
integer
Title:
Sequence Number
BOM item sequence number -
variableName:
string
Title:
Variable Name
Variable Name of the BOM item
Nested Schema : BOM Item List BOM Item Mapping Request Collection Definitions
Type:
object
Title:
BOM Item List BOM Item Mapping Request Collection Definitions
BOM item mapping collection definition for BOM item list upsert requests
Show Source
Nested Schema : items
Type:
Show Source
array
-
Array of:
object BOM Item List BOM Item Mapping Request Instance Definitions
Title:
BOM Item List BOM Item Mapping Request Instance Definitions
BOM item mapping instance definition for BOM item list upsert requests
Nested Schema : BOM Item List BOM Item Mapping Request Instance Definitions
Type:
object
Title:
BOM Item List BOM Item Mapping Request Instance Definitions
BOM item mapping instance definition for BOM item list upsert requests
Show Source
-
additionalConfigurationAttributeValue1:
string
Title:
Additional Configuration Attribute Value 1
The value of the first additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue10:
string
Title:
Additional Configuration Attribute Value 10
The value of the tenth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue2:
string
Title:
Additional Configuration Attribute Value 2
The value of the second additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue3:
string
Title:
Additional Configuration Attribute Value 3
The value of the third additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue4:
string
Title:
Additional Configuration Attribute Value 4
The value of the fourth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue5:
string
Title:
Additional Configuration Attribute Value 5
The value of the fifth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue6:
string
Title:
Additional Configuration Attribute Value 6
The value of the sixth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue7:
string
Title:
Additional Configuration Attribute Value 7
The value of the seventh additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue8:
string
Title:
Additional Configuration Attribute Value 8
The value of the eighth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue9:
string
Title:
Additional Configuration Attribute Value 9
The value of the ninth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName1:
string
Title:
Additional Configuration Attribute Variable Name 1
The variable name of the first additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName10:
string
Title:
Additional Configuration Attribute Variable Name 10
The variable name of the tenth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName2:
string
Title:
Additional Configuration Attribute Variable Name 2
The variable name of the second additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName3:
string
Title:
Additional Configuration Attribute Variable Name 3
The variable name of the third additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName4:
string
Title:
Additional Configuration Attribute Variable Name 4
The variable name of the fourth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName5:
string
Title:
Additional Configuration Attribute Variable Name 5
The variable name of the fifth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName6:
string
Title:
Additional Configuration Attribute Variable Name 6
The variable name of the sixth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName7:
string
Title:
Additional Configuration Attribute Variable Name 7
The variable name of the seventh additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName8:
string
Title:
Additional Configuration Attribute Variable Name 8
The variable name of the eighth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName9:
string
Title:
Additional Configuration Attribute Variable Name 9
The variable name of the ninth additional configurable attribute in multiple attribute mapping -
bomItemVariableName:
string
Title:
BOM Item Variable Name
The variable name of the BOM item -
configurationAttributeValue:
string
Title:
Configuration Attribute Value
The value of the configurable attribute -
configurationAttributeVariableName:
string
Title:
Configuration Attribute Variable Name
The variable name of the configurable attribute -
effectiveFrom:
string(date)
Title:
Effective From
The effective from date for the BOM item -
effectiveTo:
string(date)
Title:
Effective To
The effective to date for the BOM item -
parentBOMMappingRuleVariableName:
string
Title:
Parent BOM Mapping Rule Variable Name
The variable name of the BOM Map configuration rule -
variableName:
string
Title:
Variable Name
Variable Name of the BOM item
Response
Supported Media Types
- application/json
Default Response
Root Schema : BOM Item Setup Upsert BOM Item Tree Collection Response Definitions
Type:
object
Title:
BOM Item Setup Upsert BOM Item Tree Collection Response Definitions
Examples
The following examples show how to Use this endpoint create, update, or delete CPQ BOM hierarchies by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL. This endpoint uses a list format, instead of the hierarchical JSON format.
curl - X POST - i -H "Prefer: respond-async" - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/bomItemSetups/actions/upsertMomItemList
Request Body Sample
{ "documents":{ "deleteMissingItems":true, "bomItem":{ "items":[// entries can be in any order { "<root bom>" }, { "<child bom>" } ] } } }
Response Body Sample
{ "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v16/bomItemSetups/actions/upsertBomItemList" }, { "rel": "related", "href": "http://sitename.oracle.com/rest/v16/asyncTasks/3022899700/status" } ] }
Get Async Task Status Examples
URI Endpoint Sample
http://sitename.oracle.com/rest/v16/asyncTasks/3022899700/status
Sample In Progress Task Response Body
{ "progress": "processing", "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v16/asyncTasks/3022899700/status" } ], "completed": false, "requestStatus": "202" }
Sample Completed Task Response Body
{ "progress": "succeeded", "links": [{ "rel": "related", "href": "http://sitename.oracle.com/rest/v14/asyncTasks/3022899700/response" }, { "rel": "self", "href": "http://sitename.oracle.com/rest/v14/asyncTasks/3022899700/status" } ], "completed": true, "requestStatus": 200 }