1. REST API Services for CPQ Cloud
  2. Tasks
  3. Configuration Run-Time Data Services

Add From Catalog

post

/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_addFromCatalog

The action is used for processing Model configuration and must be used in conjunction with the Add from Catalog API of Commerce Transaction or Transaction line.

Request

Supported Media Types
Body ()
Root Schema : prodFamVarName.prodLineVarName.modelVarName-_addFromCatalogRequest
Type: object
Show Source
Nested Schema : prodFamVarName.prodLineVarName.modelVarName
Type: object
Show Source
Nested Schema : Query Definition
Type: object
Title: Query Definition
Captures the query definition for the current resource request.
Show Source
Nested Schema : BOM Items
Type: object
Title: BOM Items
BOM items of the configuration.
Show Source
Nested Schema : Mandatory Models
Type: object
Title: Mandatory Models
Mandatory models of the configuration.
Show Source
Nested Schema : Mandatory Parts
Type: object
Title: Mandatory Parts
Mandatory parts of the configuration.
Show Source
Nested Schema : Price Information
Type: object
Title: Price Information
Price Information.
Show Source
Nested Schema : Recommended Models
Type: object
Title: Recommended Models
Recommended models of the configuration.
Show Source
Nested Schema : Recommended Parts
Type: object
Title: Recommended Parts
Recommended parts of the configuration.
Show Source
Nested Schema : applicationSoftwareCounter array key
Type: object
Title: applicationSoftwareCounter array key
applicationSoftwareCounter array key
Show Source
Nested Schema : pickListVarNameSET
Type: object
Title: pickListVarNameSET
Show Source
Nested Schema : state
Type: object
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.
Show Source
  • 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
    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.
  • Title: Deletable
    Boolean value that specifies whether the row can be deleted.
  • 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.
  • Title: Has Error
    Boolean value that specifies whether any error that occurred has been assigned to the row itself.
  • Title: Has Warning
    Boolean value that specifies whether any warning that was issued has been assigned to the row itself.
  • Title: Hidden
    Boolean value that specifies whether the row can be hidden.
  • Messages
    Title: Messages
    Array of messages that have been generated for a specific object.
  • Title: Updatable
    Boolean value that specifies whether the row can be updated.
