page_design

Layout of a store page. Contains information used by the store to render the page.

Handler Class:

com.ibm.commerce.rest.pagelayout.handler.PageDesignHandler

Method Summary

HTTP MethodPathDescription
GET/store/{storeId}/page_design?q={q}Finds page designs by a query. See each query for details on input and output.
GET/store/{storeId}/page_design?q=byLayoutActivityIdFinds a page design by a layout activity ID.
GET/store/{storeId}/page_design?q=byLayoutIdFinds a page design by its layout ID.
GET/store/{storeId}/page_design?q=byObjectIdentifierFinds a page design by the primary object on a page.

Method Details

GET /store/{storeId}/page_design?q={q}

Finds page designs by a query. See each query for details on input and output.

Handler Method:

findByQuery

Secure Call Mandatory:

false

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
qThe query name.querystringtruefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
500Internal server error. Additional details will be contained on the server logs.

GET /store/{storeId}/page_design?q=byLayoutActivityId

Finds a page design by a layout activity ID.

Handler Method:

byLayoutActivityId

Secure Call Mandatory:

false

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
qThe query name.querystringtruefalse
layoutActivityIdThe layout activity ID.querystringtruefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

page_design-IBM_Store_Summary

Example

Request:
GET /wcs/previewresources/store/10001/page_design?q=byLayoutActivityId&layoutActivityId=10180&catalogId=10052&langId=-1&responseFormat=json
HTTP Status Code:

200

Response:
{
	"resourceId": "https:\/\/localhost:8006\/wcs\/previewresources\/store\/10001\/page_design?q=byLayoutActivityId&layoutActivityId=10180&catalogId=10052&langId=-1&responseFormat=json",
	"resourceName": "page_design",
	"resultList": [
		{
			"layoutId": "10101",
			"layoutName": "HomePageHardwareLayout"
		}
	]
}

GET /store/{storeId}/page_design?q=byLayoutId

Finds a page design by its layout ID.

Handler Method:

byLayoutId

Secure Call Mandatory:

false

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
qThe query name.querystringtruefalse
layoutIdThe layout ID.querystringtruefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

page_design-IBM_Store_Summary

Example

Request:
GET /wcs/resources/store/10001/page_design?q=byLayoutId&layoutId=10102&profileName=IBM_Store_Details
HTTP Status Code:

200

Response:
{
	"resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/page_design?q=byLayoutId&layoutId=10102&profileName=IBM_Store_Details",
	"resourceName": "page_design",
	"resultList": [
		{
			"layoutId": "10102",
			"layoutName": "HomePageLayout"
		}
	]
}

GET /store/{storeId}/page_design?q=byObjectIdentifier

Finds a page design by the primary object on a page.

Handler Method:

byObjectIdentifier

Secure Call Mandatory:

false

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
qThe query name.querystringtruefalse
objectIdentifierThe object identifier.querystringtruefalse
deviceClassThe device class.querystringtruefalse
pageGroupThe page group.querystringtruefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

page_design-IBM_Store_Details

Example

Request:
GET /wcs/resources/store/10001/page_design?pageGroup=Content&q=byObjectIdentifier&deviceClass=Web&catalogId=10052&objectIdentifier=1008&langId=-1&responseFormat=json
HTTP Status Code:

200

