Reconfigure Model
/rest/v19/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_reconfigureTxn
Note: Beginning in Oracle CPQ 20C, the
headlessMode
property replaces the legacyMode
property in v11 Configuration REST APIs. If you explicitly set the legacyMode
property in your REST calls, you need to remove the legacyMode
property from v11 REST calls.Request
- application/json
-
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
object
-
bsId(required):
integer
Title:
Buyside Identifier
Buyside Identifier -
configContextKey:
string
Title:
ABO Config Context Key Global Cache Identifier
ABO Config Context Key Global Cache Identifier -
criteria:
object Query Definition
Title:
Query Definition
Captures the query definition for the current resource request. -
documentId(required):
integer
Title:
Document Id
The unique Identifier of the Main document or Sub Document -
documentNumber(required):
integer
Title:
Document Number
Document number. -
headlessMode:
boolean
Title:
Headless Mode
This boolean parameter determines the API execution behavior. When false, the API honors CPQ legacy Configuration Layout Flow behavior, with the relevant attribute values to be overridden as defined in the current CPQ legacy Configuration Layout Flow. This value will provide the behavior that legacyMode value of 'true' provided in previous versions of the API. When true, the API does NOT send UI information or honor CPQ legacy Configuration Layout Flow. The default value is 'false'.
object
Query Definition
-
actions:
array actions
Array of actions names, whose state is requested in the state object response.
-
childDefs:
array childDefs
-
enableHierarchy:
boolean
Parameter value should be true to execute hierarchy search and sort. Default value is false.
-
excludeFieldTypes:
array excludeFieldTypes
Array of field names that you want to exclude in the response.
-
expand:
array expand
Array of child resource names that you want to expand so that the contents return with the parent in the same request.
-
expandedDomainCriteria:
array expandedDomainCriteria
Map of dynamic menu field names, whose expanded domains are requested in the state object response, to a map of criteria, which are meant for filtering dynamic menu options. The criteria map should contain the node(s) information when dynamic menus on LIG are expanded. The criteria map also contains the search string. The search strings support contains, and are case-insensitive.
-
expandedDomains:
array expandedDomains
Array of field names, whose expanded domains are requested in the state object response.
-
expandNodes:
boolean
Boolean value that only be available when enableHierarchy is true. True = all nodes will be expanded; False = All nodes will be collapsed.Default value is true.
-
fields:
array fields
Array of field names that you wanted returned in a request.
-
groups:
array groups
Array of group names, whose state is requested in the state object response.
-
limit:
integer
Positive integer value that specifies the maximum number of items returned by the server.
-
nodesExceptionList:
array nodesExceptionList
Array of document_number, recording the nodes that violate current expandNodes flag
-
offset:
integer
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
-
orderBy:
array orderBy
Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q:
string
Filter (a ???where???clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
state:
boolean
Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated.
-
totalResults:
boolean
Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.
array
array
-
Array of:
object Child query criteria.
Title:
Child query criteria.
Captures the query criteria for the child resource.
array
array
array
array
array
array
array
array
object
Child query criteria.
-
name:
string
Rest alias name of the child resource this query belongs to.
-
queryDef:
object Query Definition
Title:
Query Definition
Captures the query definition for the current resource request. -
recursive:
boolean
Boolean value that specifies whether this query is a recursive expand on the current child resource query.
Response
- application/json
Default Response
object
-
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. -
configData:
object configData
-
systemCurrentDate:
string
Title:
System Current Date
The system's current date.
object
-
_bom:
object BOM Items
Title:
BOM Items
BOM items of the configuration. -
_isMainModelSelected:
boolean
Title:
Is Main Model Selected
Boolean flag for main model selection. -
_mandatoryModels:
object Mandatory Models
Title:
Mandatory Models
Mandatory models of the configuration. -
_mandatoryParts:
object Mandatory Parts
Title:
Mandatory Parts
Mandatory parts of the configuration. -
_pickList:
object Pick List
Title:
Pick List
-
_priceInfo:
object Price Information
Title:
Price Information
Price Information. -
_recmdModels:
object Recommended Models
Title:
Recommended Models
Recommended models of the configuration. -
_recmdParts:
object Recommended Parts
Title:
Recommended Parts
Recommended parts of the configuration. -
_set{arraySetVarName}:
object Array Set Name
Title:
Array Set Name
-
_state:
object state
Title:
state
Captures 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 Service
Metered Storage will allow you to exceed your drive size but with additional fees. -
cloudStorage:
object Cloud Storage
Title:
Cloud Storage
There 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
object
Mandatory Models
object
Mandatory Parts
object
Pick List
-
items:
array items
-
variableName:
string
Title:
Variable Name
It uniquely identifies the pick list.
object
Price Information
-
items:
array items
-
name:
string
Title:
Display Name
Display Name
object
Recommended Models
object
Recommended Parts
object
Array Set Name
-
_index:
integer
Title:
Index
Index of the element in the array set. -
_rowKey:
string
Title:
RowKey
Key of the element in the array set.
object
state
-
actions:
object Actions
Title:
Actions
Captures 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:
Attributes
Captures 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:
Deletable
Boolean value that specifies whether the row can be deleted. -
focus:
object Focused Users
Title:
Focused Users
Details 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:
Groups
Captures 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 Error
Boolean value that specifies whether any error that occurred has been assigned to the row itself. -
hasWarning:
boolean
Title:
Has Warning
Boolean value that specifies whether any warning that was issued has been assigned to the row itself. - hidden: boolean
-
messages:
array Messages
Title:
Messages
Array of messages that have been generated for a specific object. -
updatable:
boolean
Title:
Updatable
Boolean value that specifies whether the row can be updated.
object
Cloud Service
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Cloud Storage
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Do you have storage appliances that need to be accessible to multiple employees?
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Form Factor
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Hard Drive
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
How many employees does your company have?
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
How much data do you currently manage and store?
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Number of Processors
-
displayValue:
string
Title:
Display Value
-
value:
integer
Title:
Value
object
Operating System
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Operating System
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Optical Drive
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Packaged Solutions
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Power Supply
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Processor
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Processor
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Server Rack
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
RAM
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
RAM Configuration
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Server Module
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
System
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Tier
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Servers
-
displayValue:
string
Title:
Display Value
-
value:
integer
Title:
Value
object
Support Level
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
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:
Comment
Comment -
companyAssociations:
string
Title:
Company Associations
Company Associations -
description:
string
Title:
Description
Description -
directBuy:
string
Title:
Direct Buy
Direct Buy -
extendedDescription1:
string
Title:
Extended Description 1
Extended Description 1 -
extendedDescription2:
string
Title:
Extended Description 2
Extended Description 2 -
id:
string
Title:
Part Identifier
It uniquely idenitfies the part, used for selection of recommended parts. -
leadTime:
integer
Title:
Lead Time
Lead Time -
partDisplayNumber:
string
Title:
Part Display Number
Part Display Number -
partNumber:
string
Title:
Part Number
Part Number -
price:
object Price
Title:
Price
Price -
quantity:
integer
Title:
Quantity
Quantity -
selected:
string
Title:
Selection
It represents selection of the item. Selection can be 'true', 'false' or 'missing'. -
units:
string
Title:
Units
Units
object
Product type
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Price Period
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
Price Type
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
-
_bm_model_description:
string
Title:
Product Model Description
Product model description. -
_bm_model_name:
string
Title:
Product Model Name
Product model display name. -
_bm_model_variable_name:
string
Title:
Product Model Variable Name
Unique variable name to identify the product model. -
customProperties:
object Custom Properties
Title:
Custom Properties
Custom properties of the product model. -
id:
integer
Title:
Id
Primary key of the product model. -
links:
array links
object
Custom Properties
array
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
object
reference links
-
href:
string
Title:
URL to the related object
URL to the related object -
rel:
string
Title:
Link Relationship to the current object
Link Relationship to the current object
object
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
-
code:
string
Title:
Category Code
-
displayName:
string
Title:
Display Name
Display Name
object
-
items:
array items
-
value:
string
Title:
Value
-
variableName:
string
Title:
Variable Name
object
-
price:
object Price Model
Title:
Price Model
Price Model -
value:
string
Title:
Value
object
-
price:
object Price Model
Title:
Price Model
Price Model -
value:
string
Title:
Value
-
variableName:
string
Title:
Variable Name
object
Actions
object
Attributes
object
Focused Users
object
Groups
array
Messages
-
Array of:
string
An error, warning, or informational message.
object
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
object
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Examples
This action is used for Model reconfiguration from the Transaction or Transaction line to execute the configuration rules in order to retain the previous selection and configuration data. This must be used in conjunction with the Reconfigure API of Commerce Transaction or Transaction Line.
The following examples show how to search parts by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -H "Authorization: Bearer <token>" "https://sitename.oracle.com/rest/v19/configvision.servers.ultraPowerSolutionPackage/actions/_reconfigureTxn" \ -X POST \ -H "Content-type: application/json" \ -H \
Request Body Sample
{ "bsId": 38458354, "documentNumber": 2, "documentId": 18319026, "criteria": { "state": true, "childDefs": [{ "name": "_priceInfo" }, { "name": "_recmdModels" }, { "name": "_mandatoryModels" }, { "name": "_recmdParts" }, { "name": "_mandatoryParts" }, { "name": "_bom" } ] } }
Response Body Sample
{ "cacheInstanceId": "DJy4zFjQqMgkfCXYAD9OgKf3Teyqcnvi3QtQ1nJICFjs2MsvNWecrsHJYw7sLKul", "configData": { "supportLevel": { "value": "Vision Gold", "displayValue": "Vision Gold" }, "_mandatoryParts": { "items": [{ "leadTime": -1, "comment": "Support Level", "price": { "value": "On Request", "currency": "USD" }, "partNumber": "WR11519", "description": "Vision Gold Service Plan", "units": "", "directBuy": "Direct Buy", "quantity": 1, "_part_custom_field1": "Service", "_part_custom_field3": "21", "_part_custom_field8": { "value": "Recurring", "displayValue": "Recurring" }, "_part_custom_field5": 0, "companyAssociations": "" }, { "leadTime": -1, "comment": "Power Supply", "price": { "value": "69.95", "currency": "USD" }, "partNumber": "CM53064", "description": "600W Power Supply", "units": "", "directBuy": "Direct Buy", "quantity": 1, "_part_custom_field1": "Hardware", "_part_custom_field3": "17", "_part_custom_field8": { "value": "One Time", "displayValue": "One Time" }, "_part_custom_field5": 41.97, "companyAssociations": "" } ] }, "_isMainModelSelected": true, "_bom": {}, "powerSupply": { "value": "600W PSU", "displayValue": "600W PSU" }, "_priceInfo": { "items": [{ "category": { "code": "GENERAL", "displayName": "Price" }, "_others": [{ "name": "Base Price", "variableName": "_basePrice", "price": { "value": 15131.67, "currency": "USD" } }, { "name": "Total Configured Price of Model", "variableName": "_totalConfiguredPrice", "price": { "value": 15131.67, "currency": "USD" } } ] } ], "name": "Price" }, "_recmdParts": { "items": [{ "id": "part~CM53064~redundantPSUSuggested", "selected": "true", "leadTime": -1, "comment": "Redundant Power Supply", "price": { "value": "69.95", "currency": "USD" }, "partNumber": "CM53064", "description": "600W Power Supply", "units": "", "directBuy": "Direct Buy", "quantity": 1, "_part_custom_field1": "Hardware", "_part_custom_field3": "17", "_part_custom_field8": { "value": "One Time", "displayValue": "One Time" }, "_part_custom_field5": 41.97, "companyAssociations": "" }, { "id": "part~AS00117~recommendCloudSoftware", "selected": "true", "leadTime": -1, "comment": "Cloud Backup Add-on", "price": { "value": "99.99", "currency": "USD" }, "partNumber": "AS00117", "description": "Vision Cloud Management Software", "units": "", "directBuy": "Direct Buy", "quantity": 1, "_part_custom_field1": "Software", "_part_custom_field3": "19", "_part_custom_field8": { "value": "Recurring", "displayValue": "Recurring" }, "_part_custom_field5": 19.99, "companyAssociations": "" } ] }, "_mandatoryModels": {} }, "_flow": { "flow": "serverSolutionsProduct", "productFamily": "vision", "productLine": "servers", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/productLines/servers/layouts/serverSolutionsProduct" } ] } }
Reconfigure a Model Line from Transaction
URI Endpoint Sample
https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38458354/actions/_reconfigure_action
Request Body Sample
{ "documents": { "Quote Name": "Pinnacle Technologies" }, "selections": ["transactionLine/2"] }
Response Body Sample
{ "revisionId": "4,0", "documents": { "_id": 38458354, "transactionLine": { "items": [{ "_document_number": 2 } ] }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v9/commerceDocumentsOraclecpqoTransaction/38458354" } ] }, "warnings": {}, "cacheInstanceId": "wdDhTXWSfGMQROnPf4COEycFRYD0C6XD5OSJKMgqwczvkGpK8HJIuvcPFsiQ0baD", "destinationURL": "https://sitename.oracle.com/commerce/buyside/reconfig_form.jsp?action_id=36245411&document_number=1&document_id=36244074&id=38458354&proxy_submit_url=%2Fcommerce%2Fnew_equipment%2Fproducts%2Fmodel_configs.jsp&_line_item_list=2" }
Reconfigure a Model Line from Transaction Line
URI Endpoint Sample
https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38458354/transactionLine/2/actions/_reconfigure_action
Request Body Sample
{ "documents": { "Quote Name": "Pinnacle Technologies" } }
Response Body Sample
{ "revisionId": "4,0", "documents": { "_id": 38458354, "transactionLine": { "items": [{ "_document_number": 2 } ] }, "links": [{ "rel": "self", "href": "https://sitename.com/rest/v19/commerceDocumentsOraclecpqoTransaction/38458354" } ] }, "warnings": {}, "cacheInstanceId": "wdDhTXWSfGMQROnPf4COEycFRYD0C6XD5OSJKMgqwczvkGpK8HJIuvcPFsiQ0baD", "destinationURL": "https://sitename.oracle.com/commerce/buyside/reconfig_form.jsp?action_id=36245411&document_number=1&document_id=36244074&id=38458354&proxy_submit_url=%2Fcommerce%2Fnew_equipment%2Fproducts%2Fmodel_configs.jsp&_line_item_list=2" }