Get a BOM Item Tree

post

/rest/v16/bomItemSetups/{bomItemVarName}/actions/getBomItemTree

Use this endpoint to retrieve the hierarchical structure and BOM item mappings for the specified root BOM item.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : BOM Item Setup Get BOM Item Tree Request Definitions
Type: object
Title: BOM Item Setup Get BOM Item Tree Request Definitions
Back to Top

Response

Supported Media Types

Default Response

Body ()
Root Schema : BOM Item Setup Get BOM Item Tree Response Definitions
Type: object
Title: BOM Item Setup Get BOM Item Tree Response Definitions
Show Source
Nested Schema : BOM Item Setups Get BOM Item Tree Response Definitions
Type: object
Title: BOM Item Setups Get BOM Item Tree Response Definitions
BOM item setups get BOM item tree response
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 retrieve 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 -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/bomItemSetups/varioTablet/actions/getBomItemTree

Response Body Sample

{
  "bomItem": {
    "isManufacturingItem": true,
    "parentVariableName": null,
    "sequenceNumber": 1000,
    "isIncludedInBasePrice": false,
    "itemType": "Standard",
    "treeHasModel": true,
    "variableName": "varioTablet",
    "isModel": true,
    "modelPath": null,
    "bomPrice": null,
    "isSalesItem": true,
    "isOptional": false,
    "label": "Vario Tablet",
    "defaultQuantity": 1.0,
    "treeHasError": false,
    "isRootModel": true,
    "effectiveTo": null,
    "rootVariableName": "varioTablet",
    "partNumber": "varioTablets:tablets:customTablet",
    "itemIdentifier": "1000",
    "effectiveFrom": null,
    "bomItemMappings": {
      "hasMore": false,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/varioTablet/bomItemMappings"
        }
      ],
      "items": [{
          "additionalConfigurationAttributeVariableName2": null,
          "additionalConfigurationAttributeVariableName3": null,
          "additionalConfigurationAttributeVariableName1": null,
          "additionalConfigurationAttributeVariableName10": null,
          "configurationAttributeValue": null,
          "effectiveTo": null,
          "configurationAttributeVariableName": null,
          "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/v16/bomItemSetups/varioTablet/bomItemMappings/varioTablet-custom"
            }
          ],
          "_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/rest/v16/bomItemSetups/varioTablet/children"
        }
      ],
      "items": [{
          "isManufacturingItem": true,
          "parentVariableName": "varioTablet",
          "sequenceNumber": 1001,
          "isIncludedInBasePrice": false,
          "itemType": "Standard",
          "variableName": "varioTablet-base",
          "isModel": false,
          "modelPath": null,
          "bomPrice": null,
          "isSalesItem": true,
          "isOptional": false,
          "label": "Vario Tablet Base",
          "defaultQuantity": 1.0,
          "isRootModel": false,
          "effectiveTo": null,
          "rootVariableName": "varioTablet",
          "partNumber": "GS5004",
          "itemIdentifier": "1001",
          "effectiveFrom": null,
          "bomItemMappings": {
            "hasMore": false,
            "links": [{
                "rel": "self",
                "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/varioTablet-base/bomItemMappings"
              }
            ],
            "items": [{
                "additionalConfigurationAttributeVariableName2": null,
                "additionalConfigurationAttributeVariableName3": null,
                "additionalConfigurationAttributeVariableName1": null,
                "additionalConfigurationAttributeVariableName10": null,
                "configurationAttributeValue": null,
                "effectiveTo": null,
                "configurationAttributeVariableName": null,
                "bomItemVariableName": "varioTablet-base",
                "additionalConfigurationAttributeValue6": null,
                "additionalConfigurationAttributeValue7": null,
                "additionalConfigurationAttributeValue10": null,
                "additionalConfigurationAttributeValue4": null,
                "parentBOMMappingRuleVariableName": "varioTablets:tablets:customTablet:defaultBOMMappingRule",
                "variableName": "varioTablet-custom-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/rest/v16/bomItemSetups/varioTablet-base/bomItemMappings/varioTablet-custom-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/rest/v16/bomItemSetups/varioTablet-base"
            }, {
              "kind": "",
              "rel": "child",
              "name": "children",
              "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/varioTablet-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
              },
              "isModel": {
                "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/v16/bomItemSetups/varioTablet"
      }
    ],
    "_state": {
      "hasError": false,
      "messages": [],
      "attributes": {
        "isManufacturingItem": {
          "hasError": false
        },
        "sequenceNumber": {
          "hasError": false
        },
        "parentVariableName": {
          "hasError": false
        },
        "itemType": {
          "hasError": false
        },
        "isIncludedInBasePrice": {
          "hasError": false
        },
        "treeHasModel": {
          "hasError": false
        },
        "variableName": {
          "hasError": false
        },
        "isModel": {
          "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