Overview
Oracle CPQ exposes Configuration objects and configuration data through REST APIs and RESTful standards. The REST APIs provide a new, modern way to access Configuration information. With appropriate HTTP Basic authentication, any other third-party system can make use of these services.
The Configuration Run-Time Data endpoints expose information and perform an action for a model. All Configuration Run-Time Data REST APIs follow a required product hierarchy starting with the product family then product line followed by the model. A variable name for the product entity is required. For example, /config{prodFamVarName}.(prodLineVarName}.{modelVarName}/ is the standard Configuration Run-Time Data product path for an endpoint URL.
Configuration REST API Hierarchy
Configuration endpoints expose definition information for the Configuration Product Families, Product Lines, Models, attributes, array sets, menu items and translations. The information for these items is organized in a hierarchical structure. The following image displays the hierarchical relationship for Configuration REST API services.
Configuration Product REST API query parameters are supported to include and exclude child resources in a given resource. The response for each level in the hierarchy can include the details of the sub resources based on the query parameter passed in the request.
The Configuration Product Query parameter to include sub resource is "expand". The Configuration Product Query parameter to exclude the link is "excludeLinks". For information about REST API query parameters, see Manage Collections.
Administration
The endpoint for each REST API appends onto https://{siteurl}, where {siteurl} is the base URL of the Oracle CPQ site.
Add from Catalog (Configuration) Not supported after v7
https://sitename.oracle.com/rest/v7/configvision.servers.ultraPowerSolutionPackage/actions/_addFromCatalog
{ "bsId": 21223994, "documentId": 18319026, "configData": { "serverPerformance": { "value": "Mid Range", "displayValue": "Mid Range" } }, "criteria": { "state": true, "fields": ["supportLevel", "powerSupply"], "childDefs": [{ "name": "_priceInfo" }, { "name": "_recmdModels" }, { "name": "_mandatoryModels" }, { "name": "_recmdParts" }, { "name": "_mandatoryParts" }, { "name": "_bom" } ] } }
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/actions/_cm_21734357
{ "cacheInstanceId": "TyorT0UiW6H2ahn6Io2hm44KpkPZmpcwBgs8P7csERyRfXTpOWyOaOVpnv7XZvTH", "criteria": { "state": true, "childDefs": [{ "name": "_priceInfo" }, { "name": "_recmdModels" }, { "name": "_mandatoryModels" }, { "name": "_recmdParts" }, { "name": "_mandatoryParts" }, { "name": "_bom" } ] }, "delta": true }
{ "cacheInstanceId": "8xJxmWo7cN5P0ozcMmBBu6UpMj5XVo1EBzkqhLMKOJPPzNaxrMuSABD7YgGGdGRb", "destinationUrl": "https://sitename.oracle.com/commerce/buyside/commerce_list.jsp?id=21734357", "FavoriteId": 21734357 }
URI Endpoint Sample adding an row in the "applicationSoftware" array set
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/_setapplicationSoftware/actions/_add
{ "cacheInstanceId": "WOSeTwyqtdOO2BnrSShDZoRTTVq4oj1tSfGP3bjdSTUxJFiU4SkYcTgUuC8QZgZW" }
{ "items": [{ "_index": 0, "softwarePackage_array": { "value": "Cloud Management", "displayValue": "Cloud Management" }, "licenses_array": 1, "maintenance_array": "Data Protection Software Maintenance", "qty_array": 1, "startDate_array": "2018-12-06", "endDate_array": "2021-12-05" }, { "_index": 1, "softwarePackage_array": { "value": "Storage Resource Management", "displayValue": "Storage Resource Management" }, "licenses_array": 1, "maintenance_array": "Storage Resource Management Software Maintenance", "qty_array": 1, "startDate_array": "2018-12-06", "endDate_array": "2018-12-06" } ], "cacheInstanceId": "WOSeTwyqtdOO2BnrSShDZoRTTVq4oj1tSfGP3bjdSTUxJFiU4SkYcTgUuC8QZgZW" }
Add Configuration Data to Transaction
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/actions/_addToTxn
{ "cacheInstanceId": "DJy4zFjQqMgkfCXYAD9OgKf3Teyqcnvi3QtQ1nJICFjs2MsvNWecrsHJYw7sLKul" }
Response Body Sample when no errors are present in the Configuration
{ "destinationUrl": "https://sitename.oracle.com/commerce/buyside/document.jsp", "bsId": 36738986, "processId": 36244034 }
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/actions/_cancel
{ "cacheInstanceId": "DJy4zFjQqMgkfCXYAD9OgKf3Teyqcnvi3QtQ1nJICFjs2MsvNWecrsHJYw7sLKul" }
Response Body Sample when source is Transaction UI
{ "destinationUrl": "https://sitename.oracle.com/commerce/buyside/document.jsp", "bsId": 36738986, "processId": 36244034 }
|
Description |
This action supports Configuration integration, such as with Salesforce, Oracle Sales, or Oracle CX Commerce, which is set up at the Product Family. The property fromPartner must to be set to true while running this REST call. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_integration_{integrationVarName} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
modelVarName |
The variable name of a Model |
|
|
integrationVarName |
The variable name of the integration |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
cacheInstanceId |
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. (Required) |
|
Response Body Parameters |
destinationUrl |
The source identified by the action that launched the Configuration or Transaction |
|
integrationPayload |
The payload record for the integration | |
URI Endpoint Sample for Add to Cart
https://sitename.oracle.com/rest/v17/configlaptop.laptopConfiguration.sku50001/actions/_integration_addToCart
{ "cacheInstanceId": "8PK7Jh2fSZTgE9MjmCwLcC7yqt7w7t0VSF1GdUeavvgvkrab0wxSIuquLWManmJh", "configData": { "includeBOM": true, "processor": { "value": "sku40002", "displayValue": "Intel Pentium i3" }, "memory_HardDisk": { "value": "sku40008", "displayValue": "500GB" }, "addBOMChild": false, "addBOMGrandchild": false, "memory_RAM": { "value": "sku40007", "displayValue": "8 GB Kingston Sodimm DDR3 1600MHz" }, "graphicsCard": { "value": "sku40011", "displayValue": "Intel HD Graphics Media Accelerator 4600" }, "addBOMGreatGrandchild": false, "currencyCode": "", "_isMainModelSelected": true, "addSkus": false }, "criteria": { "state": true, "childDefs": [{ "name": "_priceInfo" }, { "name": "_recmdModels" }, { "name": "_mandatoryModels" }, { "name": "_recmdParts" }, { "name": "_mandatoryParts" }, { "name": "_bom" } ] } }
{ "destinationUrl": "https://transactionCloud.com", "integrationPayload": "21501698" }
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/actions/_configure
{
"cacheInstanceId": "-1",
"fromPunchin": false,
"modelPunchin": {
"flowInputs": {
"condition1": "true"
},
"parameters": {
"_variable_name_punchin": "true"
},
"searchResults": {
"textAttr1": "value1",
"textAttr2": "value2"
}
},
"configData": {
"serverCounter": 1,
"powerSupply": {
"value": "600W PSU",
"displayValue": "600W PSU"
},
"enclosure": "Vision Blade 6000 Chassis",
"howMuchDataDoYouCurrentlyManageAndStore": {
"value": "1 TB - 5 TB",
"displayValue": "1 TB - 5 TB"
},
"ram": {
"value": "4 GB RAM",
"displayValue": "4 GB RAM"
},
"ramConfiguration": {
"value": "2 Sticks",
"displayValue": "2 Sticks"
},
"slimFloppyDrive": false,
"serverPerformance": {
"value": "Entry Level",
"displayValue": "Entry Level"
},
"supportLevel": {
"value": "Vision Gold",
"displayValue": "Vision Gold"
},
"oSLicenses": 1,
"overrideLowQuantity": false,
"howManyEmployeesDoYouHaveNow": {
"value": "26 - 100",
"displayValue": "26 - 100"
},
"intSSPL": {
"value": 5,
"displayValue": "5"
},
"applicationSoftwareCounter": 4,
"blades_quantity": 1,
"numberOfProcessors": {
"value": 2,
"displayValue": "2"
},
"_setsampleSet1": {
"items": [{
"index": 0,
"arrayTxt": "Txt",
"arrayInt": 1,
"arrayBool": true,
"arraySSM1": {
"value": "B",
"displayValue": "B"
}
}
]
},
"_recmdModels": {
"items": [{
"id": "model~recommendationRules~recommendedItems",
"selected": "true"
}
],
"selectAll": true
},
"_recmdParts": {
"selectAll": false,
"items": [{
"id": "part~Basic Pricing 04~recommendedItems",
"selected": "true"
}
]
}
},
"criteria": {
"childDefs": [{
"name": "_setsampleSet1"
}
],
"expand": ["_recmdParts", "_recmdModels"]
}
}
{ "cacheInstanceId": "aD4GoSUktOGhWkRSZIWZ67SPKHxx5MKQuATO9fZOK3X5UyZd2XlyR7RU45JaXGfq", "configData": { "serverCounter": 1, "powerSupply": { "value": "600W PSU", "displayValue": "600W PSU" }, "enclosure": "Vision Blade 6000 Chassis", "howMuchDataDoYouCurrentlyManageAndStore": { "value": "1 TB - 5 TB", "displayValue": "1 TB - 5 TB" }, "ram": { "value": "4 GB RAM", "displayValue": "4 GB RAM" }, "ramConfiguration": { "value": "2 Sticks", "displayValue": "2 Sticks" }, "slimFloppyDrive": false, "serverPerformance": { "value": "Entry Level", "displayValue": "Entry Level" }, "supportLevel": { "value": "Vision Gold", "displayValue": "Vision Gold" }, "oSLicenses": 1, "overrideLowQuantity": false, "howManyEmployeesDoYouHaveNow": { "value": "26 - 100", "displayValue": "26 - 100" }, "intSSPL": { "value": 5, "displayValue": "5", "links": [{ "rel": "related", "href": "http://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/_pickLists/intSSPL" } ] }, "applicationSoftwareCounter": 4, "blades_quantity": 1, "numberOfProcessors": { "value": 2, "displayValue": "2" }, "_isMainModelSelected": true, "sLACounter": 1, "hardDrives": { "value": "450 GB 15k HDD", "displayValue": "450 GB 15k HDD" }, "opticalDrive": { "value": "Yes", "displayValue": "Yes" }, "floatSSPL": { "value": 1.2, "displayValue": "1.2", "links": [{ "rel": "related", "href": "http://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/_pickLists/floatSSPL" } ] }, "cloudStorage": { "value": "500 GB", "displayValue": "500 GB" }, "modifyServiceDetails": false, "processors_selector": { "value": "All Processors", "displayValue": "All Processors" }, "doYouHaveAnyStorageAppliances": { "value": "No", "displayValue": "No" }, "operatingSystem_selector": { "value": "All Operating Systems", "displayValue": "All Operating Systems" }, "servicesRequested": { "items": [{ "value": "Network Technician", "displayValue": "Network Technician" } ] }, "cloudServiceType": { "value": "Fixed", "displayValue": "Fixed" }, "formFactor_selector": { "value": "All Form Factors", "displayValue": "All Form Factors" }, "processors": { "value": "Vision E3-2470 8 Cores 2.3 Ghz", "displayValue": "Vision E3-2470 8 Cores 2.3 Ghz" }, "operatingSystem": { "value": "Oracle Linux", "displayValue": "Oracle Linux" }, "advancedSearchDirections": "<h3 class='directions_sel'>Select one or more criteria below to find servers that meet your need.</h3>", "cloudBackup": true, "serverChassis_selector": { "value": "All Systems", "displayValue": "All Systems" }, "serverChassis": { "value": "Green Server 3500", "displayValue": "Green Server 3500" }, "volumePriceInformation": "<table id=\"osVolumeTable\" cellpadding=\"10\" border=\"0\"><tbody><tr><th colspan='2'>Volume Pricing</th></tr><tr><td class=\"osVolumeText\">Price Per Unit</td><td class=\"osCurrency\">$49.95</td></tr><tr><td class=\"osVolumeText\">Next Price Break</td><td class=\"osCurrency\">5 at $47.95</td></tr></tbody></table>", "rackEnclosures": { "value": "Vision Rack I 1012RU", "displayValue": "Vision Rack I 1012RU" }, "packagedSolutions": { "value": "Custom Configuration", "displayValue": "Customize" }, "condition1": "true", "textAttr1": "value1", "textAttr2": "value2", "_setsampleSet1": { "items": [{ "index": 0, "arrayTxt": "Txt", "arrayInt": 1, "arrayBool": true, "arrayCurr": null, "arraySSM1": { "value": "B", "displayValue": "B" } }, { "index": 1, "arrayTxt": null, "arrayInt": null, "arrayBool": false, "arrayCurr": null, "arraySSM1": { "value": "A", "displayValue": "A" } } ] }, "links": [{ "rel": "child", "href": "http://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/_bom" }, { "rel": "child", "href": "http://sitename.us.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/_recmdModels" }, { "rel": "child", "href": "http://sitename.us.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/_mandatoryModels" }, { "rel": "child", "href": "http://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/_recmdParts" }, { "rel": "child", "href": "http://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/_mandatoryParts" }, { "rel": "child", "href": "http://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/_pickLists" }, { "rel": "child", "href": "http://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/arraySet/applicationSoftware" }, { "rel": "child", "href": "http://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/arraySet/serviceDetails" }, { "rel": "child", "href": "http://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/arraySet/advancedServerConfiguration" } ], "servers_quantity": { "value": 1, "displayValue": "1" }, "redundantPowerSupply": false, "bladeEnclosureImage": "<img src=\"$BASE_PATH$/Dynamic/b1.jpg\" width='200px' />", "totalEquipmentFORRULES": 1 }, "_recmdParts": { "selectAll": true, "items": [{ "id": "part~part3~performanceAdvancedAction", "selected": "true", "partNumber": "part3", "comment": "Part returned from hardcoded recommended items action returning 3 parts", "price": { "value": 3.33, "currency": "USD" }, "extendedDescription1": "Extended description 1 for part3", "description": "", "directBuy": "Direct Buy", "quantity": 3, "_part_custom_field19": "Custom Field 19, part3", "_part_custom_field18": "Custom Field 18, part3", "_part_custom_field27": "Custom Field 27, part3", "_part_custom_field26": "Custom Field 26, part3", "_part_custom_field4": "", "_part_custom_field25": "Custom Field 25, part3", "_part_custom_field24": "Custom Field 24, part3", "_part_custom_field9": { "value": "100K Parts", "displayValue": "100K Parts" }, "_part_custom_field23": "Custom Field 23, part3", "_part_custom_field8": null, "_part_custom_field22": "Custom Field 22, part3" } ] } "systemCurrentDate": "2023-09-29", "lastDeployedDate": "2023-08-03T02:48:47.000Z", "_flow": { "flow": "default", "productFamily": "vision", "productLine": "servers", "model": "ultraPowerSolutionPackage", "allPF": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/layouts/default" } ] } }
Reconfigure a Model Line from a Transaction
This action provides the ability to reconfigure a Model Transaction Line from a Transaction.
https://sitename.oracle.com/rest/v17/commerceDocumentsOraclecpqoTransaction/38458354/actions/_reconfigure_action
{ "documents": { "Quote Name": "Pinnacle Technologies" }, "selections": ["transactionLine/2"] }
{ "revisionId": "4,0", "documents": { "_id": 38458354, "transactionLine": { "items": [{ "_document_number": 2 } ] }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/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" }
For Asset-Based Ordering, the Configure Model action is used when modifying an asset or creating a follow-on order.
Internal Asset Modification Flows
The Configure Model REST API accepts the following request body parameters for internal asset modification flows:
- configContextKey - a key to the global cache entry which contains the projected BOM and configuration. It is used to pass ABO package data between Commerce and Configuration.
- rootBomItemId – The identifier for the root BOM item.
For asset modification the "configContextKey" and "rootBomItemId" parameters are retrieved from the Modify Asset response. For follow-on orders the "configContextKey" and "rootBomItemId" parameters are retrieved from the Commerce Transaction Create Follow-On Order response.
Configure Model Request Body Sample (Internal Asset Modification Flow)
{ "configContextKey":"77ba84ec-8a6d-4cc1-845c-910d2515b388", "bsId":21587946, "rootBomItemId":"BOM_SysConfigRoot", "criteria":{ "expand":["_sysNavigationInfo"] } }
External Asset Modification Flows
For external asset modification flows the Configure Model REST API accepts the following request body parameters:
- fromPartner - indicates that configure is requested from partner site. The value is true for client-side integrations. This value is automatically set to "true" when an assetKey is provided.
- assetKey – a key that uniquely identifies the asset component for the lifetime of the asset.
- transactionDate - the date and time that the service request needs to be processed or fulfilled. This field is optional when an assetKey is provided. This is not allowed when an assetKey is not provided.
- transactionId - the current Transaction identifier for external process integrations.
Configure Model Request Body Sample (External Asset Modification Flow)
{ "fromPartner":true, "assetKey":"abo_8e8f0f1f-7837-4d2f-886d-542abdac5ace", "transactionDate":"2019-02-06T00:00:000Z", "transactionId": "2341sdg" }
For additional information refer to Asset-Based Ordering.
Within the Configuration Run-Time Data REST API, users can select/deselect the recommended parts/models of a Configuration. In v7, only individual item selection is supported.
Beginning in v8, a "selectAll" (boolean) property is introduced for _recmdParts and _recmdModels resource to select/deselect the items at the same time. This minimizes the number of requests and size of the payload for all endpoints which allow/accept the selection of the _recmdParts and _recmdModels.
The following criteria applies:
- If the user enters "selectAll" as true and few individual items selection as false in the API request body, the system sets selection as false for the individual items and true for rest of the items.
- If user enters "selectAll" as false and few individual items selection as true in the API request body, the system sets selection as true for the individual items and false for rest of the items.
- If user enters only "selectAll" value (and no individual items selection) in the API request body , the system considers "selectAll" value is applied to all the items.
In v8 when the attribute Auto Lock property is enabled, support for the user to set the lock value to true or false in the Configuration Run-Time Data REST API is available, as follows:
- The locked property is provided in the response or is read from the request based on the Set Type property defined at attribute/layout level. Set Type should be "Set".
- When an attribute Auto Lock is set to on via the Attribute Definition page or layout setting and the user does not pass any value for the lock property in the request, then the lock value is set to true.
- When Auto Lock is set to off via the Attribute Definition page or layout setting, then the user must pass the lock value as true explicitly to honor this value over the recommendation rule value.
- If there is no Set Type and Auto Lock defined at the attribute/layout-level and a recommendation rule is acting on an attribute, then Auto Lock is implicitly turned on internally and the lock is set to true.
For more information, refer to Recommendation Rules - Auto Lock.
The system navigation panel also allows users to switch between different models within the system configuration. Beginning in Oracle CPQ 19C the following Configuration Run-Time Data REST API service endpoint supports system configuration navigation in the JET Configuration UI.
|
Description |
This action is used to navigate to and configure a model within a system configuration. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_configureInSystem |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
modelVarName |
The variable name of the target Model |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
cacheInstanceId |
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. |
|
targetModelPath |
Path to the model to navigate to. |
|
|
Response Body Parameters |
configData |
Configuration data for the target model. |
https://sitename.oracle.com/rest/v17/configtestbed.systemConfiguration.intermodelChild/actions/_configureInSystem
{ "cacheInstanceId": "TyorT0UiW6H2ahn6Io2hm44KpkPZmpcwBgs8P7csERyRfXTpOWyOaOVpnv7XZvTH", "targetModelPath": "_root$%#%$testbed:systemConfiguration:intermodelChild%$#$%0%$#$%0" }
{ "cacheInstanceId": "JPMfd0Vy7x7GsTuq7QihslWoB7P82iilzKo2wj7gIm88Q8uGO3doSEkvl6ak689s", "configData": { "rootValueToConstrain": "", "rootRecommendationType": { "value": "", "displayValue": "" }, "triggerGrandchildRecommendation": false, "grandchildRecommendationType": { "value": "", "displayValue": "" }, "triggerRootConstrainAll": false, "triggerRootHiding": false, "triggerRootRecommendation": false, "triggerGrandchildHiding": false, "grandchildValueToConstrain": "", "systemJSON": "{"id":"BOM_SysConfigRoot","documentNumber":-1,"conditionIndex":0,"configAttributes":{"searchFlowArrayBoolean":"false","triggerGrandchildRecommendation":false,"constraintApplyToConfiguration":false,"triggerChildHiding":false,"conditionsAllPF":false,"includeSystemConfigAttributeMappingModel":false,"addChildRecItems":false,"triggerChildConstraint":false,"triggerChildRecommendation":false,"includeNestedHierarchiesSubModel":false,"triggerGrandchildHiding":false,"includeBOMLineItemMapping":false,"recommendationApplyToBoth":false,"searchFlowBoolean":false,"includeBOMAttributeMapping":false,"constraintApplyToSelection":false,"triggerGrandchildConstraint":false,"constraintApplyToBoth":false,"advancedBOMMappingRuleToggle":false,"sTBRFiltersAllPF":false,"_array_key_searchFlowArrayControl":"eb785060-f2f4-4847-9519-74ea38b5e23a","includeIntermodelRuleModels":true,"sTBRFiltersPF":false,"includeStandardRecommendedItems":false,"recommendationsRuleOrderPFHierarchyCondition":false,"recommendationApplyToSelection":false,"bOMAwareSearchFlow":false,"searchFlowArrayTextField":"Default Value","_price_book_var_name":"_default_price_book","recommendationApplyToConfiguration":false,"triggerChildConstrainAll":false,"triggerGrandchildConstrainAll":false,"conditionsPF":false,"triggerMandatoryRecItem":false},"children":[{"id":"BOM_SysConfigIntermodelChild","documentNumber":-1,"conditionIndex":0,"configAttributes":{"_price_book_var_name":"_default_price_book"},"children":[{"id":"BOM_SysConfigIntermodelGrandChild","documentNumber":-1,"conditionIndex":0}]}]}", "childConstrainAllAttribute": "", "triggerGrandchildConstraint": false, "includeIntermodelRuleGrandchild": false, "advancedBOMMappingRuleToggle": false, "childHidingAttribute": "", "childRecommendedAttribute": "", "help": "This is the Child model in the Intermodel Rule System. The section labeled "Root Model Rule conditions" contains attributes that are used as conditions on the Attributes on the Root Model labelled "Intermodel Rule Attributes". The section labelled "Grandchild Model Rule conditions" contains attributes that are used as conditions on the Attributes on the Grandchild Model labelled "Intermodel Rule Attributes".", "rootValueToRecommend": "", "_price_book_var_name": { "value": "_default_price_book", "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v8 /configtestbed.systemConfiguration.intermodelChild/_priceBooks" }]}, "_sysNavigationInfo": { "items": [{ "items": [{ "items": [], "name": "Intermodel Child", "path": "_root$%#%$testbed:systemConfiguration:intermodelChild%$#$%0%$#$%0", "productFamily": "testbed", "productLine": "systemConfiguration", "model": "intermodelChild", "title": "", "isModel": true, "isActive": true, "_status": { "hasWarning": false, "hasConstraintViolation": false, "hasMissingMandatoryItem": false, "hasEmptyRequiredAttribute": false, "hasError": false, "hasFailedBomReverseMapping": false, "hasRecommendedItemChanged": false, "hasStarted": true, "isInvalid": false, "isIncomplete": false }}], "name": "Root System", "path": "_root", "productFamily": "testbed", "productLine": "systemConfiguration", "model": "rootSystem", "title": "", "isModel": true, "isActive": false, "_status": { "hasWarning": false, "hasConstraintViolation": false, "hasMissingMandatoryItem": false, "hasEmptyRequiredAttribute": false, "hasError": false, "hasFailedBomReverseMapping": false, "hasRecommendedItemChanged": false, "hasStarted": true, "isInvalid": false, "isIncomplete": false }}]}, "childConstrainedAttribute": "", "triggerGrandchildConstrainAll": false, "grandchildValueToRecommend": "", "triggerRootConstraint": false, "_isMainModelSelected": true }, "systemCurrentDate": "2019-07-25", "_flow": { "flow": "childFlow", "productFamily": "testbed", "productLine": "systemConfiguration", "model": "intermodelChild", "allPF": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/testbed/productLines/systemConfiguration/models/intermodelChild/layouts/childFlow" } ] } }
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/_setapplicationSoftware/actions/_delete
Remove a row based on indices
{ "cacheInstanceId": "WOSeTwyqtdOO2BnrSShDZoRTTVq4oj1tSfGP3bjdSTUxJFiU4SkYcTgUuC8QZgZW", "removeIndex": 1 }
{ "items": [{ "_index": 0, "softwarePackage_array": { "value": "Cloud Management", "displayValue": "Cloud Management" }, "licenses_array": 1, "maintenance_array": "Data Protection Software Maintenance", "qty_array": 1, "startDate_array": "2018-12-06", "endDate_array": "2021-12-05" } ], "cacheInstanceId": "WOSeTwyqtdOO2BnrSShDZoRTTVq4oj1tSfGP3bjdSTUxJFiU4SkYcTgUuC8QZgZW" }
Remove a row based on removeKey
{ "cacheInstanceId":"N6RpdipMCftpiBuGIYDaiG1PMNb8nkF5xdzpjT4whaOUj1RRNb6CIuIgOfh1CuxO", "removeKey":"a5f5dbc2-1f02-4096-b63a-babc26492c7a", "delta": true }
{ "items": [{ "_index": 0, "_rowKey": "6f0b3424-463c-422c-8798-4b232065d67a" }, { "_index": 1, "_rowKey": "d3c316e9-eb51-43fa-bab8-e7555b85c2c6" } ], "cacheInstanceId": "N6RpdipMCftpiBuGIYDaiG1PMNb8nkF5xdzpjT4whaOUj1RRNb6CIuIgOfh1CuxO" }
https://sitename.oracle.com/rest/v17/configvarioTablets.tablets.customTablet/actions/_dropCache
{ "cacheInstanceId": "y4ZJbMg6wxjnb6xdm33VPvtmtCx2WBBufU0naDHe75u4OBF4zCLOFPNs2dOtHEfr" }
|
Description |
This action provides the dynamic values for all the Pick List attributes in a given configuration available through the domain such as a Data Table or an Array. This endpoint retrieves a collection of pick lists and returns appropriate values in the response. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_pickLists/actions/getOptions |
|
|
Endpoint Parameters
|
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
modelVarName |
The variable name of a Model |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
cacheInstanceId |
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.(Required) |
|
Response Body Parameters |
cacheInstanceId |
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 |
A collection of all pick list attributes in a given configuration containing menu items. | |
https://sitename.oracle.com/rest/v17/configvision.laptops.ultra/_pickLists/actions/getOptions
{ "cacheInstanceId": "Uxs6rmxWky7QRMKEHxUK5IKv5GLTm2EeohummhWiiFFE76kxiYvil1tJfcTEbrjv" }
{ "cacheInstanceId": "Uxs6rmxWky7QRMKEHxUK5IKv5GLTm2EeohummhWiiFFE76kxiYvil1tJfcTEbrjv", "items": [{ "variableName": "cloudBackupSSPL", "items": [{ "value": "1 TB", "displayValue": "1 TB" }, { "value": "1 TB", "displayValue": "1 TB" }, { "value": "2 TB", "displayValue": "2 TB" }, { "value": "2 TB", "displayValue": "2 TB" }, { "value": "250 GB", "displayValue": "250 GB" }, { "value": "250 GB", "displayValue": "250 GB" }, { "value": "500 GB", "displayValue": "500 GB" }, { "value": "500 GB", "displayValue": "500 GB" } ], "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v17/configvision.laptops.ultra/_pickLists/cloudBackupSSPL" } ] }, { "variableName": "hardDrives", "items": [{ "value": "1 TB 10k HDD", "displayValue": "1 TB 10k HDD" }, { "value": "1 TB 7200 HDD", "displayValue": "1 TB 7200 HDD" }, { "value": "120 GB SSD", "displayValue": "120 GB SSD" }, { "value": "146 GB 15k HDD", "displayValue": "146 GB 15k HDD" }, { "value": "2 TB 7200 HDD", "displayValue": "2 TB 7200 HDD" }, { "value": "240 GB SSD", "displayValue": "240 GB SSD" }, { "value": "4 TB 7200 HDD", "displayValue": "4 TB 7200 HDD" }, { "value": "450 GB 15k HDD", "displayValue": "450 GB 15k HDD" }, { "value": "480 GB SSD", "displayValue": "480 GB SSD" }, { "value": "500 GB 10k HDD", "displayValue": "500 GB 10k HDD" } ], "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v17/configvision.laptops.ultra/_pickLists/hardDrives" } ] } ], "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v17/configvision.laptops.ultra/_pickLists" } ] }
|
Description |
This action retrieves the BOM Items of the configuration. This action does not run BOM Mapping rules. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_bom/actions/getBomItems |
|
|
Endpoint Parameters
|
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
modelVarName |
The variable name of a Model |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
cacheInstanceId |
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.(Required) |
|
Response Body Parameters |
cacheInstanceId |
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 |
A top-level array object in the payload containing the parts within a BOM. |
|
https://sitename.oracle.com/rest/v17/configvarioTablets.tablets.customTablet/bom/actions/getBomItems
{ "cacheInstanceId": "gsg21bMZ5kpGUWxDIZeGWQCLKbaad33Un1X8huVuDm0K3gAKMeXPbzeQcFsFBAzJ" }
|
Description |
This action retrieves the mandatory Models of the configuration. This action does not run recommended items rules. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_mandatoryModels/actions/getMandatoryModels |
|
|
Endpoint Parameters
|
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
modelVarName |
The variable name of a Model |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
cacheInstanceId |
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.(Required) |
|
Response Body Parameters |
cacheInstanceId |
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 |
A top-level object in the payload containing the array definitions for the Model. |
|
https://sitename.oracle.com/rest/v17/configvarioTablets.tablets.customTablet/_mandatoryModels/actions/getMandatoryModels
{ "cacheInstanceId": "hzLOQoY2hFvGJccRd43b2mQQfYeQZizF0yp5JBnglukKILuFROAGzEWkCV8K0XrN" }
{ "cacheInstanceId": "hzLOQoY2hFvGJccRd43b2mQQfYeQZizF0yp5JBnglukKILuFROAGzEWkCV8K0XrN", "items": [{ "modelName": "Tablet Support Services", "comment": "System recommended item", "price": { "value": "200", "currency": "USD" }, "modelVariableName": "tabletSupportServices", "quantity": 1, "description": "Tablet Support Services" } ] }
|
Description |
This action retrieves the mandatory parts of the configuration. This action does not run recommended items rules. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_mandatoryParts/actions/getMandatoryParts |
|
|
Endpoint Parameters
|
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
modelVarName |
The variable name of a Model |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
cacheInstanceId |
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.(Required) |
|
Response Body Parameters |
cacheInstanceId |
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 |
A top-level object in the payload containing the array definitions for the mandatory parts within the configuration. |
|
https://sitename.oracle.com/rest/v17/configvarioTablets.tablets.customTablet/_mandatoryModels/actions/getMandatoryParts
{ "cacheInstanceId": "gsg21bMZ5kpGUWxDIZeGWQCLKbaad33Un1X8huVuDm0K3gAKMeXPbzeQcFsFBAzJ" }
{ "cacheInstanceId": "gsg21bMZ5kpGUWxDIZeGWQCLKbaad33Un1X8huVuDm0K3gAKMeXPbzeQcFsFBAzJ", "items": [{ "leadTime": -1, "comment": "System recommended item", "price": { "value": "25.00", "currency": "USD" }, "partNumber": "Tablet-CloudBackupService", "description": "", "units": "", "directBuy": "Direct Buy", "quantity": 1, "_part_custom_field5": 0, "partDisplayNumber": "Tablet-CloudBackupService", "companyAssociations": "" }, { "leadTime": -1, "comment": "System recommended item", "price": { "value": "100.00", "currency": "USD" }, "partNumber": "Tablet-Warranty-2yrs", "description": "", "units": "", "directBuy": "Direct Buy", "quantity": 1, "_part_custom_field5": 0, "partDisplayNumber": "Tablet-Warranty-2yrs", "companyAssociations": "" }, { "leadTime": -1, "comment": "System recommended item", "price": { "value": "40.00", "currency": "USD" }, "partNumber": "MEM-100M-4", "description": "4GB Memory", "units": "", "directBuy": "Direct Buy", "quantity": 1, "_part_custom_field8": { "value": "One Time", "displayValue": "One Time" }, "_part_custom_field5": 20, "partDisplayNumber": "4GB Memory", "companyAssociations": "" } ] }
|
Description |
This action provides the dynamic values for the Pick List attribute available through a domain such as a Data Table or an Array. This endpoint consumes the filter value of the Pick List attribute and returns appropriate values in the response. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_pickLists/{pickListVarName}/actions/getOptions |
|
|
Endpoint Parameters
|
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
modelVarName |
The variable name of a Model |
|
|
pickListVarName |
The variable name of a pick list | |
|
HTTP Method |
POST |
|
| Request Body Parameters |
cacheInstanceId |
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.(Required) |
|
Response Body Parameters |
variableName |
The unique pick list Identifier |
|
cacheInstanceId |
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 |
A collection of all pick list attributes in a given configuration containing menu items. | |
https://sitename.oracle.com/rest/v17/configvision.laptops.ultra/_pickLists/cloudBackupSSPL/actions/getOptions
{ "cacheInstanceId": "u0yaJyAJ3qAzSBtYde9XKNFLyN2D5SZtvILBLwYMTK0JSBwBHihPGLoMrOn4xo7e" }
{ "cacheInstanceId": "u0yaJyAJ3qAzSBtYde9XKNFLyN2D5SZtvILBLwYMTK0JSBwBHihPGLoMrOn4xo7e", "variableName": "cloudBackupSSPL", "items": [{ "value": "1 TB", "displayValue": "1 TB" }, { "value": "1 TB", "displayValue": "1 TB" }, { "value": "2 TB", "displayValue": "2 TB" }, { "value": "2 TB", "displayValue": "2 TB" }, { "value": "250 GB", "displayValue": "250 GB" }, { "value": "250 GB", "displayValue": "250 GB" }, { "value": "500 GB", "displayValue": "500 GB" }, { "value": "500 GB", "displayValue": "500 GB" } ], "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v17/configvision.laptops.ultra/_pickLists/cloudBackupSSPL" } ] }
Get Price Books (Configuration)
|
Description |
This action provides the list of values for the Price Books within the configuration. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_priceBooks/actions/getPriceBooks |
|
|
Endpoint Parameters
|
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
modelVarName |
The variable name of a Model |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
cacheInstanceId |
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.(Required) |
| Response Body Parameters |
cacheInstanceId |
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 |
A top-level object in the payload containing the array definitions for the parts within the configuration. | |
https://sitename.oracle.com/rest/v17/configvarioTablets.tablets.customTablet/_priceBooks/actions/getPriceBooks
{ "cacheInstanceId": "HkcV5PiEEKTTl5aGmivM08ScumV5KFhDO7CHJQASzCLNnWisp4SEyXz0vfgKI62P" }
{ "cacheInstanceId": "HkcV5PiEEKTTl5aGmivM08ScumV5KFhDO7CHJQASzCLNnWisp4SEyXz0vfgKI62P", "items": [{ "value": "_default_price_book", "displayValue": "Base Price" }, { "value": "pricebook1", "displayValue": "Pricebook 1: Multiplier of Base Price (2.0x)" }, { "value": "pricebook2", "displayValue": "Pricebook 2: Multiplier of Base Price (0.5x)" }, { "value": "pricebook3", "displayValue": "Pricebook 3: Custom, All Currencies" }, { "value": "pricebook4", "displayValue": "Pricebook 4: Custom, Exchange Rates" }, { "value": "pricebook5", "displayValue": "Pricebook 5: Multiplier of Pricebook 3 (10.0x)" } ], "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v17/configvarioTablets.tablets.customTablet/_priceBooks" } ] }
|
Description |
This action retrieves the recommended Models of the configuration. This action does not run recommended items rules. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_recmdModels/actions/getRecmdModels |
|
|
Endpoint Parameters
|
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
modelVarName |
The variable name of a Model |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
cacheInstanceId |
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.(Required) |
|
Response Body Parameters |
cacheInstanceId |
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 |
A top-level object in the payload containing the array definitions for the recommended Model |
|
https://sitename.oracle.com/rest/v17/configvarioTablets.tablets.customTablet/recmdModels/actions/getRecmdModels
{ "cacheInstanceId": "gsg21bMZ5kpGUWxDIZeGWQCLKbaad33Un1X8huVuDm0K3gAKMeXPbzeQcFsFBAzJ" }
{ "cacheInstanceId": "gsg21bMZ5kpGUWxDIZeGWQCLKbaad33Un1X8huVuDm0K3gAKMeXPbzeQcFsFBAzJ", "items": [{ "id": "model~samsungPhablet~recommendedModelPhablet", "selected": "true", "modelName": "Samsung Phablet", "comment": "System recommended item", "price": { "value": "300", "currency": "USD" }, "modelVariableName": "samsungPhablet", "quantity": 1, "description": "Samsung phablet" }, { "id": "model~tabletSupportServices~recommendedModelTabletSupportServices", "selected": "true", "modelName": "Tablet Support Services", "comment": "System recommended item", "price": { "value": "200", "currency": "USD" }, "modelVariableName": "tabletSupportServices", "quantity": 1, "description": "Tablet Support Services" } ] }
|
Description |
This action retrieves the recommended parts of the configuration. This action does not run recommended items rules. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/}/_recmdParts/actions/getRecmdParts |
|
|
Endpoint Parameters
|
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
modelVarName |
The variable name of a Model |
|
|
HTTP Method |
POST |
|
|
Request Body Parameters |
cacheInstanceId |
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.(Required) |
|
Response Body Parameters |
cacheInstanceId |
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 |
A top-level object in the payload containing the array definitions for the recommended parts within the configuration. |
|
https://sitename.oracle.com/rest/v17/configvarioTablets.tablets.customTablet/_recmdParts/actions/getRecmdParts
{ "cacheInstanceId": "gsg21bMZ5kpGUWxDIZeGWQCLKbaad33Un1X8huVuDm0K3gAKMeXPbzeQcFsFBAzJ" }
{ "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": "" } ] }
In v8 when the attribute Auto Lock property is enabled, support for the user to set the lock value to true or false in the Configuration Run-Time Data REST API is available, as follows:
- The locked property is provided in the response or is read from the request based on the Set Type property defined at attribute/layout level. Set Type should be "Set".
- When an attribute Auto Lock is set to on via the Attribute Definition page or layout setting and the user does not pass any value for the lock property in the request, then the lock value is set to true.
- When Auto Lock is set to off via the Attribute Definition page or layout setting, then the user must pass the lock value as true explicitly to honor this value over the recommendation rule value.
- If there is no Set Type and Auto Lock defined at the attribute/layout-level and a recommendation rule is acting on an attribute, then Auto Lock is implicitly turned on internally and the lock is set to true.
For more information, refer to Recommendation Rules - Auto Lock.
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/actions/_interact
{ "cacheInstanceId": "WNVD55lJoYR7Q3QQTGqcw0KiK2iM19fmSCRrRkXG4lOKjwDKD3MLLOFdrn61eOhu", "configData": { "operatingSystem": { "value": "Ubuntu Server Edition", "displayValue": "Ubuntu Server Edition" }, "serverPerformance": { "value": "Mid Range", "displayValue": "Mid Range" }, "textFieldSetTypeAutolockAttribute": { "value": "user value", "locked": "false" } }, "criteria": { "state": true, "fields": ["supportLevel", "powerSupply"], "childDefs": [{ "name": "_priceInfo" }, { "name": "_recmdModels" }, { "name": "_mandatoryModels" }, { "name": "_recmdParts" }, { "name": "_mandatoryParts" }, { "name": "_bom" } ] } }
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/_setapplicationSoftware/actions/_loadData
{ "cacheInstanceId": "ZGQn3ciig5QBSvvvzZnin1IpAEUyC0wTv22guTBLnzGWnjgG6ekKPa7JvNrQubs3", "criteria": { "state": true, "fields": ["arrayTextField1"] } }
{ "_state": { "insertable": true, "sortable": false, "deletable": true, "defaultRowState": { "updatable": true, "hasError": false, "messages": [], "attributes": { "arrayTextField1": { "updatable": true, "hasError": false, "hasWarning": false, "messages": [], "visible": true, "hasConstraintViolation": false } } }, "actions": { "_delete": { "enabled": true, "visible": true }, "_add": { "enabled": true, "visible": true } }, "attributes": { "arrayTextField1": { "visible": true } } }, "items": [{ "index": 0, "_rowKey": "6d5eb9ef-393c-43aa-9528-925489f8767d", "arrayTextField1": "test0", "_state": { "hasError": false, "messages": [] } }, { "index": 1, "_rowKey": "d8da0d00-92d3-48bb-af02-1bf72c80fd81", "arrayTextField1": "", "_state": { "hasError": false, "messages": [] } }, { "index": 2, "_rowKey": "bb3102d3-a83e-47ef-a38d-0abe9f31508e", "arrayTextField1": "", "_state": { "hasError": false, "messages": [] } } ], "cacheInstanceId": "ZGQn3ciig5QBSvvvzZnin1IpAEUyC0wTv22guTBLnzGWnjgG6ekKPa7JvNrQubs3" }
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/actions/_loadData
{ "cacheInstanceId": "TyorT0UiW6H2ahn6Io2hm44KpkPZmpcwBgs8P7csERyRfXTpOWyOaOVpnv7XZvTH", "criteria": { "state": true, "childDefs": [{ "name": "_setNormalArray" }, { "name": "_setSSPLArray" } ] } }
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/actions/_next
{
"cacheInstanceId": "TyorT0UiW6H2ahn6Io2hm44KpkPZmpcwBgs8P7csERyRfXTpOWyOaOVpnv7XZvTH",
"criteria": {
"state": true,
"childDefs": [{
"name": "_priceInfo"
}, {
"name": "_recmdModels"
}, {
"name": "_mandatoryModels"
}, {
"name": "_recmdParts"
}, {
"name": "_mandatoryParts"
}, {
"name": "_bom"
}
]
},
"delta": true
}
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/actions/_previous
{
"cacheInstanceId": "DJy4zFjQqMgkfCXYAD9OgKf3Teyqcnvi3QtQ1nJICFjs2MsvNWecrsHJYw7sLKul",
"configData": {
"operatingSystem": {
"value": "Ubuntu Server Edition",
"displayValue": "Ubuntu Server Edition"
},
"serverPerformance": {
"value": "Mid Range",
"displayValue": "Mid Range"
}
},
"criteria": {
"state": true,
"fields": ["supportLevel", "powerSupply"],
"childDefs": [{
"name": "_priceInfo"
}, {
"name": "_recmdModels"
}, {
"name": "_mandatoryModels"
}, {
"name": "_recmdParts"
}, {
"name": "_mandatoryParts"
}, {
"name": "_bom"
}
]
}
}
URI Endpoint Sample to allow the user to add a Model to the Transaction. This creates a new Transaction if one does not exist.
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/actions/_cm_36292358
{ "cacheInstanceId": "OpAJgNZlA2jzhI8YWDwpQ2OQxh0RiudBrSyIVUaL2v5Xz9GkXGMUwKaR0U5ePyOB", "configData": { "serverPerformance": { "value": "Mid Range", "displayValue": "Mid Range" } } }
{ "destinationUrl": "https://sitename.oracle.com/commerce/buyside/document.jsp", "bsId": 36701659, "processId": 36244034, "processVarName": "oraclecpqo" }
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/actions/_reconfigureFav
{ "cacheInstanceId": "TyorT0UiW6H2ahn6Io2hm44KpkPZmpcwBgs8P7csERyRfXTpOWyOaOVpnv7XZvTH", "criteria": { "state": true, "childDefs": [{ "name": "_priceInfo" }, { "name": "_recmdModels" }, { "name": "_mandatoryModels" }, { "name": "_recmdParts" }, { "name": "_mandatoryParts" }, { "name": "_bom" } ] }, "FavoriteId": 21734357 }
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/actions/_reconfigureTxn
{ "bsId": 38458354, "documentNumber": 2, "documentId": 18319026, "criteria": { "state": true, "childDefs": [{ "name": "_priceInfo" }, { "name": "_recmdModels" }, { "name": "_mandatoryModels" }, { "name": "_recmdParts" }, { "name": "_mandatoryParts" }, { "name": "_bom" } ] } }
{ "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/v17/productFamilies/vision/productLines/servers/layouts/serverSolutionsProduct" } ] } }
Reconfigure a Model Line from Transaction
https://sitename.oracle.com/rest/v17/commerceDocumentsOraclecpqoTransaction/38458354/actions/_reconfigure_action
{ "documents": { "Quote Name": "Pinnacle Technologies" }, "selections": ["transactionLine/2"] }
{ "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
https://sitename.oracle.com/rest/v17/commerceDocumentsOraclecpqoTransaction/38458354/transactionLine/2/actions/_reconfigure_action
{ "documents": { "Quote Name": "Pinnacle Technologies" } }
{ "revisionId": "4,0", "documents": { "_id": 38458354, "transactionLine": { "items": [{ "_document_number": 2 } ] }, "links": [{ "rel": "self", "href": "https://sitename.com/rest/v17/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" }
For Asset-Based Ordering, the Reconfigure Model action is used when reconfiguring an asset for internal applications.
- Beginning in 19C, the Reconfigure Model REST API accepts the "configContextKey" request body parameter.
- For asset reconfiguration the "configContextKey" parameter is retrieved from the Reconfigure Asset response.
-
For external asset flows, the Reconfigure Model from Partner REST API provides support for ABO flows when using the JET Configuration UI.
Reconfigure Model Request Body Sample (Internal Asset Modification Flow)
{ "configContextKey":"75366ffb-fff2-4176-b697-75cd8310f7a4", "bsId":21593819, "documentId":18351533, "documentNumber": 4 }
For additional information refer to Asset-Based Ordering.
Reconfigure Model from Partner
https://sitename.oracle.com/rest/v17/configlaptop.laptopConfiguration.sku50001/actions/_reconfigureClient
{ "configId": 21736276 }
{ "cacheInstanceId": "Qaqq65ERxw1IJlvWZy1iDfk4O615zaQ8KeRyuhClsOiTGLkCmAodXBXL9ufY4bEs", "configData": { "includeBOM": true, "processor": { "value": "sku40002", "displayValue": "Intel Pentium i3" }, "memory_HardDisk": { "value": "sku40008", "displayValue": "500GB" }, "addBOMChild": false, "addBOMGrandchild": false, "bOMHelp": "The selections on the left determine whether certain BOM items will be added as part of the product:<br /><br /><ul><li><strong>includeBOM</strong>: If false, the product will have no BOM items at all.</li><li><strong>Add BOM Child</strong>: If false, removes "part2" and all of its children (regardless of their individual settings).</li><li><strong>Add BOM Grandchild:</strong> If false, removes "part22" and all of its children.</li><li><strong>Add BOM Great Grandchild:</strong> If false, removes "part222".</li><li><strong>Add Skus:</strong> If false, removes sku240202 and sku240203</li></ul>", "memory_RAM": { "value": "sku40007", "displayValue": "8 GB Kingston Sodimm DDR3 1600MHz" }, "graphicsCard": { "value": "sku40011", "displayValue": "Intel HD Graphics Media Accelerator 4600" }, "links": [{ "rel": "child", "href": "https://sitename.us.oracle.com/rest/v17/configlaptop.laptopConfiguration.sku50001/_bom" }, { "rel": "child", "href": "https://sitename.us.oracle.com/rest/v17/configlaptop.laptopConfiguration.sku50001/_recmdModels" }, { "rel": "child", "href": "https://sitename.us.oracle.com/rest/v17/configlaptop.laptopConfiguration.sku50001/_mandatoryModels" }, { "rel": "child", "href": "https://sitename.us.oracle.com/rest/v17/configlaptop.laptopConfiguration.sku50001/_recmdParts" }, { "rel": "child", "href": "https://sitename.us.oracle.com/rest/v17/configlaptop.laptopConfiguration.sku50001/_mandatoryParts" }, { "rel": "child", "href": "https://sitename.us.oracle.com/rest/v17/configlaptop.laptopConfiguration.sku50001/_pickLists" } ], "addBOMGreatGrandchild": false, "currencyCode": "", "_isMainModelSelected": true, "addSkus": false } }
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/actions/_resumeConfig
{ "draftId": 36701771, "criteria": { "fields": ["supportLevel", "powerSupply"], "childDefs": [{ "name": "_priceInfo" }, { "name": "_recmdModels" }, { "name": "_mandatoryModels" }, { "name": "_recmdParts" }, { "name": "_mandatoryParts" }, { "name": "_bom" } ] } }
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/actions/_save
{ "cacheInstanceId": "ojYqVKeaW6Vr1EGoV9wa0mFn1iohE6Azc5gExHJzFkySLvKLqTxBUzIW7uNiT4cb", "configData": { "serverPerformance": { "value": "Mid Range", "displayValue": "Mid Range" } } }
{ "destinationUrl": "https://sitename.oracle.com/commerce/buyside/document.jsp", "bsId": 21221021, "processVarName": "oraclecpqo", "processId": 36244034, "documentId": 4356122 }
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/actions/_startOver
{ "cacheInstanceId": "agu0yDbIYDBmKcRuVqkyw6K8ALcd5bax95BFBTqFQITChTpjEqeZyQUknHMuLDfW" }
{ "destinationUrl": "https://sitename.oracle.com/commerce/display_company_profile.jsp" }
Within the Configuration Run-Time Data REST API, users can select/deselect the recommended parts/models of a Configuration. In v7, only individual item selection is supported.
Beginning in v8, a "selectAll" (boolean) property is introduced for _recmdParts and _recmdModels resource to select/deselect the items at the same time. This minimizes the number of requests and size of the payload for all endpoints which allow/accept the selection of the _recmdParts and _recmdModels.
The following criteria applies:
- If the user enters "selectAll" as true and few individual items selection as false in the API request body, the system sets selection as false for the individual items and true for rest of the items.
- If user enters "selectAll" as false and few individual items selection as true in the API request body, the system sets selection as true for the individual items and false for rest of the items.
- If user enters only "selectAll" value (and no individual items selection) in the API request body , the system considers "selectAll" value is applied to all the items.
In v8 when the attribute Auto Lock property is enabled, support for the user to set the lock value to true or false in the Configuration Run-Time Data REST API is available, as follows:
- The locked property is provided in the response or is read from the request based on the Set Type property defined at attribute/layout level. Set Type should be "Set".
- When an attribute Auto Lock is set to on via the Attribute Definition page or layout setting and the user does not pass any value for the lock property in the request, then the lock value is set to true.
- When Auto Lock is set to off via the Attribute Definition page or layout setting, then the user must pass the lock value as true explicitly to honor this value over the recommendation rule value.
- If there is no Set Type and Auto Lock defined at the attribute/layout-level and a recommendation rule is acting on an attribute, then Auto Lock is implicitly turned on internally and the lock is set to true.
For more information, refer to Recommendation Rules - Auto Lock.
https://sitename.oracle.com/rest/v17/configvision.servers.ultraPowerSolutionPackage/actions/_update
{ "cacheInstanceId": "lrtYGUDQ0bfcH8n49b0lrhtP0yOQm1YQBhzFIt5AxE98LystQC3UOfkbMJ1DHyiK", "configData": { "operatingSystem": { "value": "Ubuntu Server Edition", "displayValue": "Ubuntu Server Edition" }, "serverPerformance": { "value": "Mid Range", "displayValue": "Mid Range" } }, "criteria": { "fields": ["supportLevel", "powerSupply"], "childDefs": [{ "name": "_priceInfo" }, { "name": "_recmdModels" }, { "name": "_mandatoryModels" }, { "name": "_recmdParts" }, { "name": "_mandatoryParts" }, { "name": "_bom" } ] } }
Additional Support Information
System configurations have a system navigation panel that contains model and part icons to show the hierarchy of a system and status icons to identify models requiring user action.
System Navigation Status Object
The information for the system navigation panel is stored within the "_sysNavigationInfo" resource in the Configuration Run-Time Data REST APIs. Oracle CPQ 19C adds a new "_status" object within the "_sysNavigationInfo" resource. The "_status" object is a set of Boolean objects that give all the possible states of configuration for the items in the system.
The following table lists the items within the "_status" object.
|
Name |
Title |
Description |
|---|---|---|
|
hasWarning |
Warning |
The model configuration contains items that should be reviewed. |
|
hasConstraintViolation |
Constraint Violation |
The model configuration has a constraint violation. |
|
hasMissingMandatory |
Missing Mandatory |
The model configuration is missing mandatory items. |
|
hasEmptyRequiredAttribute |
Empty Required Attribute |
The model configuration has empty required attributes. |
|
hasError |
Error |
The model configuration has constrained values, missing mandatory items, or empty required attributes. |
|
hasFailedBomReverseMapping |
Failed BOM Reverse Mapping |
The model configuration failed BOM reverse mapping |
|
hasRecommendedItemChanged |
Recommended Item Changed |
The recommended items list changed on invocation. |
|
hasStarted |
Started |
The model configuration is configured. |
|
isIncomplete |
Incomplete |
The model configuration has multiple nodes and the configuration hasn't progressed to the end node |
|
isInvalid |
Invalid |
The model configuration is invalid. This could be the result of invalid BOM Mapping rules or a missing configuration flow. |
{ "_sysNavigationInfo": { "items": [{ "items": [{ "items": [], "name": "Nested Hierarchies", "path": "_root$%#%$testbed:systemConfiguration:nestedHierarchies%$#$%0%$#$%0", "isActive": false, "isModel": true, "productLine": "testbed", "productFamily": "systemConfiguration", "model": "nestedHierarchies", "title": "", "_status": { "hasWarning": false, "hasConstraintViolation": false, "hasMissingMandatoryItem": true, "hasError": true, "hasFailedBomReverseMappings": false, "hasEmptyRequiredAttributes": false, "hasRecommendedItemChanged": false, "isInvalid": false, "isIncomplete": false, "hasStarted": false } }], "name": "Root System", "path": "_root", "isActive": false, "isModel": true, "productLine": "testbed", "productFamily": "systemConfiguration", "model": "nestedHierarchies", "title": "", "_status": { "hasWarning": false, "hasConstraintViolation": false, "hasMissingMandatoryItem": false, "hasError": false, "hasFailedBomReverseMappings": false, "hasEmptyRequiredAttributes": false, "hasRecommendedItemChanged": false, "isInvalid": false, "isIncomplete": false, "hasStarted": false } } ] } }
For additional information refer to System Configuration.
Notes
Configuration Run-Time Data APIs are not exposed inside Oracle CPQ REST Adapter in OIC/ICS.
Additionally, complete parity with the Legacy UI is not fully achieved yet. This will be addressed in the next few releases. Configuration REST APIs for the following features are not available:
- Guided Selling/Search flow scenarios
- Pipeline Viewer
- Attribute calculators
