Layout of a store page. Contains information used by the store to render the page.
com.ibm.commerce.rest.pagelayout.handler.PageDesignHandler
HTTP Method | Path | Description |
---|---|---|
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=byLayoutActivityId | Finds a page design by a layout activity ID. |
GET | /store/{storeId}/page_design?q=byLayoutId | Finds a page design by its layout ID. |
GET | /store/{storeId}/page_design?q=byObjectIdentifier | Finds a page design by the primary object on a page. |
Finds page designs by a query. See each query for details on input and output.
findByQuery
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
Finds a page design by a layout activity ID.
byLayoutActivityId
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
layoutActivityId | The layout activity ID. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/previewresources/store/10001/page_design?q=byLayoutActivityId&layoutActivityId=10180&catalogId=10052&langId=-1&responseFormat=json
200
{ "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" } ] }
Finds a page design by its layout ID.
byLayoutId
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
layoutId | The layout ID. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10001/page_design?q=byLayoutId&layoutId=10102&profileName=IBM_Store_Details
200
{ "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" } ] }
Finds a page design by the primary object on a page.
byObjectIdentifier
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
objectIdentifier | The object identifier. | query | string | true | false |
deviceClass | The device class. | query | string | true | false |
pageGroup | The page group. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10001/page_design?pageGroup=Content&q=byObjectIdentifier&deviceClass=Web&catalogId=10052&objectIdentifier=1008&langId=-1&responseFormat=json
200
{ "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 } } ] }
Name | Data Type | Required |
---|---|---|
resultList | page_design-IBM_Store_Details_item array | false |
Name | Data Type | Required |
---|---|---|
pageGroup | string | false |
deviceClass | string | false |
widget | string | false |
layoutId | string | false |
layoutName | string | false |
userDataField | page_design-IBM_Store_Details_item.userDataField array | false |
objectIdentifier | string | false |
previewReport | string array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
resultList | page_design-IBM_Store_Summary_item array | false |
Name | Data Type | Required |
---|---|---|
pageGroup | string | false |
deviceClass | string | false |
layoutName | string | false |
layoutId | string | false |
userDataField | page_design-IBM_Store_Summary_item.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
internalSlotId | string | false |
Name | Data Type | Required |
---|---|---|
childWidget | page_design-Widget array | false |
widgetDefinitionIdentifier | string | false |
widgetDefinitionId | string | false |
widgetDefinitionStoreId | string | false |
widgetSequence | string | false |
userDataField | page_design-Widget.userDataField array | false |
widgetProperty | page_design-WidgetProperty array | false |
name | string | false |
slot | string | false |
widgetId | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
userDataField | page_design-WidgetProperty.userDataField array | false |
name | string | false |
storeId | string | false |
sequenceOrder | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |