Get Document Layout
get
/rest/v19/commerceProcesses/{processVarName}/layouts/{mainDocVarName}
Transaction Layout Service returns CPQ transaction desktop layout definitions for UI frameworks to consume. The desktop layout definition contains - Layout parameters and properties for panels, tabs, columns, action strips, and transaction line grids - Properties for actions and attributes - Translations for layout items.
Request
Supported Media Types
- application/json
Path Parameters
-
mainDocVarName(required): string
The offset of the page. By default, offset is 0, which means first page will be returned.
-
processVarName(required): string
Allows to specify one or more filtering criteria. By default, no filtering is applied.
Response
Supported Media Types
- application/json
Default Response
Root Schema : Commerce Process Layout
Type:
Show Source
object-
categoryCode:
string
Title:
Category CodeThe Category Code for the Layout -
components:
object components-collection
-
description:
string
Title:
DescriptionLayout Description - Only For Alta Responsive Layout -
id:
integer
Title:
IdThe unique identifier for a layout -
internalSpecification:
string
Title:
Internal SpecificationThe Internal Specification for the Layout -
name:
string
Title:
NameLayout's label -
parameters:
object parameter
-
title:
string
Title:
TitleDocument's label -
translations:
object translations
-
variableName:
string
Title:
Variable NameLayout variable name
Nested Schema : parameter
Type:
Show Source
object-
dataType:
object Data Type
Title:
Data TypeParameter Data Type -
defaultValue:
null
Title:
Default ValueParameter Default Value -
internalFlag:
string
Title:
Internal FlagParameter Internal Flag -
mandatoryFlag:
string
Title:
Mandatory FlagParameter Mandatory Flag -
name:
string
Title:
NameParameter 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 : Data Type
Type:
objectTitle:
Data TypeParameter Data Type
Show Source
-
lookupCode:
string
Title:
Lookup CodeParameter Data Type Lookup Code
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 desktop layout definition for a specific Commerce process 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/commerceProcesses/oraclecpqo/layouts/transaction