Nested Schema : Cloud Service
Type: object
Title: Cloud Service
Metered Storage will allow you to exceed your drive size but with additional fees.
Show Source
Nested Schema : Cloud Storage
Type: object
Title: Cloud Storage
There needs to be something here about metered and fixed pricing
Show Source
Nested Schema : Do you have storage appliances that need to be accessible to multiple employees?
Type: object
Title: Do you have storage appliances that need to be accessible to multiple employees?
Show Source
Nested Schema : Form Factor
Type: object
Title: Form Factor
Show Source
Nested Schema : Hard Drive
Type: object
Title: Hard Drive
Show Source
Nested Schema : How many employees does your company have?
Type: object
Title: How many employees does your company have?
Show Source
Nested Schema : How much data do you currently manage and store?
Type: object
Title: How much data do you currently manage and store?
Show Source
Nested Schema : I want to be able to
Type: object
Title: I want to be able to
Show Source
Nested Schema : Monitoring
Type: object
Title: Monitoring
Show Source
Nested Schema : Number of Processors
Type: object
Title: Number of Processors
Show Source
Nested Schema : Operating System
Type: object
Title: Operating System
Show Source
Nested Schema : Operating System
Type: object
Title: Operating System
Show Source
Nested Schema : Optical Drive
Type: object
Title: Optical Drive
Show Source
Nested Schema : Packaged Solutions
Type: object
Title: Packaged Solutions
Show Source
Nested Schema : Power Supply
Type: object
Title: Power Supply
Show Source
Nested Schema : Processor
Type: object
Title: Processor
Show Source
Nested Schema : Processor
Type: object
Title: Processor
Show Source
Nested Schema : Server Rack
Type: object
Title: Server Rack
Show Source
Nested Schema : RAM
Type: object
Title: RAM
Show Source
Nested Schema : RAM Configuration
Type: object
Title: RAM Configuration
Show Source
Nested Schema : Server Module
Type: object
Title: Server Module
Show Source
Nested Schema : System
Type: object
Title: System
Show Source
Nested Schema : Tier
Type: object
Title: Tier
Show Source
Nested Schema : Servers
Type: object
Title: Servers
Show Source
Nested Schema : Services Requested
Type: object
Title: Services Requested
Show Source
Nested Schema : Support Level
Type: object
Title: Support Level
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : part
Type: object
Show Source
Nested Schema : Price
Type: object
Title: Price
Price
Show Source
Nested Schema : Price Period
Type: object
Title: Price Period
Show Source
Nested Schema : Price Type
Type: object
Title: Price Type
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : model
Type: object
Show Source
Nested Schema : Price
Type: object
Title: Price
Model's price.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : priceInfoItem
Type: object
Show Source
Nested Schema : _avp
Type: array
Show Source
Nested Schema : _otherPrices
Type: array
Show Source
Nested Schema : _priceRules
Type: array
Show Source
Nested Schema : priceInfoCategory
Type: object
Show Source
Nested Schema : avpPriceModel
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : avpPriceItem
Type: object
Show Source
Nested Schema : Price Model
Type: object
Title: Price Model
Price Model
Show Source
Nested Schema : priceItem
Type: object
Show Source
Nested Schema : Price Model
Type: object
Title: Price Model
Price Model
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : pickListVarName
Type: object
Title: pickListVarName
Show Source
Nested Schema : Actions
Type: object
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.
Nested Schema : Attributes
Type: object
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.
Nested Schema : Groups
Type: object
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.
Nested Schema : Messages
Type: array
Title: Messages
Array of messages that have been generated for a specific object.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : actions
Type: array
Array of actions names, whose state is requested in the state object response.
Show Source
Nested Schema : childDefs
Type: array
Show Source
Nested Schema : excludeFieldTypes
Type: array
Array of field names that you want to exclude in the response.
Show Source
Nested Schema : expand
Type: array
Array of child resource names that you want to expand so that the contents return with the parent in the same request.
Show Source
Nested Schema : expandedDomains
Type: array
Array of field names, whose expanded domains are requested in the state object response.
Show Source
Nested Schema : fields
Type: array
Array of field names that you wanted returned in a request.
Show Source
Nested Schema : groups
Type: array
Array of group names, whose state is requested in the state object response.
Show Source
Nested Schema : nodesExceptionList
Type: array
Array of document_number, recording the nodes that violate current expandNodes flag
Show Source
Nested Schema : orderBy
Type: array
Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
Show Source
Nested Schema : Child query criteria.
Type: object
Title: Child query criteria.
Captures the query criteria for the child resource.
Show Source
Back to Top

Response

Supported Media Types

Default Response

Body ()
Root Schema : prodFamVarName.prodLineVarName.modelVarName-_addFromCatalogResponse
Type: object
Show Source
Nested Schema : prodFamVarName.prodLineVarName.modelVarName
Type: object
Show Source
Nested Schema : BOM Items
Type: object
Title: BOM Items
BOM items of the configuration.
Show Source
Nested Schema : Mandatory Models
Type: object
Title: Mandatory Models
Mandatory models of the configuration.
Show Source
Nested Schema : Mandatory Parts
Type: object
Title: Mandatory Parts
Mandatory parts of the configuration.
Show Source
Nested Schema : Price Information
Type: object
Title: Price Information
Price Information.
Show Source
Nested Schema : Recommended Models
Type: object
Title: Recommended Models
Recommended models of the configuration.
Show Source
Nested Schema : Recommended Parts
Type: object
Title: Recommended Parts
Recommended parts of the configuration.
Show Source
Nested Schema : applicationSoftwareCounter array key
Type: object
Title: applicationSoftwareCounter array key
applicationSoftwareCounter array key
Show Source
Nested Schema : pickListVarNameSET
Type: object
Title: pickListVarNameSET
Show Source
Nested Schema : state
Type: object
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.
Show Source
  • 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
    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.
  • Title: Deletable
    Boolean value that specifies whether the row can be deleted.
  • 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.
  • Title: Has Error
    Boolean value that specifies whether any error that occurred has been assigned to the row itself.
  • Title: Has Warning
    Boolean value that specifies whether any warning that was issued has been assigned to the row itself.
  • Title: Hidden
    Boolean value that specifies whether the row can be hidden.
  • Messages
    Title: Messages
    Array of messages that have been generated for a specific object.
  • Title: Updatable
    Boolean value that specifies whether the row can be updated.
