Add Model to Favorites
post
/rest/v19/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_cm_favoriteslistinvocationID
This action adds the current valid model configuration to the Favorites list. The process invocation ID defined as the target for the Favorites is used. The response includes the Favorite ID and the destination URL.
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 : FavoritesListProcessInvocationRequest
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. -
configData:
object configData
Nested Schema : configData
Type:
Show Source
object-
_bom:
object BOM Items
Title:
BOM ItemsBOM items of the configuration. -
_isMainModelSelected:
boolean
Title:
Is Main Model SelectedBoolean flag for main model selection. -
_mandatoryModels:
object Mandatory Models
Title:
Mandatory ModelsMandatory models of the configuration. -
_mandatoryParts:
object Mandatory Parts
Title:
Mandatory PartsMandatory parts of the configuration. -
_pickList:
object Pick List
Title:
Pick List -
_priceInfo:
object Price Information
Title:
Price InformationPrice Information. -
_recmdModels:
object Recommended Models
Title:
Recommended ModelsRecommended models of the configuration. -
_recmdParts:
object Recommended Parts
Title:
Recommended PartsRecommended parts of the configuration. -
_set{arraySetVarName}:
object Array Set Name
Title:
Array Set Name -
_state:
object state
Title:
stateCaptures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included. -
additionalHD:
boolean
Title:
Additional HDD's -
advancedSearchDirections:
string
Title:
Advanced Search Directions -
applicationSoftwareCounter:
integer
Title:
Application Counter [Array Control Attribute] -
arrayController:
integer
Title:
ArrayController -
bladeEnclosureImage:
string
Title:
Blade Enclosure Image [HTML] -
blades_quantity:
integer
Title:
Blades -
campaign:
string
Title:
Campaign -
cloudBackup:
boolean
Title:
Cloud Backup -
cloudServiceType:
object Cloud Service
Title:
Cloud ServiceMetered Storage will allow you to exceed your drive size but with additional fees. -
cloudStorage:
object Cloud Storage
Title:
Cloud StorageThere needs to be something here about metered and fixed pricing -
doYouHaveAnyStorageAppliances:
object Do you have storage appliances that need to be accessible to multiple employees?
Title:
Do you have storage appliances that need to be accessible to multiple employees? -
enclosure:
string
Title:
Enclosure -
enclosuresRequired:
integer
Title:
Enclosures Required -
extraRecommendedItemsCount:
integer
Title:
Extra Recommended Items Count -
floatPicker:
number
Title:
FloatPicker -
formFactor_selector:
object Form Factor
Title:
Form Factor -
hardDrives:
object Hard Drive
Title:
Hard Drive -
howManyEmployeesDoYouHaveNow:
object How many employees does your company have?
Title:
How many employees does your company have? -
howMuchDataDoYouCurrentlyManageAndStore:
object How much data do you currently manage and store?
Title:
How much data do you currently manage and store? -
intPicker:
integer
Title:
IntPicker -
iWantToBeAbleTo_selector:
object I want to be able to
Title:
I want to be able to -
modifyServiceDetails:
boolean
Title:
Modify Service Details -
monitoring:
object Monitoring
Title:
Monitoring -
numberOfProcessors:
object Number of Processors
Title:
Number of Processors -
operatingSystem:
object Operating System
Title:
Operating System -
operatingSystem_selector:
object Operating System
Title:
Operating System -
opticalDrive:
object Optical Drive
Title:
Optical Drive -
oSLicenses:
integer
Title:
OS Licenses -
overrideLowQuantity:
boolean
Title:
Override Low Quantity?Allows configuration to continue but ship date may be delayed. -
packagedSolutions:
object Packaged Solutions
Title:
Packaged Solutions -
powerSupply:
object Power Supply
Title:
Power Supply -
processors:
object Processor
Title:
Processor -
processors_selector:
object Processor
Title:
Processor -
rackEnclosures:
object Server Rack
Title:
Server Rack -
raidControl:
integer
Title:
HD Control [Array Control Attribute] -
ram:
object RAM
Title:
RAM -
ramConfiguration:
object RAM Configuration
Title:
RAM Configuration -
rebate:
string
Title:
Rebate -
redundantPowerSupply:
boolean
Title:
Redundant Power Supply -
remainingBladeSlots:
integer
Title:
Remaining Blade Slots -
serverChassis:
object Server Module
Title:
Server Module -
serverChassis_selector:
object System
Title:
System -
serverCounter:
integer
Title:
Server Counter [Array Control Attribute] -
serverPerformance:
object Tier
Title:
Tier -
servers_quantity:
object Servers
Title:
Servers -
serviceDetailController:
integer
Title:
Service Counter [Array Control Attribute] -
servicesRequested:
object Services Requested
Title:
Services Requested -
sLACounter:
integer
Title:
SLA Counter [Array Control Attribute] -
slimFloppyDrive:
boolean
Title:
Floppy Drive -
supportLevel:
object Support Level
Title:
Support Level -
totalEquipmentFORRULES:
integer
Title:
Total Equipment FOR RULES -
volumePriceInformation:
string
Title:
Volume Price Information
Nested Schema : Mandatory Models
Type:
objectTitle:
Mandatory ModelsMandatory models of the configuration.
Show Source
Nested Schema : Mandatory Parts
Type:
objectTitle:
Mandatory PartsMandatory parts of the configuration.
Show Source
Nested Schema : Pick List
Type:
objectTitle:
Show Source
Pick List-
items:
array items
-
variableName:
string
Title:
Variable NameIt uniquely identifies the pick list.
Nested Schema : Price Information
Type:
objectTitle:
Price InformationPrice Information.
Show Source
-
items:
array items
-
name:
string
Title:
Display NameDisplay Name
Nested Schema : Recommended Models
Type:
objectTitle:
Recommended ModelsRecommended models of the configuration.
Show Source
Nested Schema : Recommended Parts
Type:
objectTitle:
Recommended PartsRecommended parts of the configuration.
Show Source
Nested Schema : Array Set Name
Type:
objectTitle:
Show Source
Array Set Name-
_index:
integer
Title:
IndexIndex of the element in the array set. -
_rowKey:
string
Title:
RowKeyKey of the element in the array set.
Nested Schema : state
Type:
objectTitle:
stateCaptures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.
Show Source
-
actions:
object Actions
Title:
ActionsCaptures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action. -
attributes:
object Attributes
Title:
AttributesCaptures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute. -
deletable:
boolean
Title:
DeletableBoolean value that specifies whether the row can be deleted. -
focus:
object Focused Users
Title:
Focused UsersDetails about users who are focused on this item. The object contains one property per focused user, where the property name is the user's unique identifier. -
groups:
object Groups
Title:
GroupsCaptures the current state of each group whose state was requested. The object contains one property per group, where the property name is the expression string that uniquely identifies the group. -
hasError:
boolean
Title:
Has ErrorBoolean value that specifies whether any error that occurred has been assigned to the row itself. -
hasWarning:
boolean
Title:
Has WarningBoolean value that specifies whether any warning that was issued has been assigned to the row itself. - hidden: boolean
-
messages:
array Messages
Title:
MessagesArray of messages that have been generated for a specific object. -
updatable:
boolean
Title:
UpdatableBoolean value that specifies whether the row can be updated.
Nested Schema : Cloud Service
Type:
objectTitle:
Cloud ServiceMetered Storage will allow you to exceed your drive size but with additional fees.
Show Source
-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Cloud Storage
Type:
objectTitle:
Cloud StorageThere needs to be something here about metered and fixed pricing
Show Source
-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Do you have storage appliances that need to be accessible to multiple employees?
Type:
objectTitle:
Show Source
Do you have storage appliances that need to be accessible to multiple employees?-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Form Factor
Type:
objectTitle:
Show Source
Form Factor-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Hard Drive
Type:
objectTitle:
Show Source
Hard Drive-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : How many employees does your company have?
Type:
objectTitle:
Show Source
How many employees does your company have?-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : How much data do you currently manage and store?
Type:
objectTitle:
Show Source
How much data do you currently manage and store?-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Number of Processors
Type:
objectTitle:
Show Source
Number of Processors-
displayValue:
string
Title:
Display Value -
value:
integer
Title:
Value
Nested Schema : Operating System
Type:
objectTitle:
Show Source
Operating System-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Operating System
Type:
objectTitle:
Show Source
Operating System-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Optical Drive
Type:
objectTitle:
Show Source
Optical Drive-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Packaged Solutions
Type:
objectTitle:
Show Source
Packaged Solutions-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Power Supply
Type:
objectTitle:
Show Source
Power Supply-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Processor
Type:
objectTitle:
Show Source
Processor-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Processor
Type:
objectTitle:
Show Source
Processor-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Server Rack
Type:
objectTitle:
Show Source
Server Rack-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : RAM
Type:
objectTitle:
Show Source
RAM-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : RAM Configuration
Type:
objectTitle:
Show Source
RAM Configuration-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Server Module
Type:
objectTitle:
Show Source
Server Module-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : System
Type:
objectTitle:
Show Source
System-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Tier
Type:
objectTitle:
Show Source
Tier-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : Servers
Type:
objectTitle:
Show Source
Servers-
displayValue:
string
Title:
Display Value -
value:
integer
Title:
Value
Nested Schema : Support Level
Type:
objectTitle:
Show Source
Support Level-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : part
Type:
Show Source
object-
_part_custom_field1:
string
Title:
Product Group -
_part_custom_field10:
object Product type
Title:
Product type -
_part_custom_field3:
string
Title:
Max discount % -
_part_custom_field4:
object Price Period
Title:
Price Period -
_part_custom_field5:
number
Title:
Cost -
_part_custom_field8:
object Price Type
Title:
Price Type -
_part_custom_field9:
string
Title:
product -
comment:
string
Title:
CommentComment -
companyAssociations:
string
Title:
Company AssociationsCompany Associations -
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 idenitfies the part, used for selection of recommended parts. -
leadTime:
integer
Title:
Lead TimeLead Time -
partDisplayNumber:
string
Title:
Part Display NumberPart Display Number -
partNumber:
string
Title:
Part NumberPart Number -
price:
object Price
Title:
PricePrice -
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 : Product type
Type:
objectTitle:
Show Source
Product type-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
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
Nested Schema : model
Type:
Show Source
object-
_bm_model_description:
string
Title:
Product Model DescriptionProduct model description. -
_bm_model_name:
string
Title:
Product Model NameProduct model display name. -
_bm_model_variable_name:
string
Title:
Product Model Variable NameUnique variable name to identify the product model. -
customProperties:
object Custom Properties
Title:
Custom PropertiesCustom properties of the product model. -
id:
integer
Title:
IdPrimary key of the product model. -
links:
array links
Nested Schema : Custom Properties
Type:
objectTitle:
Custom PropertiesCustom properties of the product model.
Show Source
Nested Schema : links
Type:
Show Source
array-
Array of:
object reference links
Title:
reference linksReference links for the Parent, Self, Children and Related as applicable
Nested Schema : reference links
Type:
objectTitle:
reference linksReference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
URL to the related objectURL to the related object -
rel:
string
Title:
Link Relationship to the current objectLink Relationship to the current object
Nested Schema : items
Type:
Show Source
object-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : priceInfoCategory
Type:
Show Source
object-
code:
string
Title:
Category Code -
displayName:
string
Title:
Display NameDisplay Name
Nested Schema : avpPriceModel
Type:
Show Source
object-
items:
array items
-
value:
string
Title:
Value -
variableName:
string
Title:
Variable Name
Nested Schema : avpPriceItem
Type:
Show Source
object-
price:
object Price Model
Title:
Price ModelPrice Model -
value:
string
Title:
Value
Nested Schema : priceItem
Type:
Show Source
object-
price:
object Price Model
Title:
Price ModelPrice Model -
value:
string
Title:
Value -
variableName:
string
Title:
Variable Name
Nested Schema : Actions
Type:
objectTitle:
ActionsCaptures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
Nested Schema : Attributes
Type:
objectTitle:
AttributesCaptures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.
Nested Schema : Focused Users
Type:
objectTitle:
Focused UsersDetails about users who are focused on this item. The object contains one property per focused user, where the property name is the user's unique identifier.
Nested Schema : Groups
Type:
objectTitle:
GroupsCaptures the current state of each group whose state was requested. The object contains one property per group, where the property name is the expression string that uniquely identifies the group.
Nested Schema : Messages
Type:
arrayTitle:
MessagesArray of messages that have been generated for a specific object.
Show Source
-
Array of:
string
An error, warning, or informational message.
Nested Schema : items
Type:
Show Source
object-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : items
Type:
Show Source
object-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Nested Schema : items
Type:
Show Source
object-
displayValue:
string
Title:
Display Value -
value:
string
Title:
Value
Response
Supported Media Types
- application/json
Default Response
Root Schema : FavoritesListProcessInvocationResponse
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. -
destinationUrl:
string
Title:
Destination URLThe source identified by the action that launched the Configuration or Transaction. -
favoriteId:
integer
Title:
Favorite IdThe unique identifier for the Favorite list.
Examples
The following example shows how to add the current model configuration to the Favorites list by submitting a POST request to the REST resource using cURL.
curl -X POST -H "Authorization: Bearer <token>" -H "Accept: application/json" https://sitename.oracle.com/rest/v19/configvision.servers.ultraPowerSolutionPackage/actions/_cm_21734357
Request Body Sample
{
"cacheInstanceId": "TyorT0UiW6H2ahn6Io2hm44KpkPZmpcwBgs8P7csERyRfXTpOWyOaOVpnv12XZvTH",
"criteria": {
"state": true,
"childDefs": [{
"name": "_priceInfo"
}, {
"name": "_recmdModels"
}, {
"name": "_mandatoryModels"
}, {
"name": "_recmdParts"
}, {
"name": "_mandatoryParts"
}, {
"name": "_bom"
}
]
},
"delta": true
}
Response Body Sample
The following example shows the contents of the response body in JSON format:
{
"cacheInstanceId": "8xJxmWo7cN5P0ozcMmBBu6UpMj5XVo1EBzkqhLMKOJPPzNaxrMuSABD7YgGGdGRb",
"destinationUrl": "https://sitename.oracle.com/commerce/buyside/commerce_list.jsp?id=21734357",
"FavoriteId": 21734357
}