Get Product Family Layout
get
/rest/v16/productFamilies/{prodFamVarName}/layouts/{layoutVarName}
This action returns the desktop layout metadata for a Product Family.
Request
Path Parameters
-
layoutVarName(required): string
Unique variable name to identify the configuration flow.
-
prodFamVarName(required): string
Unique variable name to identify the product family.
Response
Default Response
Product Family Layout
Root Schema : config-layout-response
Type:
Show Source
object
-
components:
object components-collection
-
description:
string
Title:
Description
Configuration flow description -
id:
integer
Title:
Id
The unique identifier for a layout. -
jetItemListDisplay:
string
Title:
JET Item List Display
JET item list display. -
jetPriceTableDisplay:
string
Title:
JET Price Table Display
JET price table display. -
links:
object Reference Links
Title:
Reference Links
Reference links for the Parent, Self, Children and Related as applicable -
pageTemplate:
object Page Template
Title:
Page Template
Page template. -
processingType:
string
Title:
Processing Type
Processing type. -
sequence:
integer
Title:
Sequence
Order Number -
sidebarBehavior:
string
Title:
Sidebar Behavior
Sidebar behavior. -
status:
string
Title:
Status
Status of the configuration flow. -
tabDisplay:
string
Title:
Tab Display
Tab display. -
tabLoadingType:
string
Title:
Tab Loading Type
Tab loading type. -
title:
string
Title:
Title
Configuration flow name. -
translations:
object translations
-
VarName:
string
Title:
Variable Name
Unique variable name to identify the configuration flow. -
wizardType:
string
Title:
Wizard Type
Wizard type.
Nested Schema : Reference Links
Type:
object
Title:
Reference Links
Reference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
href
URL to the related object -
rel:
string
Title:
Link
Link relationship to the current object
Nested Schema : Page Template
Type:
object
Title:
Page Template
Page template.
Show Source
-
id:
integer
Title:
Page Template Id
Page template identifier. -
name:
string
Title:
Page Template Name
Page template Name.
Nested Schema : component
Type:
Show Source
object
-
autoColWidth:
string
Title:
Auto Column Width
Auto column width. -
autoLock:
boolean
Title:
Auto Lock
Auto lock indicator. -
autoUpdate:
boolean
Title:
Auto Update
Auto update indicator. -
backgroundImage:
string
Title:
Background Image
Background image. -
collapsible:
boolean
Title:
Collapsible
Collapsible indicator. -
colSpan:
string
Title:
Column Span
Column span. -
columnWidths:
string
Title:
Column Widths
Column widths. -
components:
object components-collection
-
componentTypeCode:
object Component Type Code
Title:
Component Type Code
Component type code for a component. -
cssClass:
string
Title:
CSS Class
CSS class. -
defaultValue:
string
Title:
Default Value
Default value. -
defaultValueOverridden:
boolean
Title:
Default Value Overridden
Default value overridden indicator. -
description:
string
Title:
Description
Component's description. -
displayType:
object displayType
-
displayTypeOverriden:
boolean
Title:
Display Type Overriden
Display type overriden indicator. -
endDate:
string
Title:
End Date
End date. -
fieldAlignment:
string
Title:
Field Alignment
Field alignment. -
fieldAutoWidth:
string
Title:
Field Auto Width
Field auto width. -
group:
boolean
Title:
Group
Group indicator. -
heading:
string
Title:
Heading
Heading. -
helpIcon:
string
Title:
Help Icon
Help icon. -
helpIconAlignment:
string
Title:
Help Icon Alignment
The help icon alignment. -
helpTextBottom:
string
Title:
Help Text Bottom
Help text bottom. -
helpTextTop:
string
Title:
Help Text Top
Help text top. -
hide:
boolean
Title:
Hide
Hide indicator. -
hideLock:
boolean
Title:
Hide Lock
Hide lock indicator. -
id:
integer(int64)
Title:
Id
Unique identifier for a component -
inputTypeCode:
object Input Type Code
Title:
Input Type Code
Input type code. -
jetDisplayType:
object jetDisplayType
-
label:
string
Title:
Label
Label for component. -
labelAlignment:
string
Title:
Label Alignment
Label alignment. -
labelSeparator:
string
Title:
Label Separator
Label separator. -
labelWidth:
string
Title:
Label Width
Label width. -
labelWidthUnits:
string
Title:
Label Width Units
Label width units. - menuImagePosition: string
-
msgPlacement:
string
Title:
Message Placement
Message placement. -
msgWidth:
string
Title:
Message Width
Message width. -
msgWidthUnits:
string
Title:
Message Width Units
Message width units. -
pricePosition:
string
Title:
Price Position
Price position. -
required:
boolean
Title:
Required
Required indicator. -
resourceAttributeVarName:
string
Title:
Resource Attribute VarName
Resource attribute identifier. -
resourceAttrType:
string
Title:
Resource Attribute Type
Resource attribute type. -
sequence:
integer
Title:
Sequence
Order number. -
setType:
string
Title:
Set Type
Set type. -
setTypeOverridden:
boolean
Title:
Set Type Overridden
Set type overridden indicator. -
showCalculator:
boolean
Title:
Show Calculator
Show calculator indicator. -
showConMsg:
boolean
Title:
Show Constraint Message
Show constraint message indicator. -
showDataTooltip:
boolean
Title:
Show Data Tooltip
Show data tooltip. -
showDescription:
boolean
Title:
Show Description
Show description indicator. -
showHelpIcon:
boolean
Title:
Show Help Icon
Show help icon indicator. -
showLabel:
boolean
Title:
Show Label
Show label indicator. -
showMenuImage:
boolean
Title:
Show Menu Image
Show menu image indicator. -
showPrevValueMsg:
boolean
Title:
Show Previous Value Message
Show previous value message indicator. -
showPrice:
boolean
Title:
Show Price
Show price indicator. -
showRecMsg:
boolean
Title:
Show Recommendation Message
Show recommendation message indicator. -
showTitleIcon:
boolean
Title:
Show Title Icon
Show title icon. -
spacerHeight:
string
Title:
Spacer Height
Height of the spacer. -
startDate:
string
Title:
Start Date
Start date. -
status:
string
Title:
Status
Component's status. -
title:
string
Title:
Title
Component's title. -
titleIcon:
string
Title:
Title Icon
Title icon. -
translations:
object translations
-
valueAlignment:
string
Title:
Value Alignment
Value alignment. -
valuePosition:
string
Title:
Value Position
Value position. -
valueWidth:
string
Title:
Value Width
Value width. -
valueWidthUnits:
string
Title:
Value Width Units
Value width unit. -
widthUnits:
string
Title:
Width Units
Width units.
Nested Schema : Component Type Code
Type:
object
Title:
Component Type Code
Component type code for a component.
Show Source
-
lookupCode:
string
Title:
Lookup Code
Lookup Code for a component.
Nested Schema : displayType
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
Display value. -
lookupCode:
string
Title:
Lookup Code
Lookup code.
Nested Schema : Input Type Code
Type:
object
Title:
Input Type Code
Input type code.
Show Source
-
lookupCode:
string
Title:
Lookup Code
Lookup code.
Nested Schema : jetDisplayType
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
Display value. -
lookupCode:
string
Title:
Lookup Code
Lookup code.
Nested Schema : translation
Type:
Show Source
object
-
description:
string
Title:
Description
Description -
label:
string
Title:
Label
Label -
language:
object Language
Title:
Language
Language -
title:
string
Title:
Title
Title
Nested Schema : Language
Type:
object
Title:
Language
Language
Show Source
-
languageCode:
string
Title:
Language Code
Translation Language Code -
languageNumber:
integer
Title:
Language Number
Translation Language Number
Examples
The following example shows how to retrieve the metadata for the specified Configuration item by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/productFamilies/vision/layouts/serverFamilyFlow
Response Body Sample
{ "id": 36701967, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/layouts/serverFamilyFlow" } ], "components": { "items": [{ "id": 1544186855121, "components": { "items": [{ "id": 36701972, "components": { "items": [{ "id": 36701974, "components": { "items": [{ "id": 36701979, "components": { "items": [{ "id": 36701980, "components": { "items": [{ "id": 36701993, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "sequence": 1, "resourceAttrType": "Text", "resourceAttributeVarName": "operatingSystem_selector", "inputTypeCode": { "lookupCode": "Single Select Menu" }, "showLabel": true, "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "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": "All Operating Systems", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "required": true, "defaultValueOverridden": false, "setTypeOverridden": false, "displayTypeOverridden": false }, { "id": 36702027, "componentTypeCode": { "lookupCode": "SPACER" }, "sequence": 2, "spacerHeight": "25" } ] }, "componentTypeCode": { "lookupCode": "PANEL_COL" }, "sequence": 1, "colSpan": "1" } ] }, "componentTypeCode": { "lookupCode": "PANEL_ROW" }, "sequence": 1 } ] }, "translations": { "items": [{ "language": { "languageCode": "en", "languageNumber": -1 }, "title": "Operating System", "description": "Operating System" } ] }, "componentTypeCode": { "lookupCode": "PANEL" }, "sequence": 1, "fieldAlignment": "LEFT_ALIGN", "showTitleIcon": true, "collapsible": false, "showDescription": false, "showLabel": true, "columnWidths": "100.0", "autoColWidth": "true", "widthUnits": "PERCENTAGE_WIDTH", "title": "Operating System", "description": "Operating System", "group": true }, { "id": 36702029, "components": { "items": [{ "id": 36702039, "components": { "items": [{ "id": 36702040, "components": { "items": [{ "id": 36702042, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "sequence": 1, "resourceAttrType": "Text", "resourceAttributeVarName": "serverChassis_selector", "inputTypeCode": { "lookupCode": "Single Select Menu" }, "showLabel": true, "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "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": "All Systems", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "required": true, "defaultValueOverridden": false, "setTypeOverridden": false, "displayTypeOverridden": false }, { "id": 36702076, "componentTypeCode": { "lookupCode": "SPACER" }, "sequence": 2, "spacerHeight": "25" } ] }, "componentTypeCode": { "lookupCode": "PANEL_COL" }, "sequence": 1, "colSpan": "1" } ] }, "componentTypeCode": { "lookupCode": "PANEL_ROW" }, "sequence": 1 } ] }, "translations": { "items": [{ "language": { "languageCode": "en", "languageNumber": -1 }, "title": "System Server Chassis", "description": "System Server Chassis" } ] }, "componentTypeCode": { "lookupCode": "PANEL" }, "sequence": 2, "fieldAlignment": "LEFT_ALIGN", "showTitleIcon": true, "collapsible": true, "showDescription": true, "showLabel": true, "columnWidths": "100.0", "autoColWidth": "true", "widthUnits": "PERCENTAGE_WIDTH", "title": "System Server Chassis", "description": "System Server Chassis", "group": true }, { "id": 36702078, "components": { "items": [{ "id": 36702088, "components": { "items": [{ "id": 36702089, "components": { "items": [{ "id": 36702091, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "sequence": 1, "resourceAttrType": "Text", "resourceAttributeVarName": "formFactor_selector", "inputTypeCode": { "lookupCode": "Single Select Menu" }, "showLabel": true, "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "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": "All Form Factors", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "required": true, "defaultValueOverridden": false, "setTypeOverridden": false, "displayTypeOverridden": false }, { "id": 36702125, "componentTypeCode": { "lookupCode": "SPACER" }, "sequence": 2, "spacerHeight": "25" } ] }, "componentTypeCode": { "lookupCode": "PANEL_COL" }, "sequence": 1, "colSpan": "1" } ] }, "componentTypeCode": { "lookupCode": "PANEL_ROW" }, "sequence": 1 } ] }, "translations": { "items": [{ "language": { "languageCode": "en", "languageNumber": -1 }, "title": "Form Factor" } ] }, "componentTypeCode": { "lookupCode": "PANEL" }, "sequence": 3, "fieldAlignment": "LEFT_ALIGN", "showTitleIcon": false, "collapsible": false, "showDescription": false, "showLabel": false, "columnWidths": "100.0", "autoColWidth": "true", "widthUnits": "PERCENTAGE_WIDTH", "title": "Form Factor", "description": "", "group": true }, { "id": 36702127, "components": { "items": [{ "id": 36702137, "components": { "items": [{ "id": 36702138, "components": { "items": [{ "id": 36702140, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "sequence": 1, "resourceAttrType": "Text", "resourceAttributeVarName": "processors_selector", "inputTypeCode": { "lookupCode": "Single Select Menu" }, "showLabel": true, "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "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": "All Processors", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "menuImagePosition": "RIGHT_OF_VALUE", "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "pricePosition": "RIGHT_OF_VALUE", "required": true, "defaultValueOverridden": false, "setTypeOverridden": false, "displayTypeOverridden": false } ] }, "componentTypeCode": { "lookupCode": "PANEL_COL" }, "sequence": 1, "colSpan": "1" }, { "id": 36702174, "components": { "items": [{ "id": 36702176, "componentTypeCode": { "lookupCode": "FORM_CONTROL" }, "sequence": 1, "resourceAttrType": "Integer", "resourceAttributeVarName": "_bm_model_ht_model_cores", "inputTypeCode": { "lookupCode": "Text" }, "showLabel": true, "labelSeparator": "", "labelAlignment": "LEFT_ALIGN", "labelWidth": "33.0", "labelWidthUnits": "PERCENTAGE_WIDTH", "valuePosition": "RIGHT_ALIGN", "valueWidth": "47.0", "valueWidthUnits": "PERCENTAGE_WIDTH", "valueAlignment": "LEFT_ALIGN", "showHelpIcon": false, "hideLock": false, "showCalculator": false, "showRecMsg": false, "showConMsg": false, "showPrevValueMsg": false, "setType": "None", "defaultValue": "", "autoLock": false, "autoUpdate": false, "hide": false, "showDataTooltip": false, "showMenuImage": false, "fieldAutoWidth": "true", "showPrice": false, "required": false, "defaultValueOverridden": false, "setTypeOverridden": false, "displayTypeOverridden": false } ] }, "componentTypeCode": { "lookupCode": "PANEL_COL" }, "sequence": 2, "colSpan": "1" } ] }, "componentTypeCode": { "lookupCode": "PANEL_ROW" }, "sequence": 1 } ] }, "translations": { "items": [{ "language": { "languageCode": "en", "languageNumber": -1 }, "title": "Processor And Cores", "description": "2 Columns Grid" } ] }, "componentTypeCode": { "lookupCode": "PANEL" }, "sequence": 4, "fieldAlignment": "LEFT_ALIGN", "showTitleIcon": false, "collapsible": false, "showDescription": true, "showLabel": false, "columnWidths": "50.0~50.0", "autoColWidth": "true", "widthUnits": "PERCENTAGE_WIDTH", "title": "Processor And Cores", "description": "2 Columns Grid", "group": true } ] }, "translations": { "items": [{ "language": { "languageCode": "en", "languageNumber": -1 }, "title": "Server Tab", "description": "Default tab" } ] }, "componentTypeCode": { "lookupCode": "PANEL_TAB" }, "sequence": 1, "title": "Server Tab", "description": "Default tab", "status": "active", "startDate": "2018-12-06 18:30:00", "endDate": "2018-12-07 18:29:00" } ] }, "componentTypeCode": { "lookupCode": "PANEL" }, "sequence": 1 } ] }, "translations": { "items": [{ "language": { "languageCode": "en", "languageNumber": -1 }, "title": "ServerFamilyFlow", "description": "" } ] }, "sequence": 0, "title": "ServerFamilyFlow", "variableName": "serverFamilyFlow", "description": "", "status": "Active", "wizardType": "StartEndNode", "processingType": "Action", "tabLoadingType": "LOAD_ALL_TABS", "pageTemplate": { "id": -1, "name": "Default" } }