Nested Schema : Cloud Service
Type: object
Title: Cloud Service
Metered Storage will allow you to exceed your drive size but with additional fees.
Show Source
Nested Schema : Cloud Storage
Type: object
Title: Cloud Storage
There needs to be something here about metered and fixed pricing
Show Source
Nested Schema : Do you have storage appliances that need to be accessible to multiple employees?
Type: object
Title: Do you have storage appliances that need to be accessible to multiple employees?
Show Source
Nested Schema : Form Factor
Type: object
Title: Form Factor
Show Source
Nested Schema : Hard Drive
Type: object
Title: Hard Drive
Show Source
Nested Schema : How many employees does your company have?
Type: object
Title: How many employees does your company have?
Show Source
Nested Schema : How much data do you currently manage and store?
Type: object
Title: How much data do you currently manage and store?
Show Source
Nested Schema : I want to be able to
Type: object
Title: I want to be able to
Show Source
Nested Schema : Monitoring
Type: object
Title: Monitoring
Show Source
Nested Schema : Number of Processors
Type: object
Title: Number of Processors
Show Source
Nested Schema : Operating System
Type: object
Title: Operating System
Show Source
Nested Schema : Operating System
Type: object
Title: Operating System
Show Source
Nested Schema : Optical Drive
Type: object
Title: Optical Drive
Show Source
Nested Schema : Packaged Solutions
Type: object
Title: Packaged Solutions
Show Source
Nested Schema : Power Supply
Type: object
Title: Power Supply
Show Source
Nested Schema : Processor
Type: object
Title: Processor
Show Source
Nested Schema : Processor
Type: object
Title: Processor
Show Source
Nested Schema : Server Rack
Type: object
Title: Server Rack
Show Source
Nested Schema : RAM
Type: object
Title: RAM
Show Source
Nested Schema : RAM Configuration
Type: object
Title: RAM Configuration
Show Source
Nested Schema : Server Module
Type: object
Title: Server Module
Show Source
Nested Schema : System
Type: object
Title: System
Show Source
Nested Schema : Tier
Type: object
Title: Tier
Show Source
Nested Schema : Servers
Type: object
Title: Servers
Show Source
Nested Schema : Services Requested
Type: object
Title: Services Requested
Show Source
Nested Schema : Support Level
Type: object
Title: Support Level
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : part
Type: object
Show Source
Nested Schema : Price
Type: object
Title: Price
Price
Show Source
Nested Schema : Price Period
Type: object
Title: Price Period
Show Source
Nested Schema : Price Type
Type: object
Title: Price Type
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : model
Type: object
Show Source
Nested Schema : Price
Type: object
Title: Price
Model's price.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : priceInfoItem
Type: object
Show Source
Nested Schema : _avp
Type: array
Show Source
Nested Schema : _otherPrices
Type: array
Show Source
Nested Schema : _priceRules
Type: array
Show Source
Nested Schema : priceInfoCategory
Type: object
Show Source
Nested Schema : avpPriceModel
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : avpPriceItem
Type: object
Show Source
Nested Schema : Price Model
Type: object
Title: Price Model
Price Model
Show Source
Nested Schema : priceItem
Type: object
Show Source
Nested Schema : Price Model
Type: object
Title: Price Model
Price Model
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : pickListVarName
Type: object
Title: pickListVarName
Show Source
Nested Schema : Actions
Type: object
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.
Nested Schema : Attributes
Type: object
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.
Nested Schema : Groups
Type: object
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.
Nested Schema : Messages
Type: array
Title: Messages
Array of messages that have been generated for a specific object.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Examples

The following example shows how to process Model configuration and is used in conjunction with the Add from Catalog API of Commerce Transaction or Transaction line by submitting a POST request to the REST resource using cURL. 

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v7/configvision.servers.ultraPowerSolutionPackage/actions/_addFromCatalog

Request Body Sample

{
  "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"
      }
    ]
  }
}

Response Body Sample

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

{
  "bsId": 21223994,
  "documentId": 18319026,
  "cacheInstanceId": "DJy4zFjQqMgkfCXYAD9OgKf3Teyqcnvi3QtQ1nJICFjs2MsvNWecrsHJYw7sLKul",
  "configData": {
    "_state": {
      "updatable": true,
      "hasError": false,
      "hasWarning": false,
      "messages": [],
      "actions": {
        "_startOver": {
          "enabled": true,
          "visible": true
        },
        "_cancel": {
          "enabled": true,
          "visible": false
        },
        "_addToTxn": {
          "enabled": true,
          "visible": false
        },
        "_cm_36292358": {
          "enabled": true,
          "visible": false
        },
        "_update": {
          "enabled": true,
          "visible": true
        },
        "_save": {
          "enabled": true,
          "visible": false
        },
        "_next": {
          "enabled": true,
          "visible": false
        },
        "_previous": {
          "enabled": true,
          "visible": false
        }
      },
      "attributes": {
        "supportLevel": {
          "updatable": true,
          "hasError": true,
          "hasWarning": false,
          "messages": ["Open Source Operating System Requires Titanium Support"],
          "visible": true,
          "hasConstraintViolation": true,
          "domain": {
            "constraintType": "DISALLOWED",
            "constraintList": ["Vision Gold", "Vision Platinum"],
            "domainRestricted": true,
            "availableElements": [{
                "value": "Vision Gold",
                "displayValue": "Vision Gold"
              }, {
                "value": "Vision Platinum",
                "displayValue": "Vision Platinum"
              }, {
                "value": "Vision Titanium",
                "displayValue": "Vision Titanium"
              }
            ]
          }
        },
        "powerSupply": {
          "updatable": true,
          "hasError": false,
          "hasWarning": true,
          "messages": ["750W PSU: Recommended for Optimal Performance"],
          "visible": true,
          "hasConstraintViolation": false,
          "domain": {
            "constraintType": "DISALLOWED",
            "constraintList": [],
            "domainRestricted": true,
            "availableElements": [{
                "value": "250W PSU",
                "displayValue": "250W PSU"
              }, {
                "value": "400W PSU",
                "displayValue": "400W PSU"
              }, {
                "value": "500W PSU",
                "displayValue": "500W PSU"
              }, {
                "value": "600W PSU",
                "displayValue": "600W PSU"
              }, {
                "value": "750W PSU",
                "displayValue": "750W PSU"
              }, {
                "value": "800W PSU",
                "displayValue": "800W PSU"
              }, {
                "value": "1000W PSU",
                "displayValue": "1000W PSU"
              }
            ]
          },
          "required": true
        }
      }
    },
    "_recmdModels": {},
    "links": [{
        "rel": "child",
        "href": "https://sitename.oracle.com/rest/v7/configvision.servers.ultraPowerSolutionPackage/_bom"
      }, {
        "rel": "child",
        "href": "https://sitename.oracle.com/rest/v7/configvision.servers.ultraPowerSolutionPackage/_recmdModels"
      }, {
        "rel": "child",
        "href": "https://sitename.oracle.com/rest/v7/configvision.servers.ultraPowerSolutionPackage/_mandatoryModels"
      }, {
        "rel": "child",
        "href": "https://sitename.oracle.com/rest/v7/configvision.servers.ultraPowerSolutionPackage/_recmdParts"
      }, {
        "rel": "child",
        "href": "https://sitename.oracle.com/rest/v7/configvision.servers.ultraPowerSolutionPackage/_mandatoryParts"
      }, {
        "rel": "child",
        "href": "https://sitename.oracle.com/rest/v7/configvision.servers.ultraPowerSolutionPackage/_pickLists"
      }, {
        "rel": "child",
        "href": "https://sitename.oracle.com/rest/v7/configvision.servers.ultraPowerSolutionPackage/arraySet/applicationSoftware"
      }, {
        "rel": "child",
        "href": "https://sitename.oracle.com/rest/v7/configvision.servers.ultraPowerSolutionPackage/arraySet/serviceDetails"
      }, {
        "rel": "child",
        "href": "https://sitename.oracle.com/rest/v7/configvision.servers.ultraPowerSolutionPackage/arraySet/advancedServerConfiguration"
      }
    ],
    "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": {}
  }
}
Back to Top