Interact
post
/rest/v19/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/actions/_interact
This action modifies configurable attribute values and triggers only ajax-based configuration rules, such as hiding and constraint rules, on the latest configuration data from the configuration cache. This action saves the configuration to the pending configuration list.
Request
Supported Media Types
- application/json
Path Parameters
-
modelVarName(required): string
The variable name of a Model
-
prodFamVarName(required): string
The variable name of a Product Family
-
prodLineVarName(required): string
The variable name of a Product Line
Root Schema : interactRequest
Type:
Show Source
object
-
cacheInstanceId(required):
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
-
criteria:
object Query Definition
Title:
Query Definition
Captures the query definition for the current resource request. -
delta:
boolean
Title:
Delta
Delta
Nested Schema : configData
Type:
Show Source
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
Nested Schema : Query Definition
Type:
object
Title:
Query Definition
Captures the query definition for the current resource request.
Show Source
-
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.
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 : Pick List
Type:
object
Title:
Show Source
Pick List
-
items:
array items
-
variableName:
string
Title:
Variable Name
It uniquely identifies the pick list.
Nested Schema : Price Information
Type:
object
Title:
Price Information
Price Information.
Show Source
-
items:
array items
-
name:
string
Title:
Display Name
Display Name
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 : Array Set Name
Type:
object
Title:
Show Source
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.
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:
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.
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
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Cloud Storage
Type:
object
Title:
Cloud Storage
There needs to be something here about metered and fixed pricing
Show Source
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Do you have storage appliances that need to be accessible to multiple employees?
Type:
object
Title:
Show Source
Do you have storage appliances that need to be accessible to multiple employees?
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Form Factor
Type:
object
Title:
Show Source
Form Factor
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Hard Drive
Type:
object
Title:
Show Source
Hard Drive
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : How many employees does your company have?
Type:
object
Title:
Show Source
How many employees does your company have?
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : How much data do you currently manage and store?
Type:
object
Title:
Show Source
How much data do you currently manage and store?
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Number of Processors
Type:
object
Title:
Show Source
Number of Processors
-
displayValue:
string
Title:
Display Value
-
value:
integer
Title:
Value
Nested Schema : Operating System
Type:
object
Title:
Show Source
Operating System
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Operating System
Type:
object
Title:
Show Source
Operating System
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Optical Drive
Type:
object
Title:
Show Source
Optical Drive
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Packaged Solutions
Type:
object
Title:
Show Source
Packaged Solutions
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Power Supply
Type:
object
Title:
Show Source
Power Supply
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Processor
Type:
object
Title:
Show Source
Processor
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Processor
Type:
object
Title:
Show Source
Processor
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Server Rack
Type:
object
Title:
Show Source
Server Rack
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : RAM
Type:
object
Title:
Show Source
RAM
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : RAM Configuration
Type:
object
Title:
Show Source
RAM Configuration
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Server Module
Type:
object
Title:
Show Source
Server Module
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : System
Type:
object
Title:
Show Source
System
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Tier
Type:
object
Title:
Show Source
Tier
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Servers
Type:
object
Title:
Show Source
Servers
-
displayValue:
string
Title:
Display Value
-
value:
integer
Title:
Value
Nested Schema : Support Level
Type:
object
Title:
Show Source
Support Level
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : part
Type:
Show Source
object
-
_part_custom_field1:
string
Title:
Product Group
-
_part_custom_field10:
object Product type
Title:
Product type
-
_part_custom_field3:
string
Title:
Max discount %
-
_part_custom_field4:
object Price Period
Title:
Price Period
-
_part_custom_field5:
number
Title:
Cost
-
_part_custom_field8:
object Price Type
Title:
Price Type
-
_part_custom_field9:
string
Title:
product
-
comment:
string
Title:
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
Nested Schema : Product type
Type:
object
Title:
Show Source
Product type
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Price Period
Type:
object
Title:
Show Source
Price Period
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Price Type
Type:
object
Title:
Show Source
Price Type
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : model
Type:
Show Source
object
-
_bm_model_description:
string
Title:
Product Model 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
Nested Schema : Custom Properties
Type:
object
Title:
Custom Properties
Custom properties of the product model.
Show Source
Nested Schema : links
Type:
Show Source
array
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : reference links
Type:
object
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Show Source
-
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
Nested Schema : items
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : priceInfoCategory
Type:
Show Source
object
-
code:
string
Title:
Category Code
-
displayName:
string
Title:
Display Name
Display Name
Nested Schema : avpPriceModel
Type:
Show Source
object
-
items:
array items
-
value:
string
Title:
Value
-
variableName:
string
Title:
Variable Name
Nested Schema : avpPriceItem
Type:
Show Source
object
-
price:
object Price Model
Title:
Price Model
Price Model -
value:
string
Title:
Value
Nested Schema : priceItem
Type:
Show Source
object
-
price:
object Price Model
Title:
Price Model
Price Model -
value:
string
Title:
Value
-
variableName:
string
Title:
Variable Name
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 : Focused Users
Type:
object
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.
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
-
Array of:
string
An error, warning, or informational message.
Nested Schema : items
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : items
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : items
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : actions
Type:
array
Array of actions names, whose state is requested in the state object response.
Show Source
Nested Schema : childDefs
Type:
Show Source
array
-
Array of:
object Child query criteria.
Title:
Child query criteria.
Captures the query criteria for the child resource.
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 : expandedDomainCriteria
Type:
array
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.
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
-
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
Supported Media Types
- application/json
Default Response
Root Schema : interactResponse
Type:
Show Source
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.
Nested Schema : configData
Type:
Show Source
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
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 : Pick List
Type:
object
Title:
Show Source
Pick List
-
items:
array items
-
variableName:
string
Title:
Variable Name
It uniquely identifies the pick list.
Nested Schema : Price Information
Type:
object
Title:
Price Information
Price Information.
Show Source
-
items:
array items
-
name:
string
Title:
Display Name
Display Name
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 : Array Set Name
Type:
object
Title:
Show Source
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.
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:
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.
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
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Cloud Storage
Type:
object
Title:
Cloud Storage
There needs to be something here about metered and fixed pricing
Show Source
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Do you have storage appliances that need to be accessible to multiple employees?
Type:
object
Title:
Show Source
Do you have storage appliances that need to be accessible to multiple employees?
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Form Factor
Type:
object
Title:
Show Source
Form Factor
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Hard Drive
Type:
object
Title:
Show Source
Hard Drive
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : How many employees does your company have?
Type:
object
Title:
Show Source
How many employees does your company have?
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : How much data do you currently manage and store?
Type:
object
Title:
Show Source
How much data do you currently manage and store?
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Number of Processors
Type:
object
Title:
Show Source
Number of Processors
-
displayValue:
string
Title:
Display Value
-
value:
integer
Title:
Value
Nested Schema : Operating System
Type:
object
Title:
Show Source
Operating System
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Operating System
Type:
object
Title:
Show Source
Operating System
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Optical Drive
Type:
object
Title:
Show Source
Optical Drive
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Packaged Solutions
Type:
object
Title:
Show Source
Packaged Solutions
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Power Supply
Type:
object
Title:
Show Source
Power Supply
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Processor
Type:
object
Title:
Show Source
Processor
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Processor
Type:
object
Title:
Show Source
Processor
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Server Rack
Type:
object
Title:
Show Source
Server Rack
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : RAM
Type:
object
Title:
Show Source
RAM
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : RAM Configuration
Type:
object
Title:
Show Source
RAM Configuration
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Server Module
Type:
object
Title:
Show Source
Server Module
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : System
Type:
object
Title:
Show Source
System
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Tier
Type:
object
Title:
Show Source
Tier
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Servers
Type:
object
Title:
Show Source
Servers
-
displayValue:
string
Title:
Display Value
-
value:
integer
Title:
Value
Nested Schema : Support Level
Type:
object
Title:
Show Source
Support Level
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : part
Type:
Show Source
object
-
_part_custom_field1:
string
Title:
Product Group
-
_part_custom_field10:
object Product type
Title:
Product type
-
_part_custom_field3:
string
Title:
Max discount %
-
_part_custom_field4:
object Price Period
Title:
Price Period
-
_part_custom_field5:
number
Title:
Cost
-
_part_custom_field8:
object Price Type
Title:
Price Type
-
_part_custom_field9:
string
Title:
product
-
comment:
string
Title:
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
Nested Schema : Product type
Type:
object
Title:
Show Source
Product type
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Price Period
Type:
object
Title:
Show Source
Price Period
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : Price Type
Type:
object
Title:
Show Source
Price Type
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : model
Type:
Show Source
object
-
_bm_model_description:
string
Title:
Product Model 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
Nested Schema : Custom Properties
Type:
object
Title:
Custom Properties
Custom properties of the product model.
Show Source
Nested Schema : links
Type:
Show Source
array
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : reference links
Type:
object
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Show Source
-
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
Nested Schema : items
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : priceInfoCategory
Type:
Show Source
object
-
code:
string
Title:
Category Code
-
displayName:
string
Title:
Display Name
Display Name
Nested Schema : avpPriceModel
Type:
Show Source
object
-
items:
array items
-
value:
string
Title:
Value
-
variableName:
string
Title:
Variable Name
Nested Schema : avpPriceItem
Type:
Show Source
object
-
price:
object Price Model
Title:
Price Model
Price Model -
value:
string
Title:
Value
Nested Schema : priceItem
Type:
Show Source
object
-
price:
object Price Model
Title:
Price Model
Price Model -
value:
string
Title:
Value
-
variableName:
string
Title:
Variable Name
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 : Focused Users
Type:
object
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.
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
-
Array of:
string
An error, warning, or informational message.
Nested Schema : items
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : items
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Nested Schema : items
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
-
value:
string
Title:
Value
Examples
The following example shows how to modify configurable attribute values on the latest configuratio data from the configuration cache by submitting a POST request to the REST resource using cURL.
curl -X POST -H "Authorization: Bearer <token>" -H "Accept: application/json" https://sitename.oracle.com/rest/v19/configvision.servers.ultraPowerSolutionPackage/actions/_interact
Request Body Sample
{ "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" } ] } }
Response Body Sample
The following example shows the contents of the response body in JSON format:
{ "cacheInstanceId": "WNVD55lJoYR7Q3QQTGqcw0KiK2iM19fmSCRrRkXG4lOKjwDKD3MLLOFdrn61eOhu", "configData": { "textFieldSetTypeAutolockAttribute": { "value": "user value", "locked": "false" } "_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 } }, "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": false, "messages": [], "visible": true, "hasConstraintViolation": false, "domain": { "constraintType": "DISALLOWED", "constraintList": ["750W PSU", "800W PSU", "1000W PSU"], "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" } ] } } } }, "_recmdModels": {}, "links": [{ "rel": "child", "href": "https://sitename.oracle.com/rest/v19/configvision.servers.ultraPowerSolutionPackage/_bom" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v19/configvision.servers.ultraPowerSolutionPackage/_recmdModels" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v19/configvision.servers.ultraPowerSolutionPackage/_mandatoryModels" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v19/configvision.servers.ultraPowerSolutionPackage/_recmdParts" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v19/configvision.servers.ultraPowerSolutionPackage/_mandatoryParts" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v19/configvision.servers.ultraPowerSolutionPackage/_pickLists" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v19/configvision.servers.ultraPowerSolutionPackage/arraySet/hardDrive_raid_array" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v19/configvision.servers.ultraPowerSolutionPackage/arraySet/applicationSoftware" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v19/configvision.servers.ultraPowerSolutionPackage/arraySet/serviceDetails" } ], "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": "RAM", "price": { "value": "59.99", "currency": "USD" }, "partNumber": "CM55002", "description": "4 GB RAM DDR3 registered DIMMs", "units": "", "directBuy": "Direct Buy", "quantity": 2, "_part_custom_field1": "Hardware", "_part_custom_field3": "18", "_part_custom_field8": { "value": "One Time", "displayValue": "One Time" }, "_part_custom_field5": 35.99, "companyAssociations": "" }, { "leadTime": -1, "comment": "Server Module", "price": { "value": "3,499.00", "currency": "USD" }, "partNumber": "AS85025", "description": "Custom Green Server 3500", "units": "", "directBuy": "Direct Buy", "quantity": 1, "_part_custom_field1": "Hardware", "_part_custom_field3": "19", "_part_custom_field8": { "value": "One Time", "displayValue": "One Time" }, "_part_custom_field5": 2099.4, "companyAssociations": "" }, { "leadTime": -1, "comment": "Oracle OS", "price": { "value": "49.95", "currency": "USD" }, "partNumber": "AS00102", "description": "Oracle Linux", "units": "", "directBuy": "Direct Buy", "quantity": 1, "_part_custom_field1": "Software", "_part_custom_field3": "18", "_part_custom_field8": { "value": "One Time", "displayValue": "One Time" }, "_part_custom_field5": 19.22, "companyAssociations": "" }, { "leadTime": -1, "comment": "Added Support", "price": { "value": "849.95", "currency": "USD" }, "partNumber": "WR11505", "description": "Configure DNS", "units": "", "directBuy": "Direct Buy", "quantity": 1, "_part_custom_field1": "Service", "_part_custom_field3": "20", "_part_custom_field8": { "value": "One Time", "displayValue": "One Time" }, "_part_custom_field5": 509.97, "companyAssociations": "" }, { "leadTime": -1, "comment": "Hard Drive(s)", "price": { "value": "209.99", "currency": "USD" }, "partNumber": "AS25165", "description": "450 GB 15k Hard Drive", "units": "", "directBuy": "Direct Buy", "quantity": 1, "_part_custom_field1": "Hardware", "_part_custom_field3": "15", "_part_custom_field8": { "value": "One Time", "displayValue": "One Time" }, "_part_custom_field5": 103, "companyAssociations": "" }, { "leadTime": -1, "comment": "Server Rack", "price": { "value": "395.00", "currency": "USD" }, "partNumber": "CM53037", "description": "Vision Rack I 1012RU", "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": 175, "companyAssociations": "" }, { "leadTime": -1, "comment": "SLA Agreement", "price": { "value": "270.00", "currency": "USD" }, "partNumber": "WR11513", "description": "Service-Level Agreement", "units": "", "directBuy": "Direct Buy", "quantity": 1, "_part_custom_field1": "Service", "_part_custom_field3": "17", "_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": "" }, { "leadTime": -1, "comment": "Processor(s)", "price": { "value": "279.99", "currency": "USD" }, "partNumber": "CM50012", "description": "Vision E3-2470 8 Cores 2.3 Ghz", "units": "", "directBuy": "Direct Buy", "quantity": 2, "_part_custom_field1": "Hardware", "_part_custom_field3": "20", "_part_custom_field8": { "value": "One Time", "displayValue": "One Time" }, "_part_custom_field5": 95, "companyAssociations": "" }, { "leadTime": -1, "comment": "Fixed Storage", "price": { "value": "89.00", "currency": "USD" }, "partNumber": "AS09744", "description": "Vision Cloud 500GB Backup", "units": "", "directBuy": "Direct Buy", "quantity": 1, "_part_custom_field1": "Service", "_part_custom_field3": "17", "_part_custom_field8": { "value": "Recurring", "displayValue": "Recurring" }, "_part_custom_field5": 53.4, "companyAssociations": "" }, { "leadTime": -1, "comment": "Added Support", "price": { "value": "900.00", "currency": "USD" }, "partNumber": "WR11507", "description": "Install Firewall", "units": "", "directBuy": "Direct Buy", "quantity": 1, "_part_custom_field1": "Service", "_part_custom_field3": "21", "_part_custom_field8": { "value": "One Time", "displayValue": "One Time" }, "_part_custom_field5": 540, "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": {} }