Overview
Customer Configuration flows dictate how users go through the pages and the options available to the user as they create a Transaction. Configuration flow rules consist of a condition and flow attributes. Actions display based on which node in the flow that the user has available based on defined criteria. Beginning in Oracle CPQ Release 18D, Oracle CPQ transforms the current configuration definition as REST endpoints to support UI interfaces. These services are available in v7 and higher RESTful services.
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.
Configuration Layout Services return Oracle CPQ Configuration desktop layout definitions for UI frameworks to consume. The desktop layout definition contains the following items:
- Layout component and properties for panels, tabs, columns, grids and their associated attributes
- Properties for Product Families, Product Lines, and Models
Configuration Process Invocation Metadata Services
Configuration Process Invocation Metadata Services return process invocation metadata for invocation buttons and actions on a specific page or all pages.
Configuration Metadata Services
Configuration Metadata Services expose information about the definitions of the Product Families, Product Lines, Models, attributes, array sets, menu items, and translations. All of the Configuration metadata REST APIs follow a standard product path based on the hierarchy of product family to product line to model. Refer to Configuration REST API Hierarchy. Depending on the metadata being requested, the product path for the endpoint URL requires the broader product structure specified by variable name. Therefore, to retrieve Model-level configuration metadata, the Product Family and Product Line variable names are required.
showParentAttrs=true" query parameter can be added to Configuration attribute and array set metadata REST API endpoints to return all applicable metadata inherited from parent level attributes. For information, refer to Show Parent Attributes Query Parameter.Attribute Metadata REST APIs Overview
These services return the attribute metadata for the specified Product Family, Product Line, or Model.
The attribute metadata is comprised of the following information:
- The defined attribute properties that are defined on the Attribute Editor page
- Possible attribute states, such as whether an attribute is updatable, required, or visible
- Dependencies and possible states, if an attribute can be altered by a rule
- Links to the current REST call, parent and child items, array sets, menu items, and translations
Array Set Metadata REST APIs Overview
These services return the array set metadata for the Product Family, Product Line, or Model.
The array set metadata is comprised of the following information:
- The defined array set properties that are defined on the Array Sets Administration List page
- Possible array set states, such as whether an attribute is updatable, required, or visible
- Dependencies and possible states, if an array set can be altered by rule
- Links to the current REST call, parent and child items, attributes, menu items, and translations
Menu Item Metadata REST APIs Overview
These services return the menu item metadata for the specified attribute or array set of a Product Family, Product Line, or Model.
The menu item metadata is comprised of the following information:
- Menu items are returned as composite values containing menu properties and domain items
- Links to the current REST call, parent and child items, and translations
Translation Service REST APIs Overview
The translation services retrieve translations for Product Families, Product Lines, Models, attributes, array sets, and menu items. Translations, as set up by the administrator for different entities, in all the site-supported languages can be retrieved. If a translation is not defined, an empty string is returned for the requested value in the host company language. The following entities are translatable:
- Product Families - labels, descriptions, and user defaults
- Product Lines - labels, descriptions, and user defaults
- Models - labels, descriptions, and user defaults
- Attributes - labels, descriptions, and user defaults
- Array Sets - labels, descriptions, and user defaults
- Menu Items - display values
There are two components to a REST API URI endpoint used to retrieve translation metadata. These components appended to the end of the specific REST API URL endpoint:
/translations– This returns all language translations for the requested entity./translations/{langcode}– This returns a specific language translation for the requested entity.
When translations are requested, translations that have an empty value for all the properties are not returned. Translation data is returned if any of the property values are populated. The following two samples show a request for all translations for a requested entity and a request for a specific language translation for a requested entity.
Sample All Translations URI Endpoint
The following example retrieves all translations for a specified array set attribute of a Product Line.
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/advancedServerConfiguration/attributes/memory_advArray/translations
Response Body Sample
Sample Specific Language Translation URI Endpoint
The following example retrieves a specific translation language for a specified array set attribute of a Product Line.
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/advancedServerConfiguration/attributes/memory_advArray/translations/de
Sample Specific Language Translation Response Body
{ "language": { "languageCode": "de", "languageNumber": 0 }, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/advancedServerConfiguration/attributes/memory_advArray" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/advancedServerConfiguration/attributes/memory_advArray/translations/de" } ], "label": "Erinnerung", "description": "Erinnerung" }
Administration
The APIs are used to retrieve Layout, Process Invocation, and Metadata information for Configuration Product Family, Product Line, and Model. The endpoint for each REST API appends onto:
https://{siteurl}//rest/v17/, where{siteurl}is the base URL of the Oracle CPQ site.
Show Parent Attributes Query Parameter
The "showParentAttrs=true" query parameter can be added to Configuration Metadata attribute and array set metadata REST API endpoints to return all applicable metadata inherited from parent level attributes. .
URI Endpoint Sample
The following endpoint returns attribute metadata for the "ultraPowerSolutionsPackage" Model, the "servers" Product Line, the "vision" Product Family, and metadata for attributes defined for all Product Families.
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionsPackage/attributes?showParentAttrs=true
Sales User Access to Buy-Side Get Metadata REST APIs
CPQ allows sales users access to Commerce and Configuration buy-side metadata information, including layout details, translated labels, action and attribute types, attribute input parameters, and display properties. Sales Agents, Channel Agents, Restricted Access, and Guest users (if enabled on the site) can be granted access to the following Get Configuration metadata REST APIs:
- Configuration Layout
- Configuration Process Invocation
- Configuration Product Family Integration
- Configuration Metadata
- Configuration Attributes Metadata
- Configuration Array Sets Metadata
- Configuration Array Set Attributes Metadata
- Configuration Attribute Menu Items Metadata
- Configuration Items Metadata
To enable this feature, administrators must open a Service Request (SR) on My Oracle Support. This feature should only be enabled if there is a specific need to expose the metadata (i.e. digital assistant). If Guest access is permitted for the site and this feature is enabled, Configuration Metadata REST API information is exposed to the public internet. This feature does not change the accessibility of administrator-only metadata. Sales users are not able to access the metadata REST API information for Data Tables, BML, rules, and formulas.
Configuration Layout
Get Configuration Layout Attribute Data
|
Description |
This endpoint returns a consolidated list of Product Family, Product Line, and Model attribute metadata from a Configuration layout. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/layoutCache/{prodFamVarName}/{prodLineVarName}/{modelVarName}/attributes |
|
|
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 |
|
| Endpoint Query Parameters |
configFlowVariableName |
Unique variable name to identify the configuration flow |
|
hierLevel |
(optional) The unique identifier to identify the level in which the configuration flow is defined |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
JSON data containing the metadata for Product Family, Product Line, and Model attributes. |
|
https://sitename.oracle.com/rest/v17/layoutCache/testbed/testPL/testModel/attributes?configFlowVariableName=flow1
{ "attributes": { "id": null, "dateModified": null, "language": null, "components": { "items": [{ "id": 21139150, "dateModified": null, "language": null, "components": null, "translations": null, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "resourceVariableName": null, "sequence": 1, "resourceAttrType": "Text", "resourceAttributeVarName": "textField1", "inputTypeCode": { "lookupCode": "TextField" }, "displayType": { "lookupCode": "1", "displayValue": "Text" }, "jetDisplayType": { "lookupCode": "1", "displayValue": "Text" }, "showLabel": true, "label": "Text Field 1", "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "helpIcon": null, "showHelpIcon": false, "helpIconAlignment": "LEFT_OF_LABEL", "hideLock": true, "showCalculator": false, "showRecMsg": true, "showConMsg": true, "showPrevValueMsg": false, "msgPlacement": "BELOW_ATTRIBUTE", "msgWidthUnits": "PERCENTAGE_WIDTH", "msgWidth": "20.0", "setType": "None", "defaultValue": "", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "menuItems": { "items": [], "_state": null }, "description": "", "isArray": null, "additional": {}, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "validationMethod": null, "ssplProperties": null, "ajaxSensitive": true, "isArrayControlAttr": false, "defaultValueOverridden": false, "displayTypeOverridden": false, "setTypeOverridden": false, "jetDisplayTypeOverridden": false, "required": false }, { "id": 21139184, "dateModified": null, "language": null, "components": null, "translations": null, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "resourceVariableName": null, "sequence": 2, "resourceAttrType": "Float", "resourceAttributeVarName": "floatField1", "inputTypeCode": { "lookupCode": "TextField" }, "displayType": { "lookupCode": "1", "displayValue": "Text" }, "jetDisplayType": { "lookupCode": "1", "displayValue": "Text" }, "showLabel": true, "label": "Float Field 1", "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "helpIcon": null, "showHelpIcon": false, "helpIconAlignment": "LEFT_OF_LABEL", "hideLock": true, "showCalculator": false, "showRecMsg": true, "showConMsg": true, "showPrevValueMsg": false, "msgPlacement": "BELOW_ATTRIBUTE", "msgWidthUnits": "PERCENTAGE_WIDTH", "msgWidth": "20.0", "setType": "None", "defaultValue": "", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "menuItems": { "items": [], "_state": null }, "description": "", "isArray": null, "additional": {}, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "validationMethod": { "lookupCode": "1", "displayValue": "None" }, "ssplProperties": null, "ajaxSensitive": false, "isArrayControlAttr": false, "defaultValueOverridden": false, "displayTypeOverridden": false, "setTypeOverridden": false, "jetDisplayTypeOverridden": false, "required": false }, { "id": 21139218, "dateModified": null, "language": null, "components": null, "translations": null, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "resourceVariableName": null, "sequence": 3, "resourceAttrType": "Integer", "resourceAttributeVarName": "integerField1", "inputTypeCode": { "lookupCode": "TextField" }, "displayType": { "lookupCode": "1", "displayValue": "Text" }, "jetDisplayType": { "lookupCode": "1", "displayValue": "Text" }, "showLabel": true, "label": "Integer Field 1", "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "helpIcon": null, "showHelpIcon": false, "helpIconAlignment": "LEFT_OF_LABEL", "hideLock": true, "showCalculator": false, "showRecMsg": true, "showConMsg": true, "showPrevValueMsg": false, "msgPlacement": "BELOW_ATTRIBUTE", "msgWidthUnits": "PERCENTAGE_WIDTH", "msgWidth": "20.0", "setType": "None", "defaultValue": "", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "menuItems": { "items": [], "_state": null }, "description": "", "isArray": null, "additional": {}, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "validationMethod": { "lookupCode": "1", "displayValue": "None" }, "ssplProperties": null, "ajaxSensitive": false, "isArrayControlAttr": false, "defaultValueOverridden": false, "displayTypeOverridden": false, "setTypeOverridden": false, "jetDisplayTypeOverridden": false, "required": false }, { "id": 21139252, "dateModified": null, "language": null, "components": null, "translations": null, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "resourceVariableName": null, "sequence": 4, "resourceAttrType": "Date", "resourceAttributeVarName": "dateField1", "inputTypeCode": { "lookupCode": "Date" }, "displayType": { "lookupCode": "0", "displayValue": "Date" }, "jetDisplayType": { "lookupCode": "15", "displayValue": "Date" }, "showLabel": true, "label": "Date Field 1", "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "helpIcon": null, "showHelpIcon": false, "helpIconAlignment": "LEFT_OF_LABEL", "hideLock": true, "showCalculator": false, "showRecMsg": true, "showConMsg": true, "showPrevValueMsg": false, "msgPlacement": "BELOW_ATTRIBUTE", "msgWidthUnits": "PERCENTAGE_WIDTH", "msgWidth": "20.0", "setType": "None", "defaultValue": "", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "menuItems": { "items": [], "_state": null }, "description": "", "isArray": null, "additional": {}, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "validationMethod": { "lookupCode": "1", "displayValue": "None" }, "ssplProperties": null, "ajaxSensitive": false, "isArrayControlAttr": false, "defaultValueOverridden": false, "displayTypeOverridden": false, "setTypeOverridden": false, "jetDisplayTypeOverridden": false, "required": false }, { "id": 21139286, "dateModified": null, "language": null, "components": null, "translations": null, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "resourceVariableName": null, "sequence": 5, "resourceAttrType": "Currency", "resourceAttributeVarName": "currencyField1", "inputTypeCode": { "lookupCode": "TextField" }, "displayType": { "lookupCode": "1", "displayValue": "Text" }, "jetDisplayType": { "lookupCode": "1", "displayValue": "Text" }, "showLabel": true, "label": "Currency Field 1", "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "helpIcon": null, "showHelpIcon": false, "helpIconAlignment": "LEFT_OF_LABEL", "hideLock": true, "showCalculator": false, "showRecMsg": true, "showConMsg": true, "showPrevValueMsg": false, "msgPlacement": "BELOW_ATTRIBUTE", "msgWidthUnits": "PERCENTAGE_WIDTH", "msgWidth": "20.0", "setType": "None", "defaultValue": "", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "menuItems": { "items": [], "_state": null }, "description": "", "isArray": null, "additional": { "precision_CNY": "", "precision_JPY": "", "precision_EUR": "", "precision_ALL": "", "precision_USD": "" }, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "validationMethod": { "lookupCode": "1", "displayValue": "None" }, "ssplProperties": null, "ajaxSensitive": false, "isArrayControlAttr": false, "defaultValueOverridden": false, "displayTypeOverridden": false, "setTypeOverridden": false, "jetDisplayTypeOverridden": false, "required": false }, { "id": 21139320, "dateModified": null, "language": null, "components": null, "translations": null, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "resourceVariableName": null, "sequence": 6, "resourceAttrType": "Boolean", "resourceAttributeVarName": "boolean1", "inputTypeCode": { "lookupCode": "Boolean" }, "displayType": { "lookupCode": "10", "displayValue": "Boolean Checkbox" }, "jetDisplayType": { "lookupCode": "16", "displayValue": "Switch" }, "showLabel": true, "label": "Boolean 1", "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "helpIcon": null, "showHelpIcon": false, "helpIconAlignment": "LEFT_OF_LABEL", "hideLock": true, "showCalculator": false, "showRecMsg": true, "showConMsg": true, "showPrevValueMsg": false, "msgPlacement": "BELOW_ATTRIBUTE", "msgWidthUnits": "PERCENTAGE_WIDTH", "msgWidth": "20.0", "setType": "None", "defaultValue": "false", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "menuItems": { "items": [], "_state": null }, "description": "", "isArray": null, "additional": {}, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "validationMethod": null, "ssplProperties": null, "ajaxSensitive": false, "isArrayControlAttr": false, "defaultValueOverridden": false, "displayTypeOverridden": false, "setTypeOverridden": false, "jetDisplayTypeOverridden": false, "required": false }, { "id": 21139354, "dateModified": null, "language": null, "components": null, "translations": null, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "resourceVariableName": null, "sequence": 1, "resourceAttrType": "Text", "resourceAttributeVarName": "textSSM1", "inputTypeCode": { "lookupCode": "SingleSelectMenu" }, "displayType": { "lookupCode": "3", "displayValue": "Single Select Menu" }, "jetDisplayType": { "lookupCode": "3", "displayValue": "Select Choice" }, "showLabel": true, "label": "Text SSM 1", "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "helpIcon": null, "showHelpIcon": false, "helpIconAlignment": "LEFT_OF_LABEL", "hideLock": true, "showCalculator": false, "showRecMsg": true, "showConMsg": true, "showPrevValueMsg": false, "msgPlacement": "BELOW_ATTRIBUTE", "msgWidthUnits": "PERCENTAGE_WIDTH", "msgWidth": "20.0", "setType": "None", "defaultValue": "", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "menuItems": { "items": [{ "id": 3023092079, "dateModified": null, "language": null, "displayValue": "Value 1", "value": "Value 1", "orderNumber": 1, "imageUrl": null, "avp": null }, { "id": 3023092080, "dateModified": null, "language": null, "displayValue": "Value 2", "value": "Value 2", "orderNumber": 2, "imageUrl": null, "avp": null }, { "id": 3023092081, "dateModified": null, "language": null, "displayValue": "Value 3", "value": "Value 3", "orderNumber": 3, "imageUrl": null, "avp": null } ], "_state": null }, "description": "", "isArray": null, "additional": { "jet_constrained_display": "Strike Through" }, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "validationMethod": null, "ssplProperties": null, "ajaxSensitive": false, "isArrayControlAttr": false, "defaultValueOverridden": false, "displayTypeOverridden": false, "setTypeOverridden": false, "jetDisplayTypeOverridden": false, "required": false }, { "id": 21139388, "dateModified": null, "language": null, "components": null, "translations": null, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "resourceVariableName": null, "sequence": 3, "resourceAttrType": "Float", "resourceAttributeVarName": "floatSSM1", "inputTypeCode": { "lookupCode": "SingleSelectMenu" }, "displayType": { "lookupCode": "3", "displayValue": "Single Select Menu" }, "jetDisplayType": { "lookupCode": "3", "displayValue": "Select Choice" }, "showLabel": true, "label": "Float SSM 1", "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "helpIcon": null, "showHelpIcon": false, "helpIconAlignment": "LEFT_OF_LABEL", "hideLock": true, "showCalculator": false, "showRecMsg": true, "showConMsg": true, "showPrevValueMsg": false, "msgPlacement": "BELOW_ATTRIBUTE", "msgWidthUnits": "PERCENTAGE_WIDTH", "msgWidth": "20.0", "setType": "None", "defaultValue": "", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "menuItems": { "items": [{ "id": 18310383, "dateModified": null, "language": null, "displayValue": "1.23", "value": "1.23", "orderNumber": 1, "imageUrl": null, "avp": null }, { "id": 18310384, "dateModified": null, "language": null, "displayValue": "2.34", "value": "2.34", "orderNumber": 2, "imageUrl": null, "avp": null }, { "id": 18310385, "dateModified": null, "language": null, "displayValue": "3.45", "value": "3.45", "orderNumber": 3, "imageUrl": null, "avp": null } ], "_state": null }, "description": "", "isArray": null, "additional": { "jet_constrained_display": "Strike Through" }, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "validationMethod": { "lookupCode": "1", "displayValue": "None" }, "ssplProperties": null, "ajaxSensitive": false, "isArrayControlAttr": false, "defaultValueOverridden": false, "displayTypeOverridden": false, "setTypeOverridden": false, "jetDisplayTypeOverridden": false, "required": false }, { "id": 21139422, "dateModified": null, "language": null, "components": null, "translations": null, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "resourceVariableName": null, "sequence": 2, "resourceAttrType": "Integer", "resourceAttributeVarName": "integerSSM1", "inputTypeCode": { "lookupCode": "SingleSelectMenu" }, "displayType": { "lookupCode": "3", "displayValue": "Single Select Menu" }, "jetDisplayType": { "lookupCode": "3", "displayValue": "Select Choice" }, "showLabel": true, "label": "Integer SSM 1", "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "helpIcon": null, "showHelpIcon": false, "helpIconAlignment": "LEFT_OF_LABEL", "hideLock": true, "showCalculator": false, "showRecMsg": true, "showConMsg": true, "showPrevValueMsg": false, "msgPlacement": "BELOW_ATTRIBUTE", "msgWidthUnits": "PERCENTAGE_WIDTH", "msgWidth": "20.0", "setType": "None", "defaultValue": "", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "menuItems": { "items": [{ "id": 18310388, "dateModified": null, "language": null, "displayValue": "1", "value": "1", "orderNumber": 1, "imageUrl": null, "avp": null }, { "id": 18310389, "dateModified": null, "language": null, "displayValue": "2", "value": "2", "orderNumber": 2, "imageUrl": null, "avp": null }, { "id": 18310390, "dateModified": null, "language": null, "displayValue": "3", "value": "3", "orderNumber": 3, "imageUrl": null, "avp": null } ], "_state": null }, "description": "", "isArray": null, "additional": { "jet_constrained_display": "Strike Through" }, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "validationMethod": { "lookupCode": "1", "displayValue": "None" }, "ssplProperties": null, "ajaxSensitive": false, "isArrayControlAttr": false, "defaultValueOverridden": false, "displayTypeOverridden": false, "setTypeOverridden": false, "jetDisplayTypeOverridden": false, "required": false }, { "id": 21139456, "dateModified": null, "language": null, "components": null, "translations": null, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "resourceVariableName": null, "sequence": 1, "resourceAttrType": "Text", "resourceAttributeVarName": "textMSM1", "inputTypeCode": { "lookupCode": "MultiSelectMenu" }, "displayType": { "lookupCode": "4", "displayValue": "Multi Select Menu" }, "jetDisplayType": { "lookupCode": "3", "displayValue": "Select Choice" }, "showLabel": true, "label": "Text MSM 1", "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "helpIcon": null, "showHelpIcon": false, "helpIconAlignment": "LEFT_OF_LABEL", "hideLock": true, "showCalculator": false, "showRecMsg": true, "showConMsg": true, "showPrevValueMsg": false, "msgPlacement": "BELOW_ATTRIBUTE", "msgWidthUnits": "PERCENTAGE_WIDTH", "msgWidth": "20.0", "setType": "None", "defaultValue": "", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "menuItems": { "items": [{ "id": 18310393, "dateModified": null, "language": null, "displayValue": "Value 1", "value": "Value 1", "orderNumber": 1, "imageUrl": null, "avp": null }, { "id": 18310394, "dateModified": null, "language": null, "displayValue": "Value 2", "value": "Value 2", "orderNumber": 2, "imageUrl": null, "avp": null }, { "id": 18310395, "dateModified": null, "language": null, "displayValue": "Value 3", "value": "Value 3", "orderNumber": 3, "imageUrl": null, "avp": null } ], "_state": null }, "description": "", "isArray": null, "additional": { "jet_constrained_display": "Strike Through" }, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "validationMethod": null, "ssplProperties": null, "ajaxSensitive": false, "isArrayControlAttr": false, "defaultValueOverridden": false, "displayTypeOverridden": false, "setTypeOverridden": false, "jetDisplayTypeOverridden": false, "required": false }, { "id": 21139490, "dateModified": null, "language": null, "components": null, "translations": null, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "resourceVariableName": null, "sequence": 3, "resourceAttrType": "Float", "resourceAttributeVarName": "floatMSM1", "inputTypeCode": { "lookupCode": "MultiSelectMenu" }, "displayType": { "lookupCode": "4", "displayValue": "Multi Select Menu" }, "jetDisplayType": { "lookupCode": "3", "displayValue": "Select Choice" }, "showLabel": true, "label": "Float MSM 1", "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "helpIcon": null, "showHelpIcon": false, "helpIconAlignment": "LEFT_OF_LABEL", "hideLock": true, "showCalculator": false, "showRecMsg": true, "showConMsg": true, "showPrevValueMsg": false, "msgPlacement": "BELOW_ATTRIBUTE", "msgWidthUnits": "PERCENTAGE_WIDTH", "msgWidth": "20.0", "setType": "None", "defaultValue": "", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "menuItems": { "items": [{ "id": 18310398, "dateModified": null, "language": null, "displayValue": "1.23", "value": "1.23", "orderNumber": 1, "imageUrl": null, "avp": null }, { "id": 18310399, "dateModified": null, "language": null, "displayValue": "2.34", "value": "2.34", "orderNumber": 2, "imageUrl": null, "avp": null }, { "id": 18310400, "dateModified": null, "language": null, "displayValue": "3.45", "value": "3.45", "orderNumber": 3, "imageUrl": null, "avp": null } ], "_state": null }, "description": "", "isArray": null, "additional": { "jet_constrained_display": "Strike Through" }, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "validationMethod": { "lookupCode": "1", "displayValue": "None" }, "ssplProperties": null, "ajaxSensitive": false, "isArrayControlAttr": false, "defaultValueOverridden": false, "displayTypeOverridden": false, "setTypeOverridden": false, "jetDisplayTypeOverridden": false, "required": false }, { "id": 21139524, "dateModified": null, "language": null, "components": null, "translations": null, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "resourceVariableName": null, "sequence": 2, "resourceAttrType": "Integer", "resourceAttributeVarName": "integerMSM1", "inputTypeCode": { "lookupCode": "MultiSelectMenu" }, "displayType": { "lookupCode": "4", "displayValue": "Multi Select Menu" }, "jetDisplayType": { "lookupCode": "3", "displayValue": "Select Choice" }, "showLabel": true, "label": "Integer MSM 1", "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "helpIcon": null, "showHelpIcon": false, "helpIconAlignment": "LEFT_OF_LABEL", "hideLock": true, "showCalculator": false, "showRecMsg": true, "showConMsg": true, "showPrevValueMsg": false, "msgPlacement": "BELOW_ATTRIBUTE", "msgWidthUnits": "PERCENTAGE_WIDTH", "msgWidth": "20.0", "setType": "None", "defaultValue": "", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "menuItems": { "items": [{ "id": 18310403, "dateModified": null, "language": null, "displayValue": "1", "value": "1", "orderNumber": 1, "imageUrl": null, "avp": null }, { "id": 18310404, "dateModified": null, "language": null, "displayValue": "2", "value": "2", "orderNumber": 2, "imageUrl": null, "avp": null }, { "id": 18310405, "dateModified": null, "language": null, "displayValue": "3", "value": "3", "orderNumber": 3, "imageUrl": null, "avp": null } ], "_state": null }, "description": "", "isArray": null, "additional": { "jet_constrained_display": "Strike Through" }, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "validationMethod": { "lookupCode": "1", "displayValue": "None" }, "ssplProperties": null, "ajaxSensitive": false, "isArrayControlAttr": false, "defaultValueOverridden": false, "displayTypeOverridden": false, "setTypeOverridden": false, "jetDisplayTypeOverridden": false, "required": false }, { "id": 21139578, "dateModified": null, "language": null, "components": null, "translations": null, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "resourceVariableName": null, "sequence": 1, "resourceAttrType": "Boolean", "resourceAttributeVarName": "condition1", "inputTypeCode": { "lookupCode": "Boolean" }, "displayType": { "lookupCode": "10", "displayValue": "Boolean Checkbox" }, "jetDisplayType": { "lookupCode": "16", "displayValue": "Switch" }, "showLabel": true, "label": "Condition 1", "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "helpIcon": null, "showHelpIcon": false, "helpIconAlignment": "LEFT_OF_LABEL", "hideLock": true, "showCalculator": false, "showRecMsg": true, "showConMsg": true, "showPrevValueMsg": false, "msgPlacement": "BELOW_ATTRIBUTE", "msgWidthUnits": "PERCENTAGE_WIDTH", "msgWidth": "20.0", "setType": "None", "defaultValue": "false", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "menuItems": { "items": [], "_state": null }, "description": "", "isArray": null, "additional": {}, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "validationMethod": null, "ssplProperties": null, "ajaxSensitive": false, "isArrayControlAttr": false, "defaultValueOverridden": false, "displayTypeOverridden": false, "setTypeOverridden": false, "jetDisplayTypeOverridden": false, "required": false } ], "_state": null }, "translations": null, "componentTypeCode": null, "resourceVariableName": null, "sequence": 0 } }
|
Description |
This action returns the desktop layout metadata for a Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/layouts/{layoutVarName} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
layoutVarName |
The variable name of a Product Family layout |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
JSON data containing the desktop layout definition for a Product Family |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/layouts/serverFamilyFlow
Response Body Sample
|
Description |
This action returns the desktop layout metadata for a Product Line. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/layouts/{layoutVarName} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
layoutVarName |
The variable name of a Product Line layout |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
JSON data containing the desktop layout definition for a Product Line |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/Servers/layouts/serverFamilyFlow
Response Body Sample
|
Description |
This action returns the desktop layout metadata for a Model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/layouts/{layoutVarName} |
|
|
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 |
|
|
layoutVarName |
The variable name of a Product Line layout |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
JSON data containing the desktop layout definition for a Model |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/Servers/models/ultraPowerSolutionPackage/layouts/serverFamilyFlow
Response Body Sample
Configuration Process Invocation
Get Process Invocations on All Pages
|
Description |
This service returns the metadata for all process invocations on all pages. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/processInvocations |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
JSON data containing metadata for all process invocations on all pages |
|
https://sitename.oracle.com/rest/v17/proccessInvocations
Response Body Sample
Get Process Invocations for a Specific Page
|
Description |
This service returns the metadata for all process invocations available for a specific page. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/processInvocations/{pageTitle} |
|
|
Endpoint Parameters |
pageTitle |
The variable name of a specific page; first letter lowercase followed page title without spaces |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
JSON data containing metadata for all process invocations available on a specific page |
|
https://sitename.oracle.com/rest/v17/proccessInvocations/modelConfiguration
{ "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/processInvocations/modelConfiguration" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/processInvocations/modelConfiguration/actions" } ], "pageTitle": "modelConfiguration", "attributes": "Model,Config", "lastDeployed": "2018-10-30", "pageType": "Single" }
Get Process Invocation Actions for a Specific Page
|
Description |
This service returns the metadata for all process invocations actions for a specific page. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/processInvocations/{pageTitle}/actions |
|
|
Endpoint Parameters |
pageTitle |
The variable name of a specific page; first letter lowercase followed page title without spaces |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
JSON data containing metadata for all process invocation actions for a specific page |
|
https://sitename.oracle.com/rest/v17/proccessInvocations/modelConfiguration/actions
Response Body Sample
Get Process Invocation Action for a Specific Page
|
Description |
This service returns the metadata for all process invocations available for a specific page. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/processInvocations/{pageTitle}/actions/{actionID} |
|
|
Endpoint Parameters |
pageTitle |
The variable name of a specific page; first letter lowercase followed page title without spaces |
|
actionID |
The variable name of a process invocation action | |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
JSON data containing metadata for a process invocation action for a specific page |
|
https://sitename.oracle.com/rest/v17/processInvocations/modelConfiguration/actions/36292358
Response Body Sample
Configuration Product Family Integration
Get Product Family Integration Metadata
|
Description |
This endpoint returns metadata for the specified Product Family integration. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/integrations/{integrationVarName} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
integrationVarName |
The variable name of a Product Family integration |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
The integration action button metadata (i.e. display name and variable name) for the specified Product Family integration. |
|
https://sitename.oracle.com/rest/v17/productFamilies/integration/integrations/integrationAction
{ "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/integration/integrations"},{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/integrations/integrationAction"}], "name": "Integration Action", "variableName": "integrationAction", "translations": { "items": [{ "language": { "languageCode": "en", "languageNumber": -1 }, "name": "Integration Action" },{ "language": { "languageCode": "de", "languageNumber": 0 }, "name": "Integration Action_&amul;ößü"}] } }
Get Product Family Integrations Metadata
|
Description |
This endpoint returns an array of all integrations defined for a specific Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/integrations |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
An array of all integrations defined for the specified Product Family. |
|
https://sitename.oracle.com/rest/v17/productFamilies/integration/integrations
{ "items": [{ "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/integration" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/integration/integrations/integrationAction"}], "name": "Integration Action", "variableName": "integrationAction", "translations": { "items": [{ "language": { "languageCode": "en", "languageNumber": -1 }, "name": "Integration Action" }, { "language": { "languageCode": "de", "languageNumber": 0 }, "name": "Integration Action_&amul;ößü"}] } } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/integration/integrations"}]
Configuration Metadata
|
Description |
This endpoint returns definitions for all Product Families. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies |
|
|
Endpoint Parameters |
None | |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all Product Families |
|
https://sitename.oracle.com/rest/v17/productFamilies
{ "items": [{ "id": 36637441, "dateModified": "2018-10-30T07:29:44.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/attributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets" } ], "label": "Hi-Tech", "variableName": "vision", "segmentId": 10, "orderNumber": 1 } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies" } ] }
|
Description |
This endpoint returns definitions for a specific Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for a specific Product Family |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision
Note: The following components can be appended to the end of this endpoint to return translation metadata:
/translations- This returns all language translations for the requested entity./translations/{langCode}- This returns a specific language translation for the requested entity.
Example:/translations/es
{ "id": 36637441, "dateModified": "2018-10-30T07:29:44.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/attributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets" } ], "label": "Hi-Tech", "variableName": "vision", "segmentId": 10, "orderNumber": 1 }
|
Description |
This endpoint returns definitions for a specific Product Line within a Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all Product Lines |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines
{ "items": [{ "id": 36637525, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/attributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets" } ], "customProperties": {}, "_bm_pline_name": "Servers", "_bm_pline_variable_name": "servers", "_bm_pline_description": "<img src='$BASE_PATH$/Vision/OLDserver-banner.png' alt='' />" }, { "id": 36637526, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/laptops" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/laptops/models" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/laptops/attributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/laptops/arraySets" } ], "customProperties": {}, "_bm_pline_name": "Laptops", "_bm_pline_variable_name": "laptops", "_bm_pline_description": "<img src='$BASE_PATH$/Vision/OLDlaptop-banner.png' alt='' />" } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines" } ] }
|
Description |
This endpoint returns definitions for a specific Product Line within a Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for a specific Product Line |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers
{ "id": 36637525, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/attributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets" } ], "customProperties": {}, "_bm_pline_name": "Servers", "_bm_pline_variable_name": "servers", "_bm_pline_description": "<img src='$BASE_PATH$/Vision/OLDserver-banner.png' alt='' />" }
|
Description |
This endpoint returns definitions for all Models within a given Product Family and Product Line. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all Models |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models
Response Body Sample
|
Description |
This endpoint returns definitions for a specific Model within a given Product Family and Product Line. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName} |
|
|
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 |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all Product Lines |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionsPackage
{ "id": 36637530, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/attributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets" } ], "customProperties": { "_bm_model_ht_model_image": null, "_bm_model_ht_model_imageURL": "https://hitech-build.bigmachines.com/bmfsweb/hitech-build/image/Vision/ultraPackage.png", "_bm_model_ht_model_basePrice": { "currency": "USD", "value": "$15,131.670000" }, "_bm_model_ht_model_configurationLink": "&packagedSolutions=Ultra", "_bm_model_ht_model_operatingSystem": "Blue Hat Enterprise Premium", "_bm_model_ht_model_processor": "Vision E3-4870", "_bm_model_ht_model_sockets": 4, "_bm_model_ht_model_cores": 10, "_bm_model_ht_model_threads": 80, "_bm_model_ht_model_cpuSpeed": "2.4 GHz x 4", "_bm_model_ht_model_memory": "32 GB RAM/480 GB SSD", "_bm_model_ht_model_formFactor": "Blade", "_bm_model_ht_model_productDetailsLink": "", "_bm_model_ht_model_simpleDescription": "Perfect Solutions in Single Full-Height Blades", "_bm_model_ht_model_link1": "https://hitech-build.bigmachines.com/bmfsweb/hitech-build/image/Data%20Sheets/AS86009.pdf", "_bm_model_ht_model_link2": "https://hitech-build.bigmachines.com/bmfsweb/hitech-build/image/Data%20Sheets/Comparing_Dual-Core_vs_Quad-Core_CPUs.pdf", "_bm_model_ht_model_link3": "https://www.oracle.com/us/solutions/oracle-opt-sols-cloud-inf-sol-brief-406108.pdf", "_bm_model_ready_for_self_service": false, "_bm_model_self_service_part_number": "" }, "_bm_model_name": "Ultra Power Solution Package", "_bm_model_variable_name": "ultraPowerSolutionPackage", "_bm_model_description": "Vision's Ultra Power Solution is the perfect integration of compute, memory, and storage in a single full-height blade form actor for running both virtual and physical workloads. It’s easy to deploy, manage and provision." }
Configuration Attributes Metadata
Get Product Family Attributes Metadata
|
Description |
This service returns the metadata for all attributes of a specific Product Family |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/attributes |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all attributes of a specific Product Family |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/attributes
Response Body Sample
Get Product Family Attribute Metadata
|
Description |
This service returns the metadata for a specific attribute of a specific Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/attributes/{attributeVarName} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
attributeVarName |
The variable name of a specific attribute |
|
|
Optional, the following parameters can be appended to the end of this endpoint to retrieve translation metadata. These components appended to the end of the specific REST API URL endpoint:
|
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for a specific attribute of a specific Product Family |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/attributes/operatingSystem_selector
{ "id": 36673008, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/attributes/operatingSystem_selector" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/attributes/operatingSystem_selector/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/attributes/operatingSystem_selector/menuItems" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/attributes/operatingSystem_selector/calculatorTabs" } ], "name": "Operating System", "description": "", "variableName": "operatingSystem_selector", "orderNumber": 1, "required": true, "itemLevelProcess": false, "autoLock": false, "hideInTrans": false, "defaultValue": "All Operating Systems", "startDate": "", "endDate": "", "additional": { "image_menu_layout": "0" }, "type": { "lookupCode": "1", "displayValue": "Text" }, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "status": { "lookupCode": "1", "displayValue": "Active" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "setType": { "lookupCode": "1", "displayValue": "None" }, "displayType": { "lookupCode": "3", "displayValue": "Single Select Menu" }, "priceItem": { "pricingType": { "lookupCode": "1", "displayValue": "None" }, "pricingDisplayType": { "lookupCode": "1", "displayValue": "None" }, "displayPriceAtBottom": true, "includeInTotalPrice": true }, "potentialStates": ["updatable"], "ajaxSensitive": false, "arrayControlAttr": false, "array": false }
Get Product Line Attributes Metadata
|
Description |
This service returns the metadata for all attributes of a Product Line. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all attributes for a specific Product Line |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/laptops/attributes
Response Body Sample
Get Product Line Attribute Metadata
|
Description |
This service returns the metadata for a specific attribute of a Product Line. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes/{attributeVarName} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
attributeVarName |
The variable name of a specific attribute |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for a specific attribute for a Product Line |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/laptops/attributes/processor
{ "id": 36637585, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/laptops" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/laptops/attributes/processor" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/laptops/attributes/processor/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/laptops/attributes/processor/menuItems" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/laptops/attributes/processor/calculatorTabs" } ], "name": "Processor", "description": "<iframe src =\"https://hitech-build.bigmachines.com/bmfsweb/hitech-build/image/Data%20Sheets/Comparing_Dual-Core_vs_Quad-Core_CPUs.pdf\" width=\"800\" height=\"600\"></iframe>", "variableName": "processor", "orderNumber": 3, "required": true, "itemLevelProcess": true, "autoLock": false, "hideInTrans": false, "defaultValue": "Dual Core 2.8GHz", "startDate": "", "endDate": "", "additional": { "image_menu_layout": "0" }, "type": { "lookupCode": "1", "displayValue": "Text" }, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "status": { "lookupCode": "1", "displayValue": "Active" }, "constraintDisplayType": { "lookupCode": "2", "displayValue": "Removed" }, "setType": { "lookupCode": "1", "displayValue": "None" }, "displayType": { "lookupCode": "7", "displayValue": "Radio Button Vertical" }, "priceItem": { "pricingType": { "lookupCode": "1", "displayValue": "None" }, "pricingDisplayType": { "lookupCode": "1", "displayValue": "None" }, "displayPriceAtBottom": true, "includeInTotalPrice": true }, "potentialStates": ["updatable"], "ajaxSensitive": true, "arrayControlAttr": false, "array": false }
|
Description |
This service returns the metadata for all attributes of a specific Model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes |
|
|
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 |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all attributes of a specific Model |
|
https://sitename.oracle.com/rest/v17/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes
{ "items": [{ "id": 36735252, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/unityINC/productLines/mergedServices/models/converge" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes/numberOfServices" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes/numberOfServices/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes/numberOfServices/menuItems" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes/numberOfServices/calculatorTabs" } ], "name": "Number of Services", "description": "", "variableName": "numberOfServices", "orderNumber": 1, "required": false, "itemLevelProcess": false, "autoLock": false, "hideInTrans": false, "defaultValue": "1", "startDate": "", "endDate": "", "additional": { "maximum": "200", "minimum": "1" }, "type": { "lookupCode": "3", "displayValue": "Integer" }, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "status": { "lookupCode": "1", "displayValue": "Active" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "setType": { "lookupCode": "1", "displayValue": "None" }, "displayType": { "lookupCode": "1", "displayValue": "Text" }, "validationMethod": { "lookupCode": "3", "displayValue": "Range Check" }, "priceItem": { "pricingType": { "lookupCode": "1", "displayValue": "None" }, "pricingDisplayType": { "lookupCode": "1", "displayValue": "None" }, "displayPriceAtBottom": true, "includeInTotalPrice": true }, "potentialStates": ["visible", "updatable"], "ajaxSensitive": false, "arrayControlAttr": true, "array": false } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes" } ] }
|
Description |
This service returns the metadata for a specific attribute of a Model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName} |
|
|
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 |
|
|
attributeVarName |
The variable name of a specific attribute |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for a specific attribute of a Model |
|
https://sitename.oracle.com/rest/v17/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes/numberOfServices
{ "id": 36735252, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/unityINC/productLines/mergedServices/models/converge" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes/numberOfServices" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes/numberOfServices/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes/numberOfServices/menuItems" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/unityINC/productLines/mergedServices/models/converge/attributes/numberOfServices/calculatorTabs" } ], "name": "Number of Services", "description": "", "variableName": "numberOfServices", "orderNumber": 1, "required": false, "itemLevelProcess": false, "autoLock": false, "hideInTrans": false, "defaultValue": "1", "startDate": "", "endDate": "", "additional": { "maximum": "200", "minimum": "1" }, "type": { "lookupCode": "3", "displayValue": "Integer" }, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "status": { "lookupCode": "1", "displayValue": "Active" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "setType": { "lookupCode": "1", "displayValue": "None" }, "displayType": { "lookupCode": "1", "displayValue": "Text" }, "validationMethod": { "lookupCode": "3", "displayValue": "Range Check" }, "priceItem": { "pricingType": { "lookupCode": "1", "displayValue": "None" }, "pricingDisplayType": { "lookupCode": "1", "displayValue": "None" }, "displayPriceAtBottom": true, "includeInTotalPrice": true }, "potentialStates": ["visible", "updatable"], "ajaxSensitive": false, "arrayControlAttr": true, "array": false }
Configuration Array Sets Metadata
Get Product Family Array Sets Metadata
|
Description |
This service returns the metadata for all array sets of a Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/arraySets |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all array sets of a Product Family |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets
{ "items": [{ "id": 36673330, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/_sethardDrive_raid_array" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/_sethardDrive_raid_array/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/_sethardDrive_raid_array/attributes" } ], "refType": 3, "name": "Additional Hard Drive", "variableName": "_sethardDrive_raid_array", "desc": "", "sizeAttrId": 36673037, "defaultAttrId": 36673038, "displayType": { "lookupCode": "2", "displayValue": "Vertical" }, "labelOption": { "lookupCode": "1", "displayValue": "Display Only First Label" }, "prefixText": "", "suffixText": "" }, { "id": 36673355, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/_setapplicationSoftware" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/_setapplicationSoftware/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/_setapplicationSoftware/attributes" } ], "refType": 3, "name": "Application Software", "variableName": "_setapplicationSoftware", "desc": "", "sizeAttrId": 36673055, "defaultAttrId": -1, "displayType": { "lookupCode": "1", "displayValue": "Horizontal" }, "labelOption": { "lookupCode": "1", "displayValue": "Display Only First Label" }, "prefixText": "", "suffixText": "" } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets" } ] }
Get Product Family Array Set Metadata
|
Description |
This service returns the metadata for a specific array set of a Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/arraySets/{arraySetVarName} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
arraySetVarName |
The variable name of an array set |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for a specific array set of a specific Product Family |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/applicationSoftware
{ "id": 36673355, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/_setapplicationSoftware" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/_setapplicationSoftware/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/_setapplicationSoftware/attributes" } ], "refType": 3, "name": "Application Software", "variableName": "_setapplicationSoftware", "desc": "", "sizeAttrId": 36673055, "defaultAttrId": -1, "displayType": { "lookupCode": "1", "displayValue": "Horizontal" }, "labelOption": { "lookupCode": "1", "displayValue": "Display Only First Label" }, "prefixText": "", "suffixText": "" }
Get Product Line Array Sets Metadata
|
Description |
This service returns the metadata for all array sets of a Product Line. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/arraySets |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all array sets of a Product Line |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets
"id": 36776183, "links": [ { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/_setapplicationSoftware" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/_setapplicationSoftware/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/_setapplicationSoftware/attributes" } ], "refType": 3, "name": "Application Software", "variableName": "_setapplicationSoftware", "desc": "", "sizeAttrId": 36775312, "sizeAttrVarName": "applicationSoftwareCounter", "defaultAttrId": -1, "displayType": { "lookupCode": "1", "displayValue": "Horizontal" }, "labelOption": { "lookupCode": "1", "displayValue": "Display Only First Label" }, "prefixText": "", "suffixText": "" }
Get Product Line Array Set Metadata
|
Description |
This service returns the metadata for a specific array set of a Product Line. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/arraySets/{arraySetVarName} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
arraySetVarName |
The variable name of an array set |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for a specific array set of a Product Line |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware
{ "id": 36673355, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/_setapplicationSoftware" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/_setapplicationSoftware/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/_setapplicationSoftware/attributes" } ], "refType": 3, "name": "Application Software", "variableName": "_setapplicationSoftware", "desc": "", "sizeAttrId": 36673055, "defaultAttrId": -1, "displayType": { "lookupCode": "1", "displayValue": "Horizontal" }, "labelOption": { "lookupCode": "1", "displayValue": "Display Only First Label" }, "prefixText": "", "suffixText": "" }
|
Description |
This service returns the metadata for all array sets of a specific Model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/arraySets |
|
|
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 |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all array sets of a specific Model |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionsPackage/arraySets
{ "items": [{ "id": 36673330, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/_sethardDrive_raid_array" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/_sethardDrive_raid_array/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/_sethardDrive_raid_array/attributes" } ], "refType": 3, "name": "Additional Hard Drive", "variableName": "_sethardDrive_raid_array", "desc": "", "sizeAttrId": 36673037, "defaultAttrId": 36673038, "displayType": { "lookupCode": "2", "displayValue": "Vertical" }, "labelOption": { "lookupCode": "1", "displayValue": "Display Only First Label" }, "prefixText": "", "suffixText": "" }, { "id": 36673355, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/_setapplicationSoftware" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/_setapplicationSoftware/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/_setapplicationSoftware/attributes" } ], "refType": 3, "name": "Application Software", "variableName": "_setapplicationSoftware", "desc": "", "sizeAttrId": 36673055, "defaultAttrId": -1, "displayType": { "lookupCode": "1", "displayValue": "Horizontal" }, "labelOption": { "lookupCode": "1", "displayValue": "Display Only First Label" }, "prefixText": "", "suffixText": "" } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets" } ] }
|
Description |
This service returns the metadata for a specific array set of a Model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/arraySets/{arraySetVarName} |
|
|
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 |
|
|
arraySetVarName |
The variable name of an array set |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for a specific array set of a Model |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionsPackage/arraySets/applicationSoftware
{ "id": 36673355, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/_setapplicationSoftware" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/_setapplicationSoftware/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/_setapplicationSoftware/attributes" } ], "refType": 3, "name": "Application Software", "variableName": "_setapplicationSoftware", "desc": "", "sizeAttrId": 36673055, "defaultAttrId": -1, "displayType": { "lookupCode": "1", "displayValue": "Horizontal" }, "labelOption": { "lookupCode": "1", "displayValue": "Display Only First Label" }, "prefixText": "", "suffixText": "" }
Configuration Array Set Attributes Metadata
Get Product Family Array Set Attributes Metadata
|
Description |
This service returns the metadata for all attributes for an array set of a Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/arraySets/{arraySetVarName}/attributes |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
arraySetVarName |
The variable name of an array set |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all attributes for an array set of a Product Family |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/applicationSoftware/attributes
Response Body Sample
Get Product Family Array Set Attribute Metadata
|
Description |
This service returns the metadata for a specific attribute for an array set of a Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
arraySetVarName |
The variable name of an array set |
|
|
attributeVarName |
The variable name of an attribute |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for a specific attribute for an array set of a Product Family |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/applicationSoftware/attributes/softwarePackage_array
{ "id": 36673056, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/applicationSoftware" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/applicationSoftware/attributes/softwarePackage_array/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems" } ], "name": "Software Package", "description": "", "variableName": "softwarePackage_array", "orderNumber": 40, "required": false, "itemLevelProcess": true, "autoLock": false, "hideInTrans": false, "defaultValue": "", "startDate": "", "endDate": "", "additional": { "image_menu_layout": "0" }, "type": { "lookupCode": "1", "displayValue": "Text" }, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "status": { "lookupCode": "1", "displayValue": "Active" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "setType": { "lookupCode": "1", "displayValue": "None" }, "displayType": { "lookupCode": "3", "displayValue": "Single Select Menu" }, "priceItem": { "pricingType": { "lookupCode": "1", "displayValue": "None" }, "pricingDisplayType": { "lookupCode": "1", "displayValue": "None" }, "displayPriceAtBottom": true, "includeInTotalPrice": true }, "potentialStates": ["updatable"], "ajaxSensitive": false, "arrayControlAttr": false, "array": true }
Get Product Line Array Set Attributes Metadata
|
Description |
This service returns the metadata for all attributes for an array set of a Product Line. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/arraySets/{arraySetVarName}/attributes |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
arraySetVarName |
The variable name of an array set |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all attributes for an array set of a Product Line |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes
Response Body Sample
Get Product Line Array Set Attribute Metadata
|
Description |
This service returns the metadata for a specific attribute for an array set of a Product Line. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
arraySetVarName |
The variable name of an array set |
|
|
attributeVarName |
The variable name of an attribute |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for a specific attribute for a Product Line |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array
{ "id": 36673056, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems" } ], "name": "Software Package", "description": "", "variableName": "softwarePackage_array", "orderNumber": 40, "required": false, "itemLevelProcess": true, "autoLock": false, "hideInTrans": false, "defaultValue": "", "startDate": "", "endDate": "", "additional": { "image_menu_layout": "0" }, "type": { "lookupCode": "1", "displayValue": "Text" }, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "status": { "lookupCode": "1", "displayValue": "Active" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "setType": { "lookupCode": "1", "displayValue": "None" }, "displayType": { "lookupCode": "3", "displayValue": "Single Select Menu" }, "priceItem": { "pricingType": { "lookupCode": "1", "displayValue": "None" }, "pricingDisplayType": { "lookupCode": "1", "displayValue": "None" }, "displayPriceAtBottom": true, "includeInTotalPrice": true }, "potentialStates": ["updatable"], "ajaxSensitive": false, "arrayControlAttr": false, "array": true }
Get Model Array Set Attributes Metadata
|
Description |
This service returns the metadata for all attributes for an array set of a Model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/arraySets{arraySetVarName}/attributes |
|
|
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 |
|
|
arraySetVarName |
The variable name of an array set |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all attributes for an array set of a Model |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionsPackage/arraySets/applicationSoftware/attributes
Response Body Sample
Get Model Array Set Attribute Metadata
|
Description |
This service returns the metadata for a specific attribute for an array set of a Model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName} |
|
|
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 |
|
|
arraySetVarName |
The variable name of an array set |
|
|
attributeVarName |
The variable name of an attribute |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for specific attribute for an array set of a Model |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionsPackage/arraySets/applicationSoftware/attributes/softwarePackage_array
{ "id": 36673056, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems" } ], "name": "Software Package", "description": "", "variableName": "softwarePackage_array", "orderNumber": 40, "required": false, "itemLevelProcess": true, "autoLock": false, "hideInTrans": false, "defaultValue": "", "startDate": "", "endDate": "", "additional": { "image_menu_layout": "0" }, "type": { "lookupCode": "1", "displayValue": "Text" }, "category": { "lookupCode": "2", "displayValue": "Configurable Attributes" }, "status": { "lookupCode": "1", "displayValue": "Active" }, "constraintDisplayType": { "lookupCode": "1", "displayValue": "Marked" }, "setType": { "lookupCode": "1", "displayValue": "None" }, "displayType": { "lookupCode": "3", "displayValue": "Single Select Menu" }, "priceItem": { "pricingType": { "lookupCode": "1", "displayValue": "None" }, "pricingDisplayType": { "lookupCode": "1", "displayValue": "None" }, "displayPriceAtBottom": true, "includeInTotalPrice": true }, "potentialStates": ["updatable"], "ajaxSensitive": false, "arrayControlAttr": false, "array": true }
Configuration Attribute Menu Items Metadata
Get Product Family Attribute Menu Items Metadata
|
Description |
This service returns the metadata for all menu items for a specific attribute of a Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/attributes/{attributeVarName}/menuItems |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
attributeVarName |
The variable name of an attribute |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/attributes/operatingSystem_selector/menuItems
Response Body Sample
Get Product Family Attribute Menu Item Metadata
|
Description |
This service returns the metadata for a specific menu item of a specific attribute of a Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/attributes/{attributeVarName}/menuItems/{menuItemId} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
attributeVarName |
The variable name of an attribute |
|
|
menuItemId |
The ID of a menu item | |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673411
{ "id": 36673411, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/attributes/operatingSystem_selector" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673411" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/attributes/operatingSystem_selector/menuItems/36673411/translations" } ], "displayValue": "Blue Hat Enterprise Standard", "value": "Blue Hat Enterprise Standard", "orderNumber": 6 }
Get Product Line Attribute Menu Items Metadata
|
Description |
This service returns the metadata for all menu items for a specific attribute of a Product Line. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes/{attributeVarName}/menuItems |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
attributeVarName |
The variable name of an attribute |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all menu items for a specific attribute of a Product Line |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/attributes/operatingSystem_selector/menuItems
Response Body Sample
Get Product Line Attribute Menu Item Metadata
|
Description |
This service returns the metadata for a specific menu item for an attribute of a Product Line. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes/{attributeVarName}/menuItems/{menuItemId} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
attributeVarName |
The variable name of an attribute |
|
|
menuItemId |
The ID of a menu item | |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for a specific menu item for an attribute of a Product Line |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/attributes/operatingSystem_selector/menuItems/36673411
{ "id": 36673411, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/attributes/operatingSystem_selector" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/attributes/operatingSystem_selector/menuItems/36673411" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/attributes/operatingSystem_selector/menuItems/36673411/translations" } ], "displayValue": "Blue Hat Enterprise Standard", "value": "Blue Hat Enterprise Standard", "orderNumber": 6 }
Get Model Attribute Menu Items Metadata
|
Description |
This service returns the metadata for all menu items for an attribute of a Model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName}/menuItems |
|
|
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 |
|
|
attributeVarName |
The variable name of an attribute |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all menu items for an attribute of a Model |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionsPackage/attributes/operatingSystem_selector/menuItems
Response Body Sample
Get Model Attribute Menu Item Metadata
|
Description |
This service returns the metadata for a specific menu item for an attribute of a Model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName}/menuItems/{menuItemId} |
|
|
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 |
|
|
attributeVarName |
The variable name of an attribute |
|
|
menuItemId |
The ID of a menu item | |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for a specific menu item for an attribute of a Model |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionsPackage/attributes/operatingSystem_selector/menuItems/36673411
{ "id": 36673411, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/attributes/operatingSystem_selector" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/attributes/operatingSystem_selector/menuItems/36673411" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/attributes/operatingSystem_selector/menuItems/36673411/translations" } ], "displayValue": "Blue Hat Enterprise Standard", "value": "Blue Hat Enterprise Standard", "orderNumber": 6 }
Configuration Array Set Attribute Menu Items Metadata
Get Product Family Array Set Attribute Menu Items Metadata
|
Description |
This service returns the metadata for all menu items for an array set attribute of a Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}/menuItems/ |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
arraySetVarName |
The variable name of an array set |
|
|
attributeVarName |
The variable name of an attribute |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all menu items for a array set attribute of a Product Family |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems
Response Body Sample
Get Product Family Array Set Attribute Menu Item Metadata
|
Description |
This service returns the metadata for a specific menu item for an array set attribute of a Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}/menuItems/{menuItemId} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
arraySetVarName |
The variable name of an array set |
|
|
attributeVarName |
The variable name of an attribute |
|
|
menuItemId |
The ID of a menu item | |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for a specific menu item for a array set attribute of a Product Family |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673560
{ "id": 36673560, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673560" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673560/translations" } ], "displayValue": "Enterprise Anti-Virus", "value": "Vision Enterprise Anti-Virus", "orderNumber": 1 }
Get Product Line Array Set Attribute Menu Items Metadata
|
Description |
This service returns the metadata for all menu items for an array set attribute of a Product Line. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}/menuItems |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
arraySetVarName |
The variable name of an array set |
|
|
attributeVarName |
The variable name of an attribute |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all menu items for an array set attribute of a Product Line |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems
{ "items": [{ "id": 36673560, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673560" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673560/translations" } ], "displayValue": "Enterprise Anti-Virus", "value": "Vision Enterprise Anti-Virus", "orderNumber": 1 }, { "id": 36673561, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673561" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673561/translations" } ], "displayValue": "Encrytion Software", "value": "Vision Encrytion Software", "orderNumber": 2 }, { "id": 36673562, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673562" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673562/translations" } ], "displayValue": "Data Management", "value": "Data Management", "orderNumber": 3 }, { "id": 36673563, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673563" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673563/translations" } ], "displayValue": "Data Protection", "value": "Data Protection", "orderNumber": 4 }, { "id": 36673564, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673564" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673564/translations" } ], "displayValue": "Cloud Management", "value": "Cloud Management", "orderNumber": 5 }, { "id": 36673565, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673565" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673565/translations" } ], "displayValue": "Storage Resource Management", "value": "Storage Resource Management", "orderNumber": 6 } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems" } ] }
Get Product Line Array Set Attribute Menu Item Metadata
|
Description |
This service returns the metadata for a specific menu item for an array set attribute of a Product Line. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes/{attributeVarName}/menuItems/{menuItemId} |
|
|
Endpoint Parameters |
prodFamVarName |
The variable name of a Product Family |
|
prodLineVarName |
The variable name of a Product Line |
|
|
arraySetVarName |
The variable name of an array set |
|
|
attributeVarName |
The variable name of an attribute |
|
|
menuItemId |
The ID of a menu item | |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for a specific menu item for an array set attribute of a Product Line |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673560
{ "id": 36673560, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673560" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673560/translations" } ], "displayValue": "Enterprise Anti-Virus", "value": "Vision Enterprise Anti-Virus", "orderNumber": 1 }
Get Model Array Set Attribute Menu Items Metadata
|
Description |
This service returns the metadata for all menu items for an array set attribute of a Model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}/menuItems |
|
|
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 |
|
|
arraySetVarName |
The variable name of an array set |
|
|
attributeVarName |
The variable name of an attribute |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for all menu items for an array set attribute of a Model |
|
https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems
{ "items": [{ "id": 36673560, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673560" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673560/translations" } ], "displayValue": "Enterprise Anti-Virus", "value": "Vision Enterprise Anti-Virus", "orderNumber": 1 }, { "id": 36673561, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673561" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673561/translations" } ], "displayValue": "Encrytion Software", "value": "Vision Encrytion Software", "orderNumber": 2 }, { "id": 36673562, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673562" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673562/translations" } ], "displayValue": "Data Management", "value": "Data Management", "orderNumber": 3 }, { "id": 36673563, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673563" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673563/translations" } ], "displayValue": "Data Protection", "value": "Data Protection", "orderNumber": 4 }, { "id": 36673564, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673564" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673564/translations" } ], "displayValue": "Cloud Management", "value": "Cloud Management", "orderNumber": 5 }, { "id": 36673565, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673565" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673565/translations" } ], "displayValue": "Storage Resource Management", "value": "Storage Resource Management", "orderNumber": 6 } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems" } ] }
Get Model Array Set Attribute Menu Item Metadata
|
Description |
This service returns the metadata for a specific menu item for an array set attribute of a Model. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}//models/{modelVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}/menuItems/{menuItemId} |
|
|
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 |
|
|
arraySetVarName |
The variable name of an array set |
|
|
attributeVarName |
The variable name of an attribute |
|
|
menuItemId |
The ID of a menu item | |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Success Response |
JSON data containing metadata for a specific menu item for an array set attribute of a Model |
|
https://sitename.oracle.com/rest/v7productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673560
{ "id": 36673560, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673560" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/applicationSoftware/attributes/softwarePackage_array/menuItems/36673560/translations" } ], "displayValue": "Enterprise Anti-Virus", "value": "Vision Enterprise Anti-Virus", "orderNumber": 1 }
Configuration Items Metadata
Get Recommended Items Metadata
|
Description |
This action retrieves the metadata defined in the Page Template for the Recommended Items, Mandatory Items, Mandatory Models, Recommended Models and BOM Items. The response includes the Model Template and Parts Template metadata. This endpoint is used in conjunction with the Configure Model (/rest/v17/ This endpoint accepts an optional query parameter language code to retrieve a translation defined in the template. If the language code provided is not defined in the template, the response displays in the site base language |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pageTemplates/recommended_spare_templates |
|
| Endpoint Parameters | None | |
|
HTTP Method |
GET |
|
|
Request Body Parameters |
langcode |
The language code for translation. (Optional) |
|
Response Body Parameters |
modelTemplate |
The model metadata items identified in the Page Template |
|
partsTemplate |
The parts metadata identified in the Page Template |
|
https://sitename.oracle.com/rest/v17/pageTemplates/recommended_spare_templates
URI Endpoint Sample with Language Code (Optional)
https://sitename.oracle.com/rest/v17/pageTemplates/recommended_spare_templates?language=de
