Get Product Line Layout
get
/rest/v19/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/layouts/{layoutVarName}
This action returns the desktop layout metadata for a Product Line.
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.
-
prodLineVarName(required): string
Unique variable name to identify the product line.
Response
Default Response
Product Line 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:
array links
-
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 : links
Type:
Show Source
array-
Array of:
object reference links
Title:
reference linksReference links for the Parent, Self, Children and Related as applicable
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-
allowReorderColumns:
string
Title:
Allow reorder columnsAllow reorder columns - Only For Alta Responsive Layout -
autoColWidth:
string
Title:
AutoCol WidthAuto adjust the column width - Only For Legacy Desktop Layout -
buttonLayout:
string
Title:
Button LayoutButton Layout -
collapsed:
string
Title:
CollapsedCollapsed Property Indicator -
collapseLabel:
string
Title:
Collapse LabelCollapse Label Indicator -
collapsible:
string
Title:
CollapsibleCollapsible Property Indicator -
colMappingType:
string
Title:
Column Mapping TypeColumn Mapping Type -
columnGroup:
string
Title:
Column GroupColumn Group - Only For Alta Responsive Layout -
columnHeader:
string
Title:
Column HeaderColumn Header -
components:
object components-collection
-
componentTypeCode:
object Component Type Code
Title:
Component Type CodeThe Component Type Code for a component -
defaultColumnWidth:
string
Title:
Default Column WidthDefault width of column - Only For Legacy Desktop Layout -
description:
string
Title:
DescriptionDescription -
displayAddAdhocItem:
string
Title:
Display Add Adhoc ItemDisplay Add Adhoc Item -
displayAddFromCatalog:
string
Title:
Display AddFromCatalogDisplay AddFromCatalog - Only For Legacy Desktop Layout -
displayAutoSum:
string
Title:
Display Auto SumDisplay Auto Sum -
displayDataTooltip:
string
Title:
Display Data TooltipDisplay Data Tooltip -
displayInCopyLinePopup:
string
Title:
Display In CopyLine PopupDisplay In CopyLine Popup -
displayRows:
integer
Title:
Display RowsRow display indicator -
displayType:
string
Title:
Display TypeDisplay Type -
editableFlag:
string
Title:
Editable FlagEditable Flag -
enableHelpText:
string
Title:
Enable Help TextEnable Help Text Indicator -
fieldAlignment:
string
Title:
Field AlignmentField Alignment -
fieldHAlignment:
string
Title:
FieldHAlignmentHorizontal field alignment -
fieldVAlignment:
string
Title:
FieldVAlignmentVertical field alignment -
fieldWidth:
string
Title:
Field WidthField Width -
fieldWidthType:
string
Title:
Field Width TypeType of field width -
groupId:
string
Title:
Group IdGroup Identifier -
hideForModels:
string
Title:
Hide For ModelsHide For Models Indicator -
hideForParts:
string
Title:
Hide For PartsHide For Parts Indicator -
hideForSelectedSegments:
object Hide for selected Segments
Title:
Hide for selected SegmentsHide for selected Segments Indicator -
hideLabelFlag:
string
Title:
Hide Label FlagHide Label Indicator -
hidingBehavior:
string
Title:
Hiding BehaviorHiding Behavior -
id:
integer
Title:
IdThe unique identifier for a component -
inputTypeCode:
object Input Type Code
Title:
Input Type CodeInput Type Code -
invokeReconfigurationType:
string
Title:
Invoke Reconfiguration TypeInvoke Reconfiguration Type -
isHeaderSticky:
string
Title:
Is Header StickySticky header indicator -
itemClsName:
string
Title:
Item Class NameItem Class Name -
keyValue:
string
Title:
Key ValueKey Value for the component -
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 -
LineItemCopyToFavType:
string
Title:
Line Item Copy To FavTypeLine Item Copy To FavType -
lineItemCopyType:
string
Title:
Line Item Copy TypeLine Item Copy Type -
lineItemDeletionType:
string
Title:
Line Item DeletionTypeLine Item DeletionType -
lineItemDisplayType:
string
Title:
Line Item Display TypeLine Item Display Type -
linkToLineDetails:
string
Title:
Link to Line DetailsLink to Line Details - Only For Alta Responsive Layout -
messageTarget:
string
Title:
MessageTargetTarget message -
numOfCols:
string
Title:
NumOfColsNumber Of Columns -
operations:
object Operations
Title:
OperationsThe possible Operations for the component -
overrideWidth:
string
Title:
Override WidthOverride the width - Only For Legacy Desktop Layout -
padding:
string
Title:
PaddingPadding -
pagingSource:
string
Title:
Paging SourcePaging Source - Only For Legacy Desktop Layout -
plainDisplay:
string
Title:
Plain DisplayPlain Display Property -
preloadedRows:
integer
Title:
Preloaded RowsPreloaded Rows - Only For Alta Responsive Layout -
resourceAttributeVarName:
string
Title:
Resource Attribute VarNameResource Attribute identifier -
resourceAttrType:
string
Title:
Resource Attribute TypeResource Attribute Type -
resourceVariableName:
object Resource Variable Name
Title:
Resource Variable NameResource Variable Name for a component -
sequence:
integer
Title:
SequenceOrder Number -
showDataTooltip:
string
Title:
Show Data TooltipShow Data Tooltip -
showLabel:
string
Title:
Show LabelShow Label Indicator -
showModelSubtotals:
string
Title:
Show subtotalsShow subtotals - Only For Alta Responsive Layout -
spacerHeight:
string
Title:
Spacer HeightSpacer Height -
subDocAttrMapping:
array subDocAttrMapping
-
summary:
string
Title:
Table SummaryTable Summary - Only For Alta Responsive Layout -
tabDisplay:
string
Title:
Tab DisplayTab Display Direction - Only For Alta Responsive Layout -
textAlign:
string
Title:
Text AlignText Align -
title:
string
Title:
TitleThe Component Title -
translations:
object translations
-
valueAlignment:
string
Title:
Value AlignmentValue Alignment -
valueWidth:
string
Title:
Value WidthValue Width -
variableName:
string
Title:
Variable NameVariable Name -
widthType:
string
Title:
Width TypeWidth Type -
widthUnits:
string
Title:
Width UnitsWidth Units
Nested Schema : Component Type Code
Type:
objectTitle:
Component Type CodeThe Component Type Code for a component
Show Source
-
lookupCode:
string
Title:
Lookup CodeLookupCode for a component
Nested Schema : Hide for selected Segments
Type:
objectTitle:
Hide for selected SegmentsHide for selected Segments Indicator
Show Source
Nested Schema : Input Type Code
Type:
objectTitle:
Input Type CodeInput Type Code
Show Source
-
lookupCode:
string
Title:
Lookup CodeLookup Code
Nested Schema : Operations
Type:
objectTitle:
OperationsThe possible Operations for the component
Show Source
Nested Schema : Resource Variable Name
Type:
objectTitle:
Resource Variable NameResource Variable Name for a component
Show Source
-
variableName:
string
Title:
Variable NameVariable Name for the Resource in a component
Nested Schema : items
Type:
Show Source
array-
Array of:
integer
Title:
Mapped SegmentIdMapped SegmentId
Nested Schema : operation
Type:
Show Source
object-
id:
integer
Title:
IdOperation Id -
operationType:
object operationType
-
operationVariableName:
string
Title:
Operation Variable NameOperation Variable Name -
operationVariableType:
string
Title:
Operation Variable TypeOperation Variable Type -
resourceVariableName:
object Resource Variable Name
Title:
Resource Variable NameResource Variable Name
Nested Schema : operationType
Type:
Show Source
object-
lookupCode:
string
Title:
lookupCodeOperation lookupCode
Nested Schema : Resource Variable Name
Type:
objectTitle:
Resource Variable NameResource Variable Name
Show Source
-
variableName:
string
Title:
Variable NameResource Variable Name
Nested Schema : subDocAttrMappingObj
Type:
Show Source
object-
columnAttibuteMapping:
string
Title:
Column Attribute MappingColumn Attribute Mapping -
resourceAttributeVarName:
string
Title:
Resource Attribute Variable NameResource Attribute Variable Name -
subDocAttrId:
integer
Title:
Sub Document Attribute IdSub Document Attribute Id -
subDocId:
integer
Title:
Sub Document IdSub Document Id
Nested Schema : reference links
Type:
objectTitle:
reference linksReference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
URL to the related objectURL to the related object -
rel:
string
Title:
Link Relationship to the current objectLink Relationship to the current object
Nested Schema : translation
Type:
Show Source
object-
columnHeader:
string
Title:
Column HeaderColumn Header -
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
-
id:
integer
Title:
IdTranslation Id -
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/productLines/Servers/layouts/serverFamilyFlow
Response Body Sample
{
"id": 36701967,
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/productLines/Servers/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"
}
}