Get Document Layout
get
/rest/v7/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: string
The offset of the page. By default, offset is 0, which means first page will be returned.
-
processVarName: 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(optional):
string
Title:
Category CodeThe Category Code for the Layout -
components(optional):
object components-collection
-
description(optional):
string
Title:
DescriptionLayout Description - Only For Alta Responsive Layout -
id(optional):
integer
Title:
IdThe unique identifier for a layout -
internalSpecification(optional):
string
Title:
Internal SpecificationThe Internal Specification for the Layout -
name(optional):
string
Title:
NameLayout's label -
parameters(optional):
object parameter
-
title(optional):
string
Title:
TitleDocument's label -
translations(optional):
object translations
-
variableName(optional):
string
Title:
Variable NameLayout variable name
Nested Schema : parameter
Type:
Show Source
object-
dataType(optional):
object Data Type
Title:
Data TypeParameter Data Type -
defaultValue(optional):
null
Title:
Default ValueParameter Default Value -
internalFlag(optional):
string
Title:
Internal FlagParameter Internal Flag -
mandatoryFlag(optional):
string
Title:
Mandatory FlagParameter Mandatory Flag -
name(optional):
string
Title:
NameParameter Name
Nested Schema : component
Type:
Show Source
object-
allowReorderColumns(optional):
string
Title:
Allow reorder columnsAllow reorder columns - Only For Alta Responsive Layout -
autoColWidth(optional):
string
Title:
AutoCol WidthAuto adjust the column width - Only For Legacy Desktop Layout -
buttonLayout(optional):
string
Title:
Button LayoutButton Layout -
collapsed(optional):
string
Title:
CollapsedCollapsed Property Indicator -
collapseLabel(optional):
string
Title:
Collapse LabelCollapse Label Indicator -
collapsible(optional):
string
Title:
CollapsibleCollapsible Property Indicator -
colMappingType(optional):
string
Title:
Column Mapping TypeColumn Mapping Type -
columnGroup(optional):
string
Title:
Column GroupColumn Group - Only For Alta Responsive Layout -
columnHeader(optional):
string
Title:
Column HeaderColumn Header -
components(optional):
object components-collection
-
componentTypeCode(optional):
object Component Type Code
Title:
Component Type CodeThe Component Type Code for a component -
defaultColumnWidth(optional):
string
Title:
Default Column WidthDefault width of column - Only For Legacy Desktop Layout -
description(optional):
string
Title:
DescriptionDescription -
displayAddAdhocItem(optional):
string
Title:
Display Add Adhoc ItemDisplay Add Adhoc Item -
displayAddFromCatalog(optional):
string
Title:
Display AddFromCatalogDisplay AddFromCatalog - Only For Legacy Desktop Layout -
displayAutoSum(optional):
string
Title:
Display Auto SumDisplay Auto Sum -
displayDataTooltip(optional):
string
Title:
Display Data TooltipDisplay Data Tooltip -
displayInCopyLinePopup(optional):
string
Title:
Display In CopyLine PopupDisplay In CopyLine Popup -
displayRows(optional):
integer
Title:
Display RowsRow display indicator -
displayType(optional):
string
Title:
Display TypeDisplay Type -
editableFlag(optional):
string
Title:
Editable FlagEditable Flag -
enableHelpText(optional):
string
Title:
Enable Help TextEnable Help Text Indicator -
fieldAlignment(optional):
string
Title:
Field AlignmentField Alignment -
fieldHAlignment(optional):
string
Title:
FieldHAlignmentHorizontal field alignment -
fieldVAlignment(optional):
string
Title:
FieldVAlignmentVertical field alignment -
fieldWidth(optional):
string
Title:
Field WidthField Width -
fieldWidthType(optional):
string
Title:
Field Width TypeType of field width -
groupId(optional):
string
Title:
Group IdGroup Identifier -
hideForModels(optional):
string
Title:
Hide For ModelsHide For Models Indicator -
hideForParts(optional):
string
Title:
Hide For PartsHide For Parts Indicator -
hideForSelectedSegments(optional):
object Hide for selected Segments
Title:
Hide for selected SegmentsHide for selected Segments Indicator -
hideLabelFlag(optional):
string
Title:
Hide Label FlagHide Label Indicator -
hidingBehavior(optional):
string
Title:
Hiding BehaviorHiding Behavior -
id(optional):
integer
Title:
IdThe unique identifier for a component -
inputTypeCode(optional):
object Input Type Code
Title:
Input Type CodeInput Type Code -
invokeReconfigurationType(optional):
string
Title:
Invoke Reconfiguration TypeInvoke Reconfiguration Type -
isHeaderSticky(optional):
string
Title:
Is Header StickySticky header indicator -
itemClsName(optional):
string
Title:
Item Class NameItem Class Name -
keyValue(optional):
string
Title:
Key ValueKey Value for the component -
label(optional):
string
Title:
LabelLabel for component -
labelAlignment(optional):
string
Title:
Label AlignmentLabel Alignment -
labelSeparator(optional):
string
Title:
Label SeparatorLabel Separator -
labelWidth(optional):
string
Title:
Label WidthLabel Width -
labelWidthUnits(optional):
string
Title:
Label Width UnitsLabel Width Units -
LineItemCopyToFavType(optional):
string
Title:
Line Item Copy To FavTypeLine Item Copy To FavType -
lineItemCopyType(optional):
string
Title:
Line Item Copy TypeLine Item Copy Type -
lineItemDeletionType(optional):
string
Title:
Line Item DeletionTypeLine Item DeletionType -
lineItemDisplayType(optional):
string
Title:
Line Item Display TypeLine Item Display Type -
linkToLineDetails(optional):
string
Title:
Link to Line DetailsLink to Line Details - Only For Alta Responsive Layout -
messageTarget(optional):
string
Title:
MessageTargetTarget message -
numOfCols(optional):
string
Title:
NumOfColsNumber Of Columns -
operations(optional):
object Operations
Title:
OperationsThe possible Operations for the component -
overrideWidth(optional):
string
Title:
Override WidthOverride the width - Only For Legacy Desktop Layout -
padding(optional):
string
Title:
PaddingPadding -
pagingSource(optional):
string
Title:
Paging SourcePaging Source - Only For Legacy Desktop Layout -
plainDisplay(optional):
string
Title:
Plain DisplayPlain Display Property -
preloadedRows(optional):
integer
Title:
Preloaded RowsPreloaded Rows - Only For Alta Responsive Layout -
resourceAttributeVarName(optional):
string
Title:
Resource Attribute VarNameResource Attribute identifier -
resourceAttrType(optional):
string
Title:
Resource Attribute TypeResource Attribute Type -
resourceVariableName(optional):
object Resource Variable Name
Title:
Resource Variable NameResource Variable Name for a component -
sequence(optional):
integer
Title:
SequenceOrder Number -
showDataTooltip(optional):
string
Title:
Show Data TooltipShow Data Tooltip -
showLabel(optional):
string
Title:
Show LabelShow Label Indicator -
showModelSubtotals(optional):
string
Title:
Show subtotalsShow subtotals - Only For Alta Responsive Layout -
spacerHeight(optional):
string
Title:
Spacer HeightSpacer Height -
subDocAttrMapping(optional):
array subDocAttrMapping
-
summary(optional):
string
Title:
Table SummaryTable Summary - Only For Alta Responsive Layout -
tabDisplay(optional):
string
Title:
Tab DisplayTab Display Direction - Only For Alta Responsive Layout -
textAlign(optional):
string
Title:
Text AlignText Align -
title(optional):
string
Title:
TitleThe Component Title -
translations(optional):
object translations
-
valueAlignment(optional):
string
Title:
Value AlignmentValue Alignment -
valueWidth(optional):
string
Title:
Value WidthValue Width -
variableName(optional):
string
Title:
Variable NameVariable Name -
widthType(optional):
string
Title:
Width TypeWidth Type -
widthUnits(optional):
string
Title:
Width UnitsWidth Units
Nested Schema : Component Type Code
Type:
objectTitle:
Component Type CodeThe Component Type Code for a component
Show Source
-
lookupCode(optional):
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(optional):
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(optional):
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(optional):
integer
Title:
IdOperation Id -
operationType(optional):
object operationType
-
operationVariableName(optional):
string
Title:
Operation Variable NameOperation Variable Name -
operationVariableType(optional):
string
Title:
Operation Variable TypeOperation Variable Type -
resourceVariableName(optional):
object Resource Variable Name
Title:
Resource Variable NameResource Variable Name
Nested Schema : operationType
Type:
Show Source
object-
lookupCode(optional):
string
Title:
lookupCodeOperation lookupCode
Nested Schema : Resource Variable Name
Type:
objectTitle:
Resource Variable NameResource Variable Name
Show Source
-
variableName(optional):
string
Title:
Variable NameResource Variable Name
Nested Schema : subDocAttrMappingObj
Type:
Show Source
object-
columnAttibuteMapping(optional):
string
Title:
Column Attribute MappingColumn Attribute Mapping -
resourceAttributeVarName(optional):
string
Title:
Resource Attribute Variable NameResource Attribute Variable Name -
subDocAttrId(optional):
integer
Title:
Sub Document Attribute IdSub Document Attribute Id -
subDocId(optional):
integer
Title:
Sub Document IdSub Document Id
Nested Schema : Data Type
Type:
objectTitle:
Data TypeParameter Data Type
Show Source
-
lookupCode(optional):
string
Title:
Lookup CodeParameter Data Type Lookup Code
Nested Schema : translation
Type:
Show Source
object-
columnHeader(optional):
string
Title:
Column HeaderColumn Header -
description(optional):
string
Title:
DescriptionDescription -
label(optional):
string
Title:
LabelLabel -
language(optional):
object Language
Title:
LanguageLanguage -
title(optional):
string
Title:
TitleTitle
Nested Schema : Language
Type:
objectTitle:
LanguageLanguage
Show Source
-
id(optional):
integer
Title:
IdTranslation Id -
languageCode(optional):
string
Title:
Language CodeTranslation Language Code -
languageNumber(optional):
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 - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/layouts/transaction