Create a BOM Item Tree
post
/rest/v19/bomItemSetups/actions/createBomItemTree
Use this endpoint to create a hierarchical BOM structure and BOM item mappings for the specified root BOM item.
Request
Supported Media Types
- application/json
Root Schema : BOM Item Setup Create BOM Item Tree Collection Request Definitions
Type:
object
Title:
Show Source
BOM Item Setup Create BOM Item Tree Collection Request Definitions
-
bomItem:
object BOM Item Setups Create BOM Item Tree Request Definitions
Title:
BOM Item Setups Create BOM Item Tree Request Definitions
BOM item setups create BOM item tree request definitions
Nested Schema : BOM Item Setups Create BOM Item Tree Request Definitions
Type:
object
Title:
BOM Item Setups Create BOM Item Tree Request Definitions
BOM item setups create BOM item tree request definitions
Show Source
-
bomItemMappings:
object BOM Item Tree BOM Item Mapping Request Collection Definitions
Title:
BOM Item Tree BOM Item Mapping Request Collection Definitions
BOM item mapping collection definition for BOM item tree create requests -
bomPrice:
number
Title:
BOM Price
BOM Price -
children:
object BOM Item Tree BOM Item Collection Create Request Definitions
Title:
BOM Item Tree BOM Item Collection Create Request Definitions
BOM item collection definition for BOM item tree create requests -
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 Tree BOM Item Mapping Request Collection Definitions
Type:
object
Title:
BOM Item Tree BOM Item Mapping Request Collection Definitions
BOM item mapping collection definition for BOM item tree create requests
Show Source
Nested Schema : BOM Item Tree BOM Item Collection Create Request Definitions
Type:
object
Title:
BOM Item Tree BOM Item Collection Create Request Definitions
BOM item collection definition for BOM item tree create 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 Definitions
BOM item mapping instance definition for BOM item tree create requests
Nested Schema : BOM Item Tree BOM Item Mapping Request Instance Definitions
Type:
object
Title:
BOM Item Tree BOM Item Mapping Request Instance Definitions
BOM item mapping instance definition for BOM item tree create 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
Nested Schema : items
Type:
Show Source
array
-
Array of:
object BOM Item Tree Child BOM Item Instance Create Request Definitions
Title:
BOM Item Tree Child BOM Item Instance Create Request Definitions
Child BOM item instance definition for BOM item tree create requests
Nested Schema : BOM Item Tree Child BOM Item Instance Create Request Definitions
Type:
object
Title:
BOM Item Tree Child BOM Item Instance Create Request Definitions
Child BOM item instance definition for BOM item tree create requests
Show Source
-
bomItemMappings:
object BOM Item Mappings
Title:
BOM Item Mappings
BOM item mappings for the BOM Item -
bomPrice:
number
Title:
BOM Price
BOM Price -
children:
object Children
Title:
Children
Child BOM Items -
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 Mappings
Type:
object
Title:
BOM Item Mappings
BOM item mappings for the BOM Item
Nested Schema : Children
Type:
object
Title:
Children
Child BOM Items
Response
Supported Media Types
- application/json
Default Response
Root Schema : BOM Item Setup Create BOM Item Tree Collection Response Definitions
Type:
object
Title:
Show Source
BOM Item Setup Create BOM Item Tree Collection Response Definitions
-
processedBomItem:
object BOM Item Setups Create And Update Tree Response Definitions
Title:
BOM Item Setups Create And Update Tree Response Definitions
BOM item setups create and update tree response definitions
Nested Schema : BOM Item Setups Create And Update Tree Response Definitions
Type:
object
Title:
BOM Item Setups Create And Update Tree Response Definitions
BOM item setups create and update tree response definitions
Show Source
-
_state:
object BOM Item State Definitions
Title:
BOM Item State Definitions
BOM item state definitions. -
bomItemMappings:
object BOM Item Tree BOM Item Mapping Collection Definitions
Title:
BOM Item Tree BOM Item Mapping Collection Definitions
BOM item mapping collection definition for BOM item tree responses -
bomPrice:
number
Title:
BOM Price
BOM Price -
children:
object BOM Item Tree BOM Item Collection Definitions
Title:
BOM Item Tree BOM Item Collection Definitions
BOM item collection definition for BOM item tree responses -
configurableFlag:
boolean
Title:
Configurable Flag
Whether the BOM item tree is configurable -
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 -
isModel:
boolean
Title:
Is Model
Whether the BOM item is a model -
isOptional:
boolean
Title:
Is Optional
Whether the BOM item is optional -
isRootModel:
boolean
Title:
Is Root Model
Whether the BOM item is the root model -
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 -
treeHasError:
boolean
Title:
Tree Has Error
Whether the BOM tree has any BOM items with errors -
treeHasModel:
boolean
Title:
Tree Has Model
Whether the BOM tree has a model in it -
variableName:
string
Title:
Variable Name
Variable Name of the BOM item
Nested Schema : BOM Item State Definitions
Type:
object
Title:
BOM Item State Definitions
BOM item state definitions.
Show Source
-
attributes:
object BOM Item Attribute State Definitions
Title:
BOM Item Attribute State Definitions
BOM item attribute level state definitions. -
hasError:
boolean
Title:
Has Error
Boolean value that specifies whether any error that occurred has been assigned to the entry itself. -
messages:
array Messages
Title:
Messages
Array of messages that have been generated for a specific object.
Nested Schema : BOM Item Tree BOM Item Mapping Collection Definitions
Type:
object
Title:
BOM Item Tree BOM Item Mapping Collection Definitions
BOM item mapping collection definition for BOM item tree responses
Show Source
Nested Schema : BOM Item Tree BOM Item Collection Definitions
Type:
object
Title:
BOM Item Tree BOM Item Collection Definitions
BOM item collection definition for BOM item tree responses
Show Source
Nested Schema : BOM Item Attribute State Definitions
Type:
object
Title:
BOM Item Attribute State Definitions
BOM item attribute level state definitions.
Show Source
-
bomPrice:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
defaultQuantity:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
effectiveFrom:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
effectiveTo:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
isIncludedInBasePrice:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
isManufacturingItem:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
isModel:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
isOptional:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
isRootModel:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
isSalesItem:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
itemIdentifier:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
itemType:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
label:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
modelPath:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
parentVariableName:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
partNumber:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
rootVariableName:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
sequenceNumber:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
treeHasModel:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
variableName:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions.
Nested Schema : Messages
Type:
array
Title:
Messages
Array 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:
object
Title:
Attribute State Definitions
Attribute level state definitions.
Show Source
-
hasError:
boolean
Title:
Has Error
Boolean value that specifies whether any error that occurred has been assigned to the attribute itself. -
messages:
array Messages
Title:
Messages
Array of messages that have been generated for a specific attribute.
Nested Schema : Messages
Type:
array
Title:
Messages
Array 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 Definitions
BOM item mapping instance definition for BOM item tree responses
Nested Schema : BOM Item Tree BOM Item Mapping Instance Definitions
Type:
object
Title:
BOM Item Tree BOM Item Mapping Instance Definitions
BOM item mapping instance definition for BOM item tree responses
Show Source
-
_state:
object BOM Item Mapping State Definitions
Title:
BOM Item Mapping State Definitions
BOM item mapping state definitions. -
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
Nested Schema : BOM Item Mapping State Definitions
Type:
object
Title:
BOM Item Mapping State Definitions
BOM item mapping state definitions.
Show Source
-
attributes:
object BOM Item Mapping Attribute State Definitions
Title:
BOM Item Mapping Attribute State Definitions
BOM item mapping attribute level state definitions. -
hasError:
boolean
Title:
Has Error
Boolean value that specifies whether any error that occurred has been assigned to the entry itself. -
messages:
array Messages
Title:
Messages
Array of messages that have been generated for a specific object.
Nested Schema : BOM Item Mapping Attribute State Definitions
Type:
object
Title:
BOM Item Mapping Attribute State Definitions
BOM item mapping attribute level state definitions.
Show Source
-
additionalConfigurationAttributeValue1:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeValue10:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeValue2:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeValue3:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeValue4:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeValue5:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeValue6:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeValue7:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeValue8:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeValue9:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeVariableName1:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeVariableName10:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeVariableName2:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeVariableName3:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeVariableName4:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeVariableName5:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeVariableName6:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeVariableName7:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeVariableName8:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
additionalConfigurationAttributeVariableName9:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
bomItemVariableName:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
configurationAttributeValue:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
configurationAttributeVariableName:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
effectiveFrom:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
effectiveTo:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
parentBOMMappingRuleVariableName:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions. -
variableName:
object Attribute State Definitions
Title:
Attribute State Definitions
Attribute level state definitions.
Nested Schema : Messages
Type:
array
Title:
Messages
Array 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 Definitions
Child BOM item instance definition for BOM item tree responses
Nested Schema : BOM Item Tree Child BOM Item Instance Definitions
Type:
object
Title:
BOM Item Tree Child BOM Item Instance Definitions
Child BOM item instance definition for BOM item tree responses
Show Source
-
_state:
object BOM Item State Definitions
Title:
BOM Item State Definitions
BOM item state definitions. -
bomItemMappings:
object BOM Item Mappings
Title:
BOM Item Mappings
BOM item mappings for the BOM Item -
bomPrice:
number
Title:
BOM Price
BOM Price -
children:
object Children
Title:
Children
Child BOM Items -
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 -
isModel:
boolean
Title:
Is Model
Whether the BOM item is a model -
isOptional:
boolean
Title:
Is Optional
Whether the BOM item is optional -
isRootModel:
boolean
Title:
Is Root Model
Whether the BOM item is the root model -
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 Mappings
Type:
object
Title:
BOM Item Mappings
BOM item mappings for the BOM Item
Nested Schema : Children
Type:
object
Title:
Children
Child BOM Items
Examples
The following example shows how to create a hierarchical BOM structure and BOM item mappings 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/actions/createBomItemTree
Request Body Sample
{ "bomItem": { "isManufacturingItem": true, "parentVariableName": null, "sequenceNumber": 6000, "isIncludedInBasePrice": false, "itemType": "Standard Item", "variableName": "vario6000", "modelPath": "varioTablets:tablets:vario6000", "bomPrice": null, "isSalesItem": true, "isOptional": false, "label": "Vario Tablet 6000", "defaultQuantity": 1.0, "isRootModel": true, "effectiveTo": null, "rootVariableName": "vario6000", "partNumber": "Vario 6000", "itemIdentifier": "6000", "effectiveFrom": null, "bomItemMappings": { "items": [{ "additionalConfigurationAttributeVariableName2": null, "additionalConfigurationAttributeVariableName3": null, "additionalConfigurationAttributeVariableName1": null, "additionalConfigurationAttributeVariableName10": null, "configAttributeValue": null, "effectiveTo": null, "configAttributeVariableName": null, "bomItemVariableName": "vario6000", "additionalConfigurationAttributeValue6": null, "additionalConfigurationAttributeValue7": null, "additionalConfigurationAttributeValue10": null, "additionalConfigurationAttributeValue4": null, "parentBOMMappingRuleVariableName": "varioTablets:tablets:vario6000:vario6000BOMMapping", "variableName": "vario6000-mapping", "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 } ] }, "children": { "items": [{ "isManufacturingItem": true, "parentVariableName": "vario6000", "sequenceNumber": 6001, "isIncludedInBasePrice": false, "itemType": "Standard Item", "variableName": "vario6000-base", "modelPath": null, "bomPrice": null, "isSalesItem": true, "isOptional": false, "label": "Vario Tablet Base", "defaultQuantity": 1.0, "isRootModel": false, "effectiveTo": null, "rootVariableName": "vario6000", "partNumber": "VT6000", "itemIdentifier": "6001", "effectiveFrom": null, "bomItemMappings": { "items": [{ "additionalConfigurationAttributeVariableName2": null, "additionalConfigurationAttributeVariableName3": null, "additionalConfigurationAttributeVariableName1": null, "additionalConfigurationAttributeVariableName10": null, "configAttributeValue": null, "effectiveTo": null, "configAttributeVariableName": null, "bomItemVariableName": "vario6000-base", "additionalConfigurationAttributeValue6": null, "additionalConfigurationAttributeValue7": null, "additionalConfigurationAttributeValue10": null, "additionalConfigurationAttributeValue4": null, "parentBOMMappingRuleVariableName": "varioTablets:tablets:vario6000:vario6000BOMMapping", "variableName": "varioTablet6000-base", "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 } ] } } ] } } }
Response Body Sample
{ "processedBomItem": { "isManufacturingItem": true, "parentVariableName": null, "sequenceNumber": 6000, "isIncludedInBasePrice": null, "itemType": "Standard Item", "variableName": "vario6000", "modelPath": null, "bomPrice": null, "isSalesItem": true, "isOptional": false, "label": "Vario Tablet 6000", "defaultQuantity": 1.0, "isRootModel": true, "effectiveTo": null, "rootVariableName": "vario6000", "partNumber": "Vario 6000", "itemIdentifier": "6000", "effectiveFrom": null, "bomItemMappings": { "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/bomItemSetups/vario6000/bomItemMappings" } ], "items": [{ "additionalConfigurationAttributeVariableName2": null, "additionalConfigurationAttributeVariableName3": null, "additionalConfigurationAttributeVariableName1": null, "additionalConfigurationAttributeVariableName10": null, "configurationAttributeValue": null, "effectiveTo": null, "configurationAttributeVariableName": null, "bomItemVariableName": "vario6000", "additionalConfigurationAttributeValue6": null, "additionalConfigurationAttributeValue7": null, "additionalConfigurationAttributeValue10": null, "additionalConfigurationAttributeValue4": null, "parentBOMMappingRuleVariableName": "varioTablets:tablets:vario6000:vario6000BOMMapping", "variableName": "vario6000-mapping", "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/bomItemSetups/vario6000/bomItemMappings/vario6000-mapping" } ], "_state": { "hasError": false, "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": false }, "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/bomItemSetups/vario6000/children" } ], "items": [{ "isManufacturingItem": true, "parentVariableName": "vario6000", "sequenceNumber": 6001, "isIncludedInBasePrice": null, "itemType": "Standard Item", "variableName": "vario6000-base", "modelPath": null, "bomPrice": null, "isSalesItem": true, "isOptional": false, "label": "Vario Tablet Base", "defaultQuantity": 1.0, "isRootModel": false, "effectiveTo": null, "rootVariableName": "vario6000", "partNumber": "VT6000", "itemIdentifier": "6001", "effectiveFrom": null, "bomItemMappings": { "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/bomItemSetups/vario6000-base/bomItemMappings" } ], "items": [{ "additionalConfigurationAttributeVariableName2": null, "additionalConfigurationAttributeVariableName3": null, "additionalConfigurationAttributeVariableName1": null, "additionalConfigurationAttributeVariableName10": null, "configurationAttributeValue": null, "effectiveTo": null, "configurationAttributeVariableName": null, "bomItemVariableName": "vario6000-base", "additionalConfigurationAttributeValue6": null, "additionalConfigurationAttributeValue7": null, "additionalConfigurationAttributeValue10": null, "additionalConfigurationAttributeValue4": null, "parentBOMMappingRuleVariableName": "varioTablets:tablets:vario6000:vario6000BOMMapping", "variableName": "varioTablet6000-base", "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/bomItemSetups/vario6000-base/bomItemMappings/varioTablet6000-base" } ], "_state": { "hasError": false, "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": false }, "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 } } } } ] }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/bomItemSetups/vario6000-base" }, { "kind": "", "rel": "child", "name": "children", "href": "https://sitename.oracle.com/bomItemSetups/vario6000-base/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/bomItemSetups/vario6000" } ], "_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 } } } } }