Get Document Layout
get
/rest/v16/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-
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. -
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 : 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-
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 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/v16/commerceProcesses/oraclecpqo/layouts/transaction