REST API Services for CPQ Cloud

Get BOM Items

post

/rest/v7/prodFamVarName.prodLineVarName.modelVarName/_bom/actions/getBomItems

This action retrieves the BOM Items of the configuration. This action does not run BOM Mapping rules.

Request

Supported Media Types

application/json

Root Schema : _bom-getBomItemsRequest

Type: object

Show Source

cacheInstanceId: string

Title: Cache Instance Id

The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.

{
    "type":"object",
    "required":[
        "cacheInstanceId"
    ],
    "properties":{
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.",
            "title":"Cache Instance Id"
        }
    }
}

Response

Supported Media Types

application/json

Default Response

Root Schema : _bom-getBomItemsResponse

Type: object

Show Source

cacheInstanceId(optional): string

Title: Cache Instance Id

The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.
items(optional): array items

{
    "type":"object",
    "properties":{
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.",
            "title":"Cache Instance Id"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/part"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object part

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/part"
    }
}

Nested Schema : part

Type: object

Show Source

comment(optional): string

Title: Comment

Comment
companyAssociations(optional): string

Title: Company Associations

Company Associations
cost(optional): number

Title: Cost
description(optional): string

Title: Description

Description
directBuy(optional): string

Title: Direct Buy

Direct Buy
extendedDescription1(optional): string

Title: Extended Description 1

Extended Description 1
extendedDescription2(optional): string

Title: Extended Description 2

Extended Description 2
id(optional): string

Title: Part Identifier

It uniquely idenitfies the part, used for selection of recommended parts.
leadTime(optional): integer

Title: Lead Time

Lead Time
maxdiscount%(optional): string

Title: Max discount %
partDisplayNumber(optional): string

Title: Part Display Number

Part Display Number
partNumber(optional): string

Title: Part Number

Part Number
price(optional): object Price

Title: Price

Price
pricePeriod(optional): object Price Period

Title: Price Period
priceType(optional): object Price Type

Title: Price Type
productGroup(optional): string

Title: Product Group
quantity(optional): integer

Title: Quantity

Quantity
selected(optional): string

Title: Selection

It represents selection of the item. Selection can be 'true', 'false' or 'missing'.
units(optional): string

Title: Units

Units

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"It uniquely idenitfies the part, used for selection of recommended parts.",
            "title":"Part Identifier"
        },
        "selected":{
            "type":"string",
            "description":"It represents selection of the item. Selection can be 'true', 'false' or 'missing'.",
            "title":"Selection"
        },
        "productGroup":{
            "type":"string",
            "description":"",
            "title":"Product Group"
        },
        "pricePeriod":{
            "type":"object",
            "description":"",
            "title":"Price Period",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"Value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"Display Value"
                }
            }
        },
        "priceType":{
            "type":"object",
            "description":"",
            "title":"Price Type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"Value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"Display Value"
                }
            }
        },
        "cost":{
            "type":"number",
            "description":"",
            "title":"Cost"
        },
        "maxdiscount%":{
            "type":"string",
            "description":"",
            "title":"Max discount %"
        },
        "leadTime":{
            "type":"integer",
            "description":"Lead Time",
            "title":"Lead Time"
        },
        "comment":{
            "type":"string",
            "description":"Comment",
            "title":"Comment"
        },
        "price":{
            "type":"object",
            "description":"Price",
            "title":"Price",
            "properties":{
                "value":{
                    "type":"string"
                },
                "currency":{
                    "type":"string"
                }
            }
        },
        "extendedDescription2":{
            "type":"string",
            "description":"Extended Description 2",
            "title":"Extended Description 2"
        },
        "partNumber":{
            "type":"string",
            "description":"Part Number",
            "title":"Part Number"
        },
        "extendedDescription1":{
            "type":"string",
            "description":"Extended Description 1",
            "title":"Extended Description 1"
        },
        "description":{
            "type":"string",
            "description":"Description",
            "title":"Description"
        },
        "units":{
            "type":"string",
            "description":"Units",
            "title":"Units"
        },
        "directBuy":{
            "type":"string",
            "description":"Direct Buy",
            "title":"Direct Buy"
        },
        "quantity":{
            "type":"integer",
            "description":"Quantity",
            "title":"Quantity"
        },
        "partDisplayNumber":{
            "type":"string",
            "description":"Part Display Number",
            "title":"Part Display Number"
        },
        "companyAssociations":{
            "type":"string",
            "description":"Company Associations",
            "title":"Company Associations"
        }
    }
}

Nested Schema : Price

Type: object

Title: Price

Price

Show Source

currency(optional): string
value(optional): string

{
    "type":"object",
    "description":"Price",
    "title":"Price",
    "properties":{
        "value":{
            "type":"string"
        },
        "currency":{
            "type":"string"
        }
    }
}

Nested Schema : Price Period

Type: object

Title: Price Period

Show Source

displayValue(optional): string

Title: Display Value
value(optional): string

Title: Value

{
    "type":"object",
    "description":"",
    "title":"Price Period",
    "properties":{
        "value":{
            "type":"string",
            "title":"Value"
        },
        "displayValue":{
            "type":"string",
            "title":"Display Value"
        }
    }
}

Nested Schema : Price Type

Type: object

Title: Price Type

Show Source

displayValue(optional): string

Title: Display Value
value(optional): string

Title: Value

{
    "type":"object",
    "description":"",
    "title":"Price Type",
    "properties":{
        "value":{
            "type":"string",
            "title":"Value"
        },
        "displayValue":{
            "type":"string",
            "title":"Display Value"
        }
    }
}

Examples

The following example shows how to retrieve the BOM Items of a configuration by submitting a POST request to the REST resource using cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v7/configvarioTablets.tablets.customTablet/_bom/actions/getBomItems

Request Body Sample

{
  "cacheInstanceId": "gsg21bMZ5kpGUWxDIZeGWQCLKbaad33Un1X8huVuDm0K3gAKMeXPbzeQcFsFBAzJ"
}

Response Body Sample

The following example shows the contents of the response body in JSON format:

{
  "cacheInstanceId": "gsg21bMZ5kpGUWxDIZeGWQCLKbaad33Un1X8huVuDm0K3gAKMeXPbzeQcFsFBAzJ",
  "items": [{
      "lead_time": "-1",
      "comment": "Custom Tablet",
      "price": {
        "value": "1000",
        "currency": "USD"
      },
      "part_number": "Custom Tablet",
      "description": "Custom Tablet",
      "quantity": 1,
      "company_associations": null
    }, {
      "leadTime": -1,
      "comment": "GS5004",
      "price": {
        "value": "1,000.00",
        "currency": "USD"
      },
      "partNumber": "GS5004",
      "description": "",
      "units": "",
      "directBuy": "Direct Buy",
      "quantity": 1,
      "_part_custom_field5": 0,
      "partDisplayNumber": "GS5004",
      "companyAssociations": ""
    }, {
      "leadTime": -1,
      "comment": "Quad Core 1.9 GHz",
      "price": {
        "value": "25.00",
        "currency": "USD"
      },
      "partNumber": "CPU-100M-19",
      "description": "Quad Core 1.9 GHz",
      "directBuy": "Direct Buy",
      "quantity": 1,
      "_part_custom_field8": {
        "value": "One Time",
        "displayValue": "One Time"
      },
      "_part_custom_field5": 20,
      "partDisplayNumber": "Quad Core 1.9 GHz",
      "companyAssociations": ""
    }, {
      "leadTime": -1,
      "comment": "4GB Memory",
      "price": {
        "value": "40.00",
        "currency": "USD"
      },
      "partNumber": "MEM-100M-4",
      "description": "4GB Memory",
      "directBuy": "Direct Buy",
      "quantity": 1,
      "_part_custom_field8": {
        "value": "One Time",
        "displayValue": "One Time"
      },
      "_part_custom_field5": 20,
      "partDisplayNumber": "4GB Memory",
      "companyAssociations": ""
    }, {
      "leadTime": -1,
      "comment": "64GB Storage",
      "price": {
        "value": "40.00",
        "currency": "USD"
      },
      "partNumber": "STOR-100M-64",
      "description": "64GB Storage",
      "directBuy": "Direct Buy",
      "quantity": 1,
      "_part_custom_field8": {
        "value": "One Time",
        "displayValue": "One Time"
      },
      "_part_custom_field5": 20,
      "partDisplayNumber": "64GB Storage",
      "companyAssociations": ""
    }, {
      "leadTime": -1,
      "comment": "WiFi 802.11 a/b/g/n/ac / Bluetooth / 4G LTE",
      "price": {
        "value": "40.00",
        "currency": "USD"
      },
      "partNumber": "NET-100M-2",
      "description": "WiFi 802.11 a/b/g/n/ac / Bluetooth / 4G LTE",
      "directBuy": "Direct Buy",
      "quantity": 1,
      "_part_custom_field8": {
        "value": "One Time",
        "displayValue": "One Time"
      },
      "_part_custom_field5": 20,
      "partDisplayNumber": "WiFi 802.11 a/b/g/n/ac / Bluetooth / 4G LTE",
      "companyAssociations": ""
    }, {
      "leadTime": -1,
      "comment": "Primary 8MP",
      "price": {
        "value": "20.00",
        "currency": "USD"
      },
      "partNumber": "CAM-100M-1",
      "description": "Primary 8MP",
      "directBuy": "Direct Buy",
      "quantity": 1,
      "_part_custom_field8": {
        "value": "One Time",
        "displayValue": "One Time"
      },
      "_part_custom_field5": 10,
      "partDisplayNumber": "Primary 8MP",
      "companyAssociations": ""
    }, {
      "leadTime": -1,
      "comment": "Battery 3.8V / 5200mAh",
      "price": {
        "value": "40.00",
        "currency": "USD"
      },
      "partNumber": "BATT-0380M-5200",
      "description": "Battery 3.8V / 5200mAh",
      "units": "",
      "directBuy": "Direct Buy",
      "quantity": 1,
      "_part_custom_field8": {
        "value": "One Time",
        "displayValue": "One Time"
      },
      "_part_custom_field5": 20,
      "partDisplayNumber": "Battery 3.8V / 5200mAh",
      "companyAssociations": ""
    }, {
      "leadTime": -1,
      "comment": "4GB Data Plan",
      "price": {
        "value": "40.00",
        "currency": "USD"
      },
      "partNumber": "DATA-100-4",
      "description": "4GB Data Plan",
      "units": "",
      "directBuy": "Direct Buy",
      "quantity": 1,
      "_part_custom_field4": {
        "value": "Per Month",
        "displayValue": "Per Month"
      },
      "_part_custom_field8": {
        "value": "Recurring",
        "displayValue": "Recurring"
      },
      "_part_custom_field5": 20,
      "partDisplayNumber": "4GB Data Plan",
      "companyAssociations": ""
    }, {
      "lead_time": "-1",
      "comment": "Tablet Support Services",
      "price": {
        "value": "40",
        "currency": "USD"
      },
      "part_number": "Tablet Support Services",
      "quantity": 1,
      "part_display_number": "Tablet Support Services",
      "company_associations": null
    }
  ]
}