Update a BOM Item Tree
post
/rest/v19/bomItemSetups/{bomItemVarName}/actions/updateBomItemTree
Use this endpoint to update the hierarchical structure and BOM item mappings for the specified root BOM item.
Request
Supported Media Types
- application/json
Path Parameters
-
bomItemVarName(required): string
Variable Name of the BOM item
Root Schema : BOM Item Setup Update BOM Item Tree Request Definitions
Type:
objectTitle:
Show Source
BOM Item Setup Update BOM Item Tree Request Definitions-
bomItem:
object BOM Item Setups Update BOM Item Tree Request Definitions
Title:
BOM Item Setups Update BOM Item Tree Request DefinitionsBOM item setups update BOM item tree request definitions
Nested Schema : BOM Item Setups Update BOM Item Tree Request Definitions
Type:
objectTitle:
BOM Item Setups Update BOM Item Tree Request DefinitionsBOM item setups update BOM item tree request definitions
Show Source
-
_sync_action:
string
Title:
Sync ActionEach entity in the payload should have it's "_sync_action" set to one of "create", "update", "delete" to define the behavior of that entities data -
bomItemMappings:
object BOM Item Tree BOM Item Mapping Request Collection Definitions
Title:
BOM Item Tree BOM Item Mapping Request Collection DefinitionsBOM item mapping collection definition for BOM item tree update requests -
bomPrice:
number
Title:
BOM PriceBOM Price -
children:
object BOM Item Tree BOM Item Collection Update Request Definitions
Title:
BOM Item Tree BOM Item Collection Update Request DefinitionsBOM item collection definition for BOM item tree update requests -
defaultQuantity:
number
Title:
Default QuantityDefault quantity for the BOM item -
effectiveFrom:
string(date)
Title:
Effective FromThe effective from date for the BOM item -
effectiveTo:
string(date)
Title:
Effective ToThe effective to date for the BOM item -
isIncludedInBasePrice:
boolean
Title:
Is Included In Base PriceWhether the BOM item is included in the base price -
isManufacturingItem:
boolean
Title:
Is Manufacturing ItemWhether the BOM item is a manufacturing item -
isOptional:
boolean
Title:
Is OptionalWhether the BOM item is optional -
isSalesItem:
boolean
Title:
Is Sales ItemWhether the BOM item is a sales item -
itemIdentifier:
string
Title:
Item IdentifierBOM item identifier -
itemType:
string
Title:
Item TypeBOM item type -
label:
string
Title:
LabelBOM item label -
modelPath:
string
Title:
Model PathThe path to a model in the BOM hierarchy -
parentVariableName:
string
Title:
Parent Variable NameVariable name of the parent BOM item -
partNumber:
string
Title:
Part NumberPart number of the BOM item -
rootVariableName:
string
Title:
Root Variable NameVariable name of the root BOM item -
sequenceNumber:
integer
Title:
Sequence NumberBOM item sequence number -
variableName:
string
Title:
Variable NameVariable Name of the BOM item
Nested Schema : BOM Item Tree BOM Item Mapping Request Collection Definitions
Type:
objectTitle:
BOM Item Tree BOM Item Mapping Request Collection DefinitionsBOM item mapping collection definition for BOM item tree update requests
Show Source
Nested Schema : BOM Item Tree BOM Item Collection Update Request Definitions
Type:
objectTitle:
BOM Item Tree BOM Item Collection Update Request DefinitionsBOM item collection definition for BOM item tree update requests
Show Source
Nested Schema : items
Type:
Show Source
array-
Array of:
object BOM Item Tree BOM Item Mapping Request Instance Definitions
Title:
BOM Item Tree BOM Item Mapping Request Instance DefinitionsBOM item mapping instance definition for BOM item tree update requests
Nested Schema : BOM Item Tree BOM Item Mapping Request Instance Definitions
Type:
objectTitle:
BOM Item Tree BOM Item Mapping Request Instance DefinitionsBOM item mapping instance definition for BOM item tree update requests
Show Source
-
_sync_action:
string
Title:
Sync ActionEach entity in the payload should have it's "_sync_action" set to one of "create", "update", "delete" to define the behavior of that entities data -
additionalConfigurationAttributeValue1:
string
Title:
Additional Configuration Attribute Value 1The value of the first additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue10:
string
Title:
Additional Configuration Attribute Value 10The value of the tenth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue2:
string
Title:
Additional Configuration Attribute Value 2The value of the second additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue3:
string
Title:
Additional Configuration Attribute Value 3The value of the third additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue4:
string
Title:
Additional Configuration Attribute Value 4The value of the fourth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue5:
string
Title:
Additional Configuration Attribute Value 5The value of the fifth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue6:
string
Title:
Additional Configuration Attribute Value 6The value of the sixth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue7:
string
Title:
Additional Configuration Attribute Value 7The value of the seventh additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue8:
string
Title:
Additional Configuration Attribute Value 8The value of the eighth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue9:
string
Title:
Additional Configuration Attribute Value 9The value of the ninth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName1:
string
Title:
Additional Configuration Attribute Variable Name 1The variable name of the first additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName10:
string
Title:
Additional Configuration Attribute Variable Name 10The variable name of the tenth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName2:
string
Title:
Additional Configuration Attribute Variable Name 2The variable name of the second additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName3:
string
Title:
Additional Configuration Attribute Variable Name 3The variable name of the third additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName4:
string
Title:
Additional Configuration Attribute Variable Name 4The variable name of the fourth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName5:
string
Title:
Additional Configuration Attribute Variable Name 5The variable name of the fifth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName6:
string
Title:
Additional Configuration Attribute Variable Name 6The variable name of the sixth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName7:
string
Title:
Additional Configuration Attribute Variable Name 7The variable name of the seventh additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName8:
string
Title:
Additional Configuration Attribute Variable Name 8The variable name of the eighth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName9:
string
Title:
Additional Configuration Attribute Variable Name 9The variable name of the ninth additional configurable attribute in multiple attribute mapping -
bomItemVariableName:
string
Title:
BOM Item Variable NameThe variable name of the BOM item -
configurationAttributeValue:
string
Title:
Configuration Attribute ValueThe value of the configurable attribute -
configurationAttributeVariableName:
string
Title:
Configuration Attribute Variable NameThe variable name of the configurable attribute -
effectiveFrom:
string(date)
Title:
Effective FromThe effective from date for the BOM item -
effectiveTo:
string(date)
Title:
Effective ToThe effective to date for the BOM item -
parentBOMMappingRuleVariableName:
string
Title:
Parent BOM Mapping Rule Variable NameThe variable name of the BOM Map configuration rule -
variableName:
string
Title:
Variable NameVariable Name of the BOM item
Nested Schema : items
Type:
Show Source
array-
Array of:
object BOM Item Tree Child BOM Item Instance Update Request Definitions
Title:
BOM Item Tree Child BOM Item Instance Update Request DefinitionsChild BOM item instance definition for BOM item tree update requests
Nested Schema : BOM Item Tree Child BOM Item Instance Update Request Definitions
Type:
objectTitle:
BOM Item Tree Child BOM Item Instance Update Request DefinitionsChild BOM item instance definition for BOM item tree update requests
Show Source
-
_sync_action:
string
Title:
Sync ActionEach entity in the payload should have it's "_sync_action" set to one of "create", "update", "delete" to define the behavior of that entities data -
bomItemMappings:
object BOM Item Mappings
Title:
BOM Item MappingsBOM item mappings for the BOM Item -
bomPrice:
number
Title:
BOM PriceBOM Price -
children:
object Children
Title:
ChildrenChild BOM Items -
defaultQuantity:
number
Title:
Default QuantityDefault quantity for the BOM item -
effectiveFrom:
string(date)
Title:
Effective FromThe effective from date for the BOM item -
effectiveTo:
string(date)
Title:
Effective ToThe effective to date for the BOM item -
isIncludedInBasePrice:
boolean
Title:
Is Included In Base PriceWhether the BOM item is included in the base price -
isManufacturingItem:
boolean
Title:
Is Manufacturing ItemWhether the BOM item is a manufacturing item -
isOptional:
boolean
Title:
Is OptionalWhether the BOM item is optional -
isSalesItem:
boolean
Title:
Is Sales ItemWhether the BOM item is a sales item -
itemIdentifier:
string
Title:
Item IdentifierBOM item identifier -
itemType:
string
Title:
Item TypeBOM item type -
label:
string
Title:
LabelBOM item label -
modelPath:
string
Title:
Model PathThe path to a model in the BOM hierarchy -
parentVariableName:
string
Title:
Parent Variable NameVariable name of the parent BOM item -
partNumber:
string
Title:
Part NumberPart number of the BOM item -
rootVariableName:
string
Title:
Root Variable NameVariable name of the root BOM item -
sequenceNumber:
integer
Title:
Sequence NumberBOM item sequence number -
variableName:
string
Title:
Variable NameVariable Name of the BOM item
Nested Schema : BOM Item Mappings
Type:
objectTitle:
BOM Item MappingsBOM item mappings for the BOM Item
Nested Schema : Children
Type:
objectTitle:
ChildrenChild BOM Items
Response
Supported Media Types
- application/json
Default Response
Root Schema : BOM Item Setup Update BOM Item Tree Response Definitions
Type:
objectTitle:
Show Source
BOM Item Setup Update BOM Item Tree Response Definitions-
processedBomItem:
object BOM Item Setups Create And Update Tree Response Definitions
Title:
BOM Item Setups Create And Update Tree Response DefinitionsBOM item setups create and update tree response definitions
Nested Schema : BOM Item Setups Create And Update Tree Response Definitions
Type:
objectTitle:
BOM Item Setups Create And Update Tree Response DefinitionsBOM item setups create and update tree response definitions
Show Source
-
_state:
object BOM Item State Definitions
Title:
BOM Item State DefinitionsBOM item state definitions. -
bomItemMappings:
object BOM Item Tree BOM Item Mapping Collection Definitions
Title:
BOM Item Tree BOM Item Mapping Collection DefinitionsBOM item mapping collection definition for BOM item tree responses -
bomPrice:
number
Title:
BOM PriceBOM Price -
children:
object BOM Item Tree BOM Item Collection Definitions
Title:
BOM Item Tree BOM Item Collection DefinitionsBOM item collection definition for BOM item tree responses -
configurableFlag:
boolean
Title:
Configurable FlagWhether the BOM item tree is configurable -
defaultQuantity:
number
Title:
Default QuantityDefault quantity for the BOM item -
effectiveFrom:
string(date)
Title:
Effective FromThe effective from date for the BOM item -
effectiveTo:
string(date)
Title:
Effective ToThe effective to date for the BOM item -
isIncludedInBasePrice:
boolean
Title:
Is Included In Base PriceWhether the BOM item is included in the base price -
isManufacturingItem:
boolean
Title:
Is Manufacturing ItemWhether the BOM item is a manufacturing item -
isModel:
boolean
Title:
Is ModelWhether the BOM item is a model -
isOptional:
boolean
Title:
Is OptionalWhether the BOM item is optional -
isRootModel:
boolean
Title:
Is Root ModelWhether the BOM item is the root model -
isSalesItem:
boolean
Title:
Is Sales ItemWhether the BOM item is a sales item -
itemIdentifier:
string
Title:
Item IdentifierBOM item identifier -
itemType:
string
Title:
Item TypeBOM item type -
label:
string
Title:
LabelBOM item label -
modelPath:
string
Title:
Model PathThe path to a model in the BOM hierarchy -
parentVariableName:
string
Title:
Parent Variable NameVariable name of the parent BOM item -
partNumber:
string
Title:
Part NumberPart number of the BOM item -
rootVariableName:
string
Title:
Root Variable NameVariable name of the root BOM item -
sequenceNumber:
integer
Title:
Sequence NumberBOM item sequence number -
treeHasError:
boolean
Title:
Tree Has ErrorWhether the BOM tree has any BOM items with errors -
treeHasModel:
boolean
Title:
Tree Has ModelWhether the BOM tree has a model in it -
variableName:
string
Title:
Variable NameVariable Name of the BOM item
Nested Schema : BOM Item State Definitions
Type:
objectTitle:
BOM Item State DefinitionsBOM item state definitions.
Show Source
-
attributes:
object BOM Item Attribute State Definitions
Title:
BOM Item Attribute State DefinitionsBOM item attribute level state definitions. -
hasError:
boolean
Title:
Has ErrorBoolean value that specifies whether any error that occurred has been assigned to the entry itself. -
messages:
array Messages
Title:
MessagesArray of messages that have been generated for a specific object.
Nested Schema : BOM Item Tree BOM Item Mapping Collection Definitions
Type:
objectTitle:
BOM Item Tree BOM Item Mapping Collection DefinitionsBOM item mapping collection definition for BOM item tree responses
Show Source
Nested Schema : BOM Item Tree BOM Item Collection Definitions
Type:
objectTitle:
BOM Item Tree BOM Item Collection DefinitionsBOM item collection definition for BOM item tree responses
Show Source
Nested Schema : BOM Item Attribute State Definitions
Type:
objectTitle:
BOM Item Attribute State DefinitionsBOM item attribute level state definitions.
Show Source
-
bomPrice:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
defaultQuantity:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
effectiveFrom:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
effectiveTo:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
isIncludedInBasePrice:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
isManufacturingItem:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
isModel:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
isOptional:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
isRootModel:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
isSalesItem:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
itemIdentifier:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
itemType:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
label:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
modelPath:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
parentVariableName:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
partNumber:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
rootVariableName:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
sequenceNumber:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
treeHasModel:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
variableName:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions.
Nested Schema : Messages
Type:
arrayTitle:
MessagesArray of messages that have been generated for a specific object.
Show Source
-
Array of:
string
An error, warning, or informational message.
Nested Schema : Attribute State Definitions
Type:
objectTitle:
Attribute State DefinitionsAttribute level state definitions.
Show Source
-
hasError:
boolean
Title:
Has ErrorBoolean value that specifies whether any error that occurred has been assigned to the attribute itself. -
messages:
array Messages
Title:
MessagesArray of messages that have been generated for a specific attribute.
Nested Schema : Messages
Type:
arrayTitle:
MessagesArray of messages that have been generated for a specific attribute.
Show Source
-
Array of:
string
An error, warning, or informational message.
Nested Schema : items
Type:
Show Source
array-
Array of:
object BOM Item Tree BOM Item Mapping Instance Definitions
Title:
BOM Item Tree BOM Item Mapping Instance DefinitionsBOM item mapping instance definition for BOM item tree responses
Nested Schema : BOM Item Tree BOM Item Mapping Instance Definitions
Type:
objectTitle:
BOM Item Tree BOM Item Mapping Instance DefinitionsBOM item mapping instance definition for BOM item tree responses
Show Source
-
_state:
object BOM Item Mapping State Definitions
Title:
BOM Item Mapping State DefinitionsBOM item mapping state definitions. -
additionalConfigurationAttributeValue1:
string
Title:
Additional Configuration Attribute Value 1The value of the first additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue10:
string
Title:
Additional Configuration Attribute Value 10The value of the tenth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue2:
string
Title:
Additional Configuration Attribute Value 2The value of the second additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue3:
string
Title:
Additional Configuration Attribute Value 3The value of the third additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue4:
string
Title:
Additional Configuration Attribute Value 4The value of the fourth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue5:
string
Title:
Additional Configuration Attribute Value 5The value of the fifth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue6:
string
Title:
Additional Configuration Attribute Value 6The value of the sixth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue7:
string
Title:
Additional Configuration Attribute Value 7The value of the seventh additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue8:
string
Title:
Additional Configuration Attribute Value 8The value of the eighth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeValue9:
string
Title:
Additional Configuration Attribute Value 9The value of the ninth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName1:
string
Title:
Additional Configuration Attribute Variable Name 1The variable name of the first additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName10:
string
Title:
Additional Configuration Attribute Variable Name 10The variable name of the tenth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName2:
string
Title:
Additional Configuration Attribute Variable Name 2The variable name of the second additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName3:
string
Title:
Additional Configuration Attribute Variable Name 3The variable name of the third additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName4:
string
Title:
Additional Configuration Attribute Variable Name 4The variable name of the fourth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName5:
string
Title:
Additional Configuration Attribute Variable Name 5The variable name of the fifth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName6:
string
Title:
Additional Configuration Attribute Variable Name 6The variable name of the sixth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName7:
string
Title:
Additional Configuration Attribute Variable Name 7The variable name of the seventh additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName8:
string
Title:
Additional Configuration Attribute Variable Name 8The variable name of the eighth additional configurable attribute in multiple attribute mapping -
additionalConfigurationAttributeVariableName9:
string
Title:
Additional Configuration Attribute Variable Name 9The variable name of the ninth additional configurable attribute in multiple attribute mapping -
bomItemVariableName:
string
Title:
BOM Item Variable NameThe variable name of the BOM item -
configurationAttributeValue:
string
Title:
Configuration Attribute ValueThe value of the configurable attribute -
configurationAttributeVariableName:
string
Title:
Configuration Attribute Variable NameThe variable name of the configurable attribute -
effectiveFrom:
string(date)
Title:
Effective FromThe effective from date for the BOM item -
effectiveTo:
string(date)
Title:
Effective ToThe effective to date for the BOM item -
parentBOMMappingRuleVariableName:
string
Title:
Parent BOM Mapping Rule Variable NameThe variable name of the BOM Map configuration rule -
variableName:
string
Title:
Variable NameVariable Name of the BOM item
Nested Schema : BOM Item Mapping State Definitions
Type:
objectTitle:
BOM Item Mapping State DefinitionsBOM item mapping state definitions.
Show Source
-
attributes:
object BOM Item Mapping Attribute State Definitions
Title:
BOM Item Mapping Attribute State DefinitionsBOM item mapping attribute level state definitions. -
hasError:
boolean
Title:
Has ErrorBoolean value that specifies whether any error that occurred has been assigned to the entry itself. -
messages:
array Messages
Title:
MessagesArray of messages that have been generated for a specific object.
Nested Schema : BOM Item Mapping Attribute State Definitions
Type:
objectTitle:
BOM Item Mapping Attribute State DefinitionsBOM item mapping attribute level state definitions.
Show Source
-
additionalConfigurationAttributeValue1:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeValue10:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeValue2:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeValue3:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeValue4:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeValue5:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeValue6:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeValue7:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeValue8:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeValue9:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeVariableName1:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeVariableName10:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeVariableName2:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeVariableName3:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeVariableName4:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeVariableName5:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeVariableName6:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeVariableName7:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeVariableName8:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
additionalConfigurationAttributeVariableName9:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
bomItemVariableName:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
configurationAttributeValue:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
configurationAttributeVariableName:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
effectiveFrom:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
effectiveTo:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
parentBOMMappingRuleVariableName:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions. -
variableName:
object Attribute State Definitions
Title:
Attribute State DefinitionsAttribute level state definitions.
Nested Schema : Messages
Type:
arrayTitle:
MessagesArray of messages that have been generated for a specific object.
Show Source
-
Array of:
string
An error, warning, or informational message.
Nested Schema : items
Type:
Show Source
array-
Array of:
object BOM Item Tree Child BOM Item Instance Definitions
Title:
BOM Item Tree Child BOM Item Instance DefinitionsChild BOM item instance definition for BOM item tree responses
Nested Schema : BOM Item Tree Child BOM Item Instance Definitions
Type:
objectTitle:
BOM Item Tree Child BOM Item Instance DefinitionsChild BOM item instance definition for BOM item tree responses
Show Source
-
_state:
object BOM Item State Definitions
Title:
BOM Item State DefinitionsBOM item state definitions. -
bomItemMappings:
object BOM Item Mappings
Title:
BOM Item MappingsBOM item mappings for the BOM Item -
bomPrice:
number
Title:
BOM PriceBOM Price -
children:
object Children
Title:
ChildrenChild BOM Items -
defaultQuantity:
number
Title:
Default QuantityDefault quantity for the BOM item -
effectiveFrom:
string(date)
Title:
Effective FromThe effective from date for the BOM item -
effectiveTo:
string(date)
Title:
Effective ToThe effective to date for the BOM item -
isIncludedInBasePrice:
boolean
Title:
Is Included In Base PriceWhether the BOM item is included in the base price -
isManufacturingItem:
boolean
Title:
Is Manufacturing ItemWhether the BOM item is a manufacturing item -
isModel:
boolean
Title:
Is ModelWhether the BOM item is a model -
isOptional:
boolean
Title:
Is OptionalWhether the BOM item is optional -
isRootModel:
boolean
Title:
Is Root ModelWhether the BOM item is the root model -
isSalesItem:
boolean
Title:
Is Sales ItemWhether the BOM item is a sales item -
itemIdentifier:
string
Title:
Item IdentifierBOM item identifier -
itemType:
string
Title:
Item TypeBOM item type -
label:
string
Title:
LabelBOM item label -
modelPath:
string
Title:
Model PathThe path to a model in the BOM hierarchy -
parentVariableName:
string
Title:
Parent Variable NameVariable name of the parent BOM item -
partNumber:
string
Title:
Part NumberPart number of the BOM item -
rootVariableName:
string
Title:
Root Variable NameVariable name of the root BOM item -
sequenceNumber:
integer
Title:
Sequence NumberBOM item sequence number -
variableName:
string
Title:
Variable NameVariable Name of the BOM item
Nested Schema : BOM Item Mappings
Type:
objectTitle:
BOM Item MappingsBOM item mappings for the BOM Item
Nested Schema : Children
Type:
objectTitle:
ChildrenChild BOM Items
Examples
The following example shows how to update the hierarchical BOM structure and BOM item mappings for the specified root BOM item by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X POST -H "Authorization: Bearer <token>" -H "Accept: application/json" https://sitename.oracle.com/rest/v19/bomItemSetups/varioTablet/actions/updatetBomItemTree
Request Body Sample
{
"bomItem": {
"isManufacturingItem": true,
"sequenceNumber": 1000,
"isIncludedInBasePrice": false,
"itemType": "Standard Item",
"variableName": "varioTablet",
"modelPath": null,
"bomPrice": null,
"isSalesItem": true,
"isOptional": false,
"label": "Vario Tablet",
"defaultQuantity": 1.0,
"isRootModel": true,
"effectiveTo": "2023-02-03T21:19:21.000Z",
"rootVariableName": "varioTablet",
"partNumber": "varioTablets:tablets:customTablet",
"itemIdentifier": "1000",
"effectiveTo": "2023-03-03T21:19:21.000Z",
"children": {
"items": [{
"_sync_action": "create",
"bomPrice": 19.99,
"defaultQuantity": 1,
"effectiveFrom": "2022-02-03T21:19:21.000Z",
"effectiveTo": "2023-03-03T21:19:21.000Z",
"isIncludedInBasePrice": true,
"isManufacturingItem": true,
"isOptional": false,
"isRootModel": false,
"isSalesItem": true,
"itemIdentifier": "childItem new",
"itemType": "item",
"label": "new child item",
"modelPath": "",
"parentVariableName": "varioTablet",
"partNumber": "part1",
"rootVariableName": "varioTablet",
"sequenceNumber": 1,
"variableName": "childItemNew"
}, {
"_sync_action": "delete",
"variableName": "childItem"
}
]
},
"_sync_action": "update"
}
}Response Body Sample
{
"processedBomItem": {
"isManufacturingItem": true,
"parentVariableName": null,
"sequenceNumber": 1000,
"isIncludedInBasePrice": false,
"itemType": "Standard Item",
"variableName": "varioTablet",
"modelPath": null,
"bomPrice": null,
"isSalesItem": true,
"isOptional": false,
"label": "Vario Tablet",
"defaultQuantity": 1.0,
"isRootModel": true,
"effectiveTo": "2023-03-03T21:19:21.000Z",
"rootVariableName": "varioTablet",
"partNumber": "varioTablets:tablets:customTablet",
"itemIdentifier": "1000",
"effectiveFrom": "2022-02-03T21:19:21.000Z",
"bomItemMappings": {
"hasMore": false,
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/bomItemSetups/varioTablet/bomItemMappings"
}
],
"items": [{
"additionalConfigurationAttributeVariableName2": null,
"additionalConfigurationAttributeVariableName3": null,
"additionalConfigurationAttributeVariableName1": null,
"additionalConfigurationAttributeVariableName10": null,
"configurationAttributeValue": "Custom",
"effectiveTo": null,
"configurationAttributeVariableName": "tabletType",
"bomItemVariableName": "varioTablet",
"additionalConfigurationAttributeValue6": null,
"additionalConfigurationAttributeValue7": null,
"additionalConfigurationAttributeValue10": null,
"additionalConfigurationAttributeValue4": null,
"parentBOMMappingRuleVariableName": "varioTablets:tablets:customTablet:defaultBOMMappingRule",
"variableName": "varioTablet-custom",
"additionalConfigurationAttributeValue5": null,
"additionalConfigurationAttributeValue8": null,
"additionalConfigurationAttributeValue9": null,
"additionalConfigurationAttributeVariableName8": null,
"additionalConfigurationAttributeVariableName9": null,
"additionalConfigurationAttributeValue2": null,
"additionalConfigurationAttributeVariableName6": null,
"additionalConfigurationAttributeValue3": null,
"additionalConfigurationAttributeVariableName7": null,
"effectiveFrom": null,
"additionalConfigurationAttributeVariableName4": null,
"additionalConfigurationAttributeValue1": null,
"additionalConfigurationAttributeVariableName5": null,
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/bomItemSetups/varioTablet/bomItemMappings/varioTablet-custom"
}
],
"_state": {
"hasError": true,
"messages": [],
"attributes": {
"additionalConfigurationAttributeVariableName2": {
"hasError": false
},
"additionalConfigurationAttributeVariableName3": {
"hasError": false
},
"additionalConfigurationAttributeVariableName1": {
"hasError": false
},
"configurationAttributeValue": {
"hasError": false
},
"additionalConfigurationAttributeVariableName10": {
"hasError": false
},
"effectiveTo": {
"hasError": false
},
"configurationAttributeVariableName": {
"hasError": false
},
"bomItemVariableName": {
"hasError": true,
"messages": [
"BOM Item Map of variable name varioTablet-Standard maps to the same BOM item with overlapping effective dates"
]
},
"additionalConfigurationAttributeValue6": {
"hasError": false
},
"additionalConfigurationAttributeValue7": {
"hasError": false
},
"parentBOMMappingRuleVariableName": {
"hasError": true,
"messages": [
"Multiple entries found for the root BOM item with variable name varioTablet."
]
},
"additionalConfigurationAttributeValue4": {
"hasError": false
},
"additionalConfigurationAttributeValue10": {
"hasError": false
},
"variableName": {
"hasError": false
},
"additionalConfigurationAttributeValue5": {
"hasError": false
},
"additionalConfigurationAttributeValue8": {
"hasError": false
},
"additionalConfigurationAttributeValue9": {
"hasError": false
},
"additionalConfigurationAttributeVariableName8": {
"hasError": false
},
"additionalConfigurationAttributeVariableName9": {
"hasError": false
},
"additionalConfigurationAttributeVariableName6": {
"hasError": false
},
"additionalConfigurationAttributeValue2": {
"hasError": false
},
"effectiveFrom": {
"hasError": false
},
"additionalConfigurationAttributeVariableName7": {
"hasError": false
},
"additionalConfigurationAttributeValue3": {
"hasError": false
},
"additionalConfigurationAttributeVariableName4": {
"hasError": false
},
"additionalConfigurationAttributeVariableName5": {
"hasError": false
},
"additionalConfigurationAttributeValue1": {
"hasError": false
}
}
}
}, {
"additionalConfigurationAttributeVariableName2": null,
"additionalConfigurationAttributeVariableName3": null,
"additionalConfigurationAttributeVariableName1": null,
"additionalConfigurationAttributeVariableName10": null,
"configurationAttributeValue": "Standard",
"effectiveTo": null,
"configurationAttributeVariableName": "tabletType",
"bomItemVariableName": "varioTablet",
"additionalConfigurationAttributeValue6": null,
"additionalConfigurationAttributeValue7": null,
"additionalConfigurationAttributeValue10": null,
"additionalConfigurationAttributeValue4": null,
"parentBOMMappingRuleVariableName": "varioTablets:tablets:customTablet:defaultBOMMappingRule",
"variableName": "varioTablet-Standard",
"additionalConfigurationAttributeValue5": null,
"additionalConfigurationAttributeValue8": null,
"additionalConfigurationAttributeValue9": null,
"additionalConfigurationAttributeVariableName8": null,
"additionalConfigurationAttributeVariableName9": null,
"additionalConfigurationAttributeValue2": null,
"additionalConfigurationAttributeVariableName6": null,
"additionalConfigurationAttributeValue3": null,
"additionalConfigurationAttributeVariableName7": null,
"effectiveFrom": null,
"additionalConfigurationAttributeVariableName4": null,
"additionalConfigurationAttributeValue1": null,
"additionalConfigurationAttributeVariableName5": null,
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/bomItemSetups/varioTablet/bomItemMappings/varioTablet-Standard"
}
],
"_state": {
"hasError": true,
"messages": [],
"attributes": {
"additionalConfigurationAttributeVariableName2": {
"hasError": false
},
"additionalConfigurationAttributeVariableName3": {
"hasError": false
},
"additionalConfigurationAttributeVariableName1": {
"hasError": false
},
"configurationAttributeValue": {
"hasError": false
},
"additionalConfigurationAttributeVariableName10": {
"hasError": false
},
"effectiveTo": {
"hasError": false
},
"configurationAttributeVariableName": {
"hasError": false
},
"bomItemVariableName": {
"hasError": false
},
"additionalConfigurationAttributeValue6": {
"hasError": false
},
"additionalConfigurationAttributeValue7": {
"hasError": false
},
"parentBOMMappingRuleVariableName": {
"hasError": true,
"messages": [
"Multiple entries found for the root BOM item with variable name varioTablet."
]
},
"additionalConfigurationAttributeValue4": {
"hasError": false
},
"additionalConfigurationAttributeValue10": {
"hasError": false
},
"variableName": {
"hasError": false
},
"additionalConfigurationAttributeValue5": {
"hasError": false
},
"additionalConfigurationAttributeValue8": {
"hasError": false
},
"additionalConfigurationAttributeValue9": {
"hasError": false
},
"additionalConfigurationAttributeVariableName8": {
"hasError": false
},
"additionalConfigurationAttributeVariableName9": {
"hasError": false
},
"additionalConfigurationAttributeVariableName6": {
"hasError": false
},
"additionalConfigurationAttributeValue2": {
"hasError": false
},
"effectiveFrom": {
"hasError": false
},
"additionalConfigurationAttributeVariableName7": {
"hasError": false
},
"additionalConfigurationAttributeValue3": {
"hasError": false
},
"additionalConfigurationAttributeVariableName4": {
"hasError": false
},
"additionalConfigurationAttributeVariableName5": {
"hasError": false
},
"additionalConfigurationAttributeValue1": {
"hasError": false
}
}
}
}
]
},
"children": {
"hasMore": false,
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/bomItemSetups/varioTablet/children"
}
],
"items": [{
"isManufacturingItem": true,
"parentVariableName": "varioTablet",
"sequenceNumber": 1,
"isIncludedInBasePrice": true,
"itemType": "item",
"variableName": "childItemNew",
"modelPath": null,
"bomPrice": null,
"isSalesItem": true,
"isOptional": false,
"label": "new child item",
"defaultQuantity": 1.0,
"isRootModel": false,
"effectiveTo": "2023-03-03T21:19:21.000Z",
"rootVariableName": "varioTablet",
"partNumber": "part1",
"itemIdentifier": "childItem new",
"effectiveFrom": "2022-02-03T21:19:21.000Z",
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/bomItemSetups/childItemNew"
}, {
"kind": "",
"rel": "child",
"name": "bomItemMappings",
"href": "https://sitename.oracle.com/rest/v19/bomItemSetups/childItemNew/bomItemMappings"
}, {
"kind": "",
"rel": "child",
"name": "children",
"href": "https://sitename.oracle.com/rest/v19/bomItemSetups/childItemNew/children"
}
],
"_state": {
"hasError": false,
"messages": [],
"attributes": {
"isManufacturingItem": {
"hasError": false
},
"sequenceNumber": {
"hasError": false
},
"parentVariableName": {
"hasError": false
},
"itemType": {
"hasError": false
},
"isIncludedInBasePrice": {
"hasError": false
},
"variableName": {
"hasError": false
},
"modelPath": {
"hasError": false
},
"isSalesItem": {
"hasError": false
},
"bomPrice": {
"hasError": false
},
"label": {
"hasError": false
},
"isOptional": {
"hasError": false
},
"defaultQuantity": {
"hasError": false
},
"isRootModel": {
"hasError": false
},
"effectiveTo": {
"hasError": false
},
"rootVariableName": {
"hasError": false
},
"partNumber": {
"hasError": false
},
"itemIdentifier": {
"hasError": false
},
"effectiveFrom": {
"hasError": false
}
}
}
}, {...
}
]
},
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/bomItemSetups/varioTablet"
}
],
"_state": {
"hasError": false,
"messages": [],
"attributes": {
"isManufacturingItem": {
"hasError": false
},
"sequenceNumber": {
"hasError": false
},
"parentVariableName": {
"hasError": false
},
"itemType": {
"hasError": false
},
"isIncludedInBasePrice": {
"hasError": false
},
"variableName": {
"hasError": false
},
"modelPath": {
"hasError": false
},
"isSalesItem": {
"hasError": false
},
"bomPrice": {
"hasError": false
},
"label": {
"hasError": false
},
"isOptional": {
"hasError": false
},
"defaultQuantity": {
"hasError": false
},
"isRootModel": {
"hasError": false
},
"effectiveTo": {
"hasError": false
},
"rootVariableName": {
"hasError": false
},
"partNumber": {
"hasError": false
},
"itemIdentifier": {
"hasError": false
},
"effectiveFrom": {
"hasError": false
}
}
}
}
}