Response:
{
	"resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/page_design?pageGroup=Content&q=byObjectIdentifier&deviceClass=Web&catalogId=10052&objectIdentifier=1008&langId=-1&responseFormat=json",
	"resourceName": "page_design",
	"resultList": [
		{
			"layoutId": "10102",
			"layoutName": "HomePageLayout",
			"objectIdentifier": "1008",
			"pageGroup": "Content",
			"widget": {
				"childWidget": [
					{
						"name": "HeaderLeftBannerContentWidget",
						"slot": {
							"internalSlotId": "1"
						},
						"widgetDefinitionId": "-2012",
						"widgetDefinitionIdentifier": "EMarketingSpot_701",
						"widgetDefinitionStoreId": "0",
						"widgetId": "1461",
						"widgetProperty": [
							{
								"name": "emsName",
								"sequenceOrder": 0.0,
								"value": "HeaderBanner_Content_Left"
							},
							{
								"name": "emsType",
								"sequenceOrder": 0.0,
								"value": "global"
							},
							{
								"name": "widgetOrientation",
								"sequenceOrder": 0.0,
								"value": "horizontal"
							},
							{
								"name": "displayPreference",
								"sequenceOrder": 0.0,
								"value": "1"
							},
							{
								"name": "showFeed",
								"sequenceOrder": 0.0,
								"value": "false"
							}
						],
						"widgetSequence": 0.0
					},
					{
						"name": "HeaderRightBannerContentWidget",
						"slot": {
							"internalSlotId": "2"
						},
						"widgetDefinitionId": "-2012",
						"widgetDefinitionIdentifier": "EMarketingSpot_701",
						"widgetDefinitionStoreId": "0",
						"widgetId": "1462",
						"widgetProperty": [
							{
								"name": "emsName",
								"sequenceOrder": 0.0,
								"value": "HeaderBanner_Content_Right"
							},
							{
								"name": "emsType",
								"sequenceOrder": 0.0,
								"value": "global"
							},
							{
								"name": "widgetOrientation",
								"sequenceOrder": 0.0,
								"value": "horizontal"
							},
							{
								"name": "displayPreference",
								"sequenceOrder": 0.0,
								"value": "1"
							},
							{
								"name": "showFeed",
								"sequenceOrder": 0.0,
								"value": "false"
							}
						],
						"widgetSequence": 0.0
					},
					{
						"name": "HomePageMainESpot",
						"slot": {
							"internalSlotId": "3"
						},
						"widgetDefinitionId": "-2003",
						"widgetDefinitionIdentifier": "ContentCarousel_701",
						"widgetDefinitionStoreId": "0",
						"widgetId": "1463",
						"widgetProperty": [
							{
								"name": "emsId",
								"sequenceOrder": 0.0,
								"value": "10559"
							},
							{
								"name": "emsName",
								"sequenceOrder": 0.0,
								"value": "HomeRow1_Content"
							},
							{
								"name": "ribbonImageType",
								"sequenceOrder": 0.0,
								"value": "dot"
							}
						],
						"widgetSequence": 0.0
					},
					{
						"name": "CategoryRecommendationWidget",
						"slot": {
							"internalSlotId": "4"
						},
						"widgetDefinitionId": "-2012",
						"widgetDefinitionIdentifier": "EMarketingSpot_701",
						"widgetDefinitionStoreId": "0",
						"widgetId": "1464",
						"widgetProperty": [
							{
								"name": "emsName",
								"sequenceOrder": 0.0,
								"value": "HomeRow2_Categories"
							},
							{
								"name": "emsType",
								"sequenceOrder": 0.0,
								"value": "global"
							},
							{
								"name": "widgetOrientation",
								"sequenceOrder": 0.0,
								"value": "horizontal"
							},
							{
								"name": "displayPreference",
								"sequenceOrder": 0.0,
								"value": "2"
							},
							{
								"name": "showFeed",
								"sequenceOrder": 0.0,
								"value": "false"
							}
						],
						"widgetSequence": 0.0
					},
					{
						"name": "HomePageCenterAdWidget1",
						"slot": {
							"internalSlotId": "4"
						},
						"widgetDefinitionId": "-2000",
						"widgetDefinitionIdentifier": "ContentRecommendation_701",
						"widgetDefinitionStoreId": "0",
						"widgetId": "1465",
						"widgetProperty": [
							{
								"name": "emsId",
								"sequenceOrder": 0.0,
								"value": "10563"
							},
							{
								"name": "emsName",
								"sequenceOrder": 0.0,
								"value": "HomeCenterRow1_Content"
							},
							{
								"name": "widgetOrientation",
								"sequenceOrder": 0.0,
								"value": "horizontal"
							},
							{
								"name": "displayPreference",
								"sequenceOrder": 0.0,
								"value": "1"
							},
							{
								"name": "showFeed",
								"sequenceOrder": 0.0,
								"value": "false"
							}
						],
						"widgetSequence": 1.0
					},
					{
						"name": "HomePageCenterAdWidget2",
						"slot": {
							"internalSlotId": "4"
						},
						"widgetDefinitionId": "-2000",
						"widgetDefinitionIdentifier": "ContentRecommendation_701",
						"widgetDefinitionStoreId": "0",
						"widgetId": "1466",
						"widgetProperty": [
							{
								"name": "emsId",
								"sequenceOrder": 0.0,
								"value": "10564"
							},
							{
								"name": "emsName",
								"sequenceOrder": 0.0,
								"value": "HomeCenterRow2_Content"
							},
							{
								"name": "widgetOrientation",
								"sequenceOrder": 0.0,
								"value": "horizontal"
							},
							{
								"name": "displayPreference",
								"sequenceOrder": 0.0,
								"value": "1"
							},
							{
								"name": "showFeed",
								"sequenceOrder": 0.0,
								"value": "false"
							}
						],
						"widgetSequence": 2.0
					},
					{
						"name": "HomePageBottomLeftWidget",
						"slot": {
							"internalSlotId": "6"
						},
						"widgetDefinitionId": "-2000",
						"widgetDefinitionIdentifier": "ContentRecommendation_701",
						"widgetDefinitionStoreId": "0",
						"widgetId": "1467",
						"widgetProperty": [
							{
								"name": "emsId",
								"sequenceOrder": 0.0,
								"value": "10560"
							},
							{
								"name": "emsName",
								"sequenceOrder": 0.0,
								"value": "HomeBottomLeft_Content"
							},
							{
								"name": "widgetOrientation",
								"sequenceOrder": 0.0,
								"value": "horizontal"
							},
							{
								"name": "displayPreference",
								"sequenceOrder": 0.0,
								"value": "1"
							},
							{
								"name": "showFeed",
								"sequenceOrder": 0.0,
								"value": "false"
							}
						],
						"widgetSequence": 0.0
					},
					{
						"name": "HomePageBottomCenterWidget",
						"slot": {
							"internalSlotId": "7"
						},
						"widgetDefinitionId": "-2000",
						"widgetDefinitionIdentifier": "ContentRecommendation_701",
						"widgetDefinitionStoreId": "0",
						"widgetId": "1468",
						"widgetProperty": [
							{
								"name": "emsId",
								"sequenceOrder": 0.0,
								"value": "10561"
							},
							{
								"name": "emsName",
								"sequenceOrder": 0.0,
								"value": "HomeBottomCenter_Content"
							},
							{
								"name": "widgetOrientation",
								"sequenceOrder": 0.0,
								"value": "horizontal"
							},
							{
								"name": "displayPreference",
								"sequenceOrder": 0.0,
								"value": "1"
							},
							{
								"name": "showFeed",
								"sequenceOrder": 0.0,
								"value": "false"
							}
						],
						"widgetSequence": 0.0
					},
					{
						"name": "HomePageBottomRightWidget",
						"slot": {
							"internalSlotId": "8"
						},
						"widgetDefinitionId": "-2000",
						"widgetDefinitionIdentifier": "ContentRecommendation_701",
						"widgetDefinitionStoreId": "0",
						"widgetId": "1469",
						"widgetProperty": [
							{
								"name": "emsId",
								"sequenceOrder": 0.0,
								"value": "10562"
							},
							{
								"name": "emsName",
								"sequenceOrder": 0.0,
								"value": "HomeBottomRight_Content"
							},
							{
								"name": "widgetOrientation",
								"sequenceOrder": 0.0,
								"value": "horizontal"
							},
							{
								"name": "displayPreference",
								"sequenceOrder": 0.0,
								"value": "1"
							},
							{
								"name": "showFeed",
								"sequenceOrder": 0.0,
								"value": "false"
							}
						],
						"widgetSequence": 0.0
					}
				],
				"name": "HomePageContainer",
				"slot": {
				},
				"widgetDefinitionId": "1001",
				"widgetDefinitionIdentifier": "HomePageContainer",
				"widgetDefinitionStoreId": "10001",
				"widgetId": "1252",
				"widgetSequence": 0.0
			}
		}
	]
}

Data Type Details

page_design-IBM_Store_Details

Properties:
NameData TypeRequired
resultListpage_design-IBM_Store_Details_item arrayfalse

page_design-IBM_Store_Details_item

Properties:
NameData TypeRequired
pageGroupstringfalse
deviceClassstringfalse
widgetstringfalse
layoutIdstringfalse
layoutNamestringfalse
userDataFieldpage_design-IBM_Store_Details_item.userDataField arrayfalse
objectIdentifierstringfalse
previewReportstring arrayfalse

page_design-IBM_Store_Details_item.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

page_design-IBM_Store_Summary

Properties:
NameData TypeRequired
resultListpage_design-IBM_Store_Summary_item arrayfalse

page_design-IBM_Store_Summary_item

Properties:
NameData TypeRequired
pageGroupstringfalse
deviceClassstringfalse
layoutNamestringfalse
layoutIdstringfalse
userDataFieldpage_design-IBM_Store_Summary_item.userDataField arrayfalse

page_design-IBM_Store_Summary_item.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

page_design-Slot

Properties:
NameData TypeRequired
internalSlotIdstringfalse

page_design-Widget

Properties:
NameData TypeRequired
childWidgetpage_design-Widget arrayfalse
widgetDefinitionIdentifierstringfalse
widgetDefinitionIdstringfalse
widgetDefinitionStoreIdstringfalse
widgetSequencestringfalse
userDataFieldpage_design-Widget.userDataField arrayfalse
widgetPropertypage_design-WidgetProperty arrayfalse
namestringfalse
slotstringfalse
widgetIdstringfalse

page_design-Widget.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

page_design-WidgetProperty

Properties:
NameData TypeRequired
valuestringfalse
userDataFieldpage_design-WidgetProperty.userDataField arrayfalse
namestringfalse
storeIdstringfalse
sequenceOrderstringfalse

page_design-WidgetProperty.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue
Related reference:
WebSphere Commerce REST API