Get Recommended Parts
post
/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_recmdParts/actions/getRecmdParts
This action retrieves the recommended parts of the configuration. This action does not run recommended items rules.
Request
Supported Media Types
- application/json
Path Parameters
-
modelVarName(required): string
The variable name of a Model
-
prodFamVarName(required): string
The variable name of a Product Family
-
prodLineVarName(required): string
The variable name of a Product Line
Root Schema : getRecmdPartsRequest
Type:
Show Source
object-
cacheInstanceId(required):
string
Title:
Cache Instance IdThe 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.
Response
Supported Media Types
- application/json
Default Response
Root Schema : getRecmdPartsResponse
Type:
Show Source
object-
cacheInstanceId:
string
Title:
Cache Instance IdThe 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:
array items
Nested Schema : part
Type:
Show Source
object-
comment:
string
Title:
CommentComment -
companyAssociations:
string
Title:
Company AssociationsCompany Associations -
cost:
number
Title:
Cost -
description:
string
Title:
DescriptionDescription -
directBuy:
string
Title:
Direct BuyDirect Buy -
extendedDescription1:
string
Title:
Extended Description 1Extended Description 1 -
extendedDescription2:
string
Title:
Extended Description 2Extended Description 2 -
id:
string
Title:
Part IdentifierIt uniquely identifies the part, used for selection of recommended parts. -
leadTime:
integer
Title:
Lead TimeLead Time -
maxdiscount%:
string
Title:
Max discount % -
partDisplayNumber:
string
Title:
Part Display NumberPart Display Number -
partNumber:
string
Title:
Part NumberPart Number -
price:
object Price
Title:
PricePrice -
pricePeriod:
object Price Period
Title:
Price Period -
priceType:
object Price Type
Title:
Price Type -
productGroup:
string
Title:
Product Group -
quantity:
integer
Title:
QuantityQuantity -
selected:
string
Title:
SelectionIt represents selection of the item. Selection can be 'true', 'false' or 'missing'. -
units:
string
Title:
UnitsUnits
Nested Schema : Price Period
Type:
objectTitle:
Show Source
Price Period-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Price Type
Type:
objectTitle:
Show Source
Price Type-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Examples
The following example shows how to retrieve the recommended parts 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/v16/configvarioTablets.tablets.customTablet/_recmdParts/actions/getRecmdParts
Request Body Sample
{
"cacheInstanceId": "gsg21bMZ5kpGUWxDIZeGWQCLKbaad33Un1X8huVuDm0K3gAKMeXPbzeQcFsFBAzJ"
}
Response Body Sample
The following example shows the contents of the response body in JSON format:
{
"cacheInstanceId": "gsg21bMZ5kpGUWxDIZeGWQCLKbaad33Un1X8huVuDm0K3gAKMeXPbzeQcFsFBAzJ",
"items": [{
"id": "part~BATT-0380M-5200~battery5200mAH",
"selected": "true",
"leadTime": -1,
"comment": "System recommended item",
"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": ""
}
]
}