Create a BOM Item Tree

post

/rest/v16/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
Body ()
Root Schema : BOM Item Setup Create BOM Item Tree Collection Request Definitions
Type: object
Title: BOM Item Setup Create BOM Item Tree Collection Request Definitions
Show Source
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
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: array
Show Source
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
Nested Schema : items
Type: array
Show Source
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
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
Back to Top

Response

Supported Media Types

Default Response

Body ()
Root Schema : BOM Item Setup Create BOM Item Tree Collection Response Definitions
Type: object
Title: BOM Item Setup Create BOM Item Tree Collection Response Definitions
Show Source
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
Nested Schema : BOM Item State Definitions
Type: object
Title: BOM Item State Definitions
BOM item state definitions.
Show Source
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
Nested Schema : Messages
Type: array
Title: Messages
Array of messages that have been generated for a specific object.
Show Source
Nested Schema : Attribute State Definitions
Type: object
Title: Attribute State Definitions
Attribute level state definitions.
Show Source
  • Title: Has Error
    Boolean value that specifies whether any error that occurred has been assigned to the attribute itself.
  • 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
Nested Schema : items
Type: array
Show Source
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
Nested Schema : BOM Item Mapping State Definitions
Type: object
Title: BOM Item Mapping State Definitions
BOM item mapping state definitions.
Show Source
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
Nested Schema : Messages
Type: array
Title: Messages
Array of messages that have been generated for a specific object.
Show Source
Nested Schema : items
Type: array
Show Source
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
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
Back to Top

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 -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/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
        }
      }
    }
  }
}
Back to Top