Get a BOM Item Definition
get
/rest/v19/bomItemSetups/{bomItemVarName}
Use this endpoint to retrieve the specified BOM item definition.
Request
Supported Media Types
- application/json
Path Parameters
-
bomItemVarName(required): string
Variable Name of the BOM item
Query Parameters
-
expand: string
Allows expansion of relationships.
Response
Supported Media Types
- application/json
Default Response
Root Schema : BOM Item Setup Instance Definitions
Type:
object
Title:
Show Source
BOM Item Setup Instance Definitions
-
bomPrice:
number
Title:
BOM Price
BOM Price -
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
Title:
Effective From
The effective from date for the BOM item -
effectiveTo:
string
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 -
maxSelectableItems:
string
Title:
Max Selectable Items
Maximum number of selected optional items for this option class -
minSelectableItems:
string
Title:
Min Selectable Items
Minimum number of selected optional items for this option class -
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 -
rootBomItemLabel:
string
Title:
Root BOM Item Label
Label of the Root BOM Item of this item's hierarchy -
rootBomItemPartNumber:
string
Title:
Root BOM Item Part Number
Part Number value from the Root 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 item tree has an item with errors -
treeHasModel:
boolean
Title:
Tree Has Model
Whether the BOM item tree has a model -
variableName:
string
Title:
Variable Name
Variable Name of the BOM item
Examples
The following example shows how to retrieve a BOM item definition by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET -H "Authorization: Bearer <token>" -H "Accept: application/json" https://sitename.oracle.com/rest/v19/bomItemSetups/VEHICLE
Response Body Sample
{ "isManufacturingItem": true, "parentVariableName": null, "sequenceNumber": 0, "isIncludedInBasePrice": false, "itemType": "Standard Item", "variableName": "VEHICLE", "modelPath": null, "bomPrice": 0.0, "isSalesItem": true, "isOptional": false, "label": "Consumer Vehicle", "rootBomItemPartNumber": "VEHICLE", "defaultQuantity": 1.0, "isRootModel": true, "effectiveTo": null, "rootBomItemLabel": "Consumer Vehicle", "rootVariableName": "VEHICLE", "partNumber": "VEHICLE", "itemIdentifier": "0", "effectiveFrom": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/bomItemSetups/VEHICLE" }, { "kind": "", "rel": "child", "name": "bomItemMappings", "href": "https://sitename.oracle.com/rest/v19/bomItemSetups/VEHICLE/bomItemMappings" }, { "kind": "", "rel": "child", "name": "children", "href": "https://sitename.oracle.com/rest/v19/bomItemSetups/VEHICLE/children" } ] }