Get Product Family Layout
get
/rest/v19/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:
DescriptionConfiguration flow description -
id:
integer
Title:
IdThe unique identifier for a layout. -
jetItemListDisplay:
string
Title:
JET Item List DisplayJET item list display. -
jetPriceTableDisplay:
string
Title:
JET Price Table DisplayJET price table display. -
links:
object Reference Links
Title:
Reference LinksReference links for the Parent, Self, Children and Related as applicable -
pageTemplate:
object Page Template
Title:
Page TemplatePage template. -
processingType:
string
Title:
Processing TypeProcessing type. -
sequence:
integer
Title:
SequenceOrder Number -
sidebarBehavior:
string
Title:
Sidebar BehaviorSidebar behavior. -
status:
string
Title:
StatusStatus of the configuration flow. -
tabDisplay:
string
Title:
Tab DisplayTab display. -
tabLoadingType:
string
Title:
Tab Loading TypeTab loading type. -
title:
string
Title:
TitleConfiguration flow name. -
translations:
object translations
-
VarName:
string
Title:
Variable NameUnique variable name to identify the configuration flow. -
wizardType:
string
Title:
Wizard TypeWizard type.
Nested Schema : Reference Links
Type:
objectTitle:
Reference LinksReference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
hrefURL to the related object -
rel:
string
Title:
LinkLink relationship to the current object
Nested Schema : Page Template
Type:
objectTitle:
Page TemplatePage template.
Show Source
-
id:
integer
Title:
Page Template IdPage template identifier. -
name:
string
Title:
Page Template NamePage template Name.
Nested Schema : component
Type:
Show Source
object-
autoColWidth:
string
Title:
Auto Column WidthAuto column width. -
autoLock:
boolean
Title:
Auto LockAuto lock indicator. -
autoUpdate:
boolean
Title:
Auto UpdateAuto update indicator. -
backgroundImage:
string
Title:
Background ImageBackground image. -
collapsible:
boolean
Title:
CollapsibleCollapsible indicator. -
colSpan:
string
Title:
Column SpanColumn span. -
columnWidths:
string
Title:
Column WidthsColumn widths. -
components:
object components-collection
-
componentTypeCode:
object Component Type Code
Title:
Component Type CodeComponent type code for a component. -
cssClass:
string
Title:
CSS ClassCSS class. -
defaultValue:
string
Title:
Default ValueDefault value of the attribute. -
defaultValueOverridden:
boolean
Title:
Default Value OverriddenDefault value overridden indicator. -
description:
string
Title:
DescriptionComponent's description. -
displayType:
object displayType
-
displayTypeOverriden:
boolean
Title:
Display Type OverridenDisplay type overriden indicator. -
endDate:
string
Title:
End DateEnd date. -
fieldAlignment:
string
Title:
Field AlignmentField alignment. -
fieldAutoWidth:
string
Title:
Field Auto WidthField auto width. -
group:
boolean
Title:
GroupGroup indicator. -
heading:
string
Title:
HeadingHeading. -
helpIcon:
string
Title:
Help IconHelp icon. -
helpIconAlignment:
string
Title:
Help Icon AlignmentThe help icon alignment. -
helpTextBottom:
string
Title:
Help Text BottomHelp text bottom. -
helpTextTop:
string
Title:
Help Text TopHelp text top. -
hide:
boolean
Title:
HideHide indicator. -
hideLock:
boolean
Title:
Hide LockHide lock indicator. -
id:
integer(int64)
Title:
IdUnique identifier for a component -
inputTypeCode:
object Input Type Code
Title:
Input Type CodeInput type code. -
jetDisplayType:
object jetDisplayType
-
label:
string
Title:
LabelLabel for component. -
labelAlignment:
string
Title:
Label AlignmentLabel alignment. -
labelSeparator:
string
Title:
Label SeparatorLabel separator. -
labelWidth:
string
Title:
Label WidthLabel width. -
labelWidthUnits:
string
Title:
Label Width UnitsLabel width units. - menuImagePosition: string
-
msgPlacement:
string
Title:
Message PlacementMessage placement. -
msgWidth:
string
Title:
Message WidthMessage width. -
msgWidthUnits:
string
Title:
Message Width UnitsMessage width units. -
pricePosition:
string
Title:
Price PositionPrice position. -
required:
boolean
Title:
RequiredRequired indicator. -
resourceAttributeVarName:
string
Title:
Resource Attribute VarNameResource attribute identifier. -
resourceAttrType:
string
Title:
Resource Attribute TypeResource attribute type. -
sequence:
integer
Title:
SequenceOrder number. -
setType:
string
Title:
Set TypeSet type. -
setTypeOverridden:
boolean
Title:
Set Type OverriddenSet type overridden indicator. -
showCalculator:
boolean
Title:
Show CalculatorShow calculator indicator. -
showConMsg:
boolean
Title:
Show Constraint MessageShow constraint message indicator. -
showDataTooltip:
boolean
Title:
Show Data TooltipShow data tooltip. -
showDescription:
boolean
Title:
Show DescriptionShow description indicator. -
showHelpIcon:
boolean
Title:
Show Help IconShow help icon indicator. -
showLabel:
boolean
Title:
Show LabelShow label indicator. -
showMenuImage:
boolean
Title:
Show Menu ImageShow menu image indicator. -
showPrevValueMsg:
boolean
Title:
Show Previous Value MessageShow previous value message indicator. -
showPrice:
boolean
Title:
Show PriceShow price indicator. -
showRecMsg:
boolean
Title:
Show Recommendation MessageShow recommendation message indicator. -
showTitleIcon:
boolean
Title:
Show Title IconShow title icon. -
spacerHeight:
string
Title:
Spacer HeightHeight of the spacer. -
startDate:
string
Title:
Start DateStart date. -
status:
string
Title:
StatusComponent's status. -
title:
string
Title:
TitleComponent's title. -
titleIcon:
string
Title:
Title IconTitle icon. -
translations:
object translations
-
valueAlignment:
string
Title:
Value AlignmentValue alignment. -
valuePosition:
string
Title:
Value PositionValue position. -
valueWidth:
string
Title:
Value WidthValue width. -
valueWidthUnits:
string
Title:
Value Width UnitsValue width unit. -
widthUnits:
string
Title:
Width UnitsWidth units.
Nested Schema : Component Type Code
Type:
objectTitle:
Component Type CodeComponent type code for a component.
Show Source
-
lookupCode:
string
Title:
Lookup CodeLookup Code for a component.
Nested Schema : displayType
Type:
Show Source
object-
displayValue:
string
Title:
Display ValueDisplay value. -
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : Input Type Code
Type:
objectTitle:
Input Type CodeInput type code.
Show Source
-
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : jetDisplayType
Type:
Show Source
object-
displayValue:
string
Title:
Display ValueDisplay value. -
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : translation
Type:
Show Source
object-
description:
string
Title:
DescriptionDescription -
label:
string
Title:
LabelLabel -
language:
object Language
Title:
LanguageLanguage -
title:
string
Title:
TitleTitle
Nested Schema : Language
Type:
objectTitle:
LanguageLanguage
Show Source
-
languageCode:
string
Title:
Language CodeTranslation Language Code -
languageNumber:
integer
Title:
Language NumberTranslation 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 -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/productFamilies/vision/layouts/serverFamilyFlow
Response Body Sample
{
"id": 36701967,
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/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"
}
}