A store page. Contains information on the page such as SEO meta data.
com.ibm.commerce.rest.pagelayout.handler.PageHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/page?q={q} | Finds pages by a query. See each query for details on input and output. |
GET | /store/{storeId}/page?q=byCatalogEntryIds | Finds pages by catalog entry IDs. Invalid catalog entry IDs are ignored. |
GET | /store/{storeId}/page?q=byCategoryIds | Finds pages by category IDs. Invalid category IDs are ignored. |
GET | /store/{storeId}/page?q=byNames | Finds pages by their names. Invalid page names are ignored. |
GET | /store/{storeId}/page?q=byPageIds | Finds pages by their IDs. Invalid page IDs are ignored. |
GET | /store/{storeId}/page?q=byUrlConfigurable | Finds content pages with or without configurable URLs. |
GET | /store/{storeId}/page/{pageId} | Finds a page by its ID. |
GET | /store/{storeId}/page/name/{name} | Finds a page by its name. |
Finds pages 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 pages by catalog entry IDs. Invalid catalog entry IDs are ignored.
byCatalogEntryIds
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 |
catalogEntryId | The catalog entry ID. | query | string | true | true |
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?q=byCatalogEntryIds&catalogEntryId=12836&langId=-1&responseFormat=json
200
{ "recordSetComplete": true, "recordSetCount": 1, "recordSetStartNumber": 0, "recordSetTotal": 1, "resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/page?q=byCatalogEntryIds&catalogEntryId=12836&langId=-1&responseFormat=json", "resourceName": "page", "resultList": [ { "catalogEntryId": "12836", "fullImageAltDescription": "Image for StyleHome Modern Rimmed 3 Piece Sofa Set from Aurora", "metaDescription": "3 piece sofa set with a very modern design.", "metaKeyword": " StyleHome", "partNumber": "HFU032_3201", "title": "StyleHome Modern Rimmed 3 Piece Sofa Set | Aurora" } ] }
Finds pages by category IDs. Invalid category IDs are ignored.
byCategoryIds
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 |
categoryId | The category ID. | query | string | true | true |
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?q=byCategoryIds&categoryId=10043&langId=-1&responseFormat=json
200
{ "recordSetComplete": true, "recordSetCount": 1, "recordSetStartNumber": 0, "recordSetTotal": 1, "resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/page?q=byCategoryIds&categoryId=10043&langId=-1&responseFormat=json", "resourceName": "page", "resultList": [ { "categoryId": "10043", "categoryIdentifier": "Furniture", "fullImageAltDescription": "Image for Furniture from Aurora", "metaDescription": "Furniture", "metaKeyword": "Furniture", "title": "Furniture | Aurora" } ] }
Finds pages by their names. Invalid page names are ignored.
byNames
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 |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | 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?q=byNames&name=HelpPage&name=ContactUsPage&name=PrivacyPolicyPage&name=ReturnPolicyPage&name=CorporateContactUsPage&name=CorporateInfoPage&name=SiteMapPage&responseFormat=json
200
{ "recordSetComplete": true, "recordSetCount": 7, "recordSetStartNumber": 0, "recordSetTotal": 7, "resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/page?q=byNames&name=HelpPage&name=ContactUsPage&name=PrivacyPolicyPage&name=ReturnPolicyPage&name=CorporateContactUsPage&name=CorporateInfoPage&name=SiteMapPage&responseFormat=json", "resourceName": "page", "resultList": [ { "deletable": false, "name": "ContactUsPage", "nameEditable": false, "pageGroup": "Content", "pageId": "1002", "urlConfigurable": true }, { "deletable": false, "name": "CorporateContactUsPage", "nameEditable": false, "pageGroup": "Content", "pageId": "1006", "urlConfigurable": true }, { "deletable": false, "name": "CorporateInfoPage", "nameEditable": false, "pageGroup": "Content", "pageId": "1005", "urlConfigurable": true }, { "deletable": false, "name": "HelpPage", "nameEditable": false, "pageGroup": "Content", "pageId": "1001", "urlConfigurable": true }, { "deletable": false, "name": "PrivacyPolicyPage", "nameEditable": false, "pageGroup": "Content", "pageId": "1004", "urlConfigurable": true }, { "deletable": false, "name": "ReturnPolicyPage", "nameEditable": false, "pageGroup": "Content", "pageId": "1003", "urlConfigurable": true }, { "deletable": false, "name": "SiteMapPage", "nameEditable": false, "pageGroup": "Content", "pageId": "1007", "urlConfigurable": true } ] }
Finds pages by their IDs. Invalid page IDs are ignored.
byPageIds
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 |
pageId | The page ID. | query | string | true | true |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | 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?pageId=1001&pageId=1002&q=byPageIds
200
{ "recordSetComplete": true, "recordSetCount": 2, "recordSetStartNumber": 0, "recordSetTotal": 2, "resourceId": "https:\/\/localhost:8006\/wcs\/previewresources\/store\/10001\/page?pageId=1001&pageId=1002&q=byPageIds", "resourceName": "page", "resultList": [ { "deletable": false, "name": "ContactUsPage", "nameEditable": false, "pageGroup": "Content", "pageId": "1002", "urlConfigurable": true }, { "deletable": false, "name": "HelpPage", "nameEditable": false, "pageGroup": "Content", "pageId": "1001", "urlConfigurable": true } ] }
Finds content pages with or without configurable URLs.
byUrlConfigurable
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 |
urlConfigurable | Whether the URL of the page is configurable. | query | boolean | true | false |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | integer | false | false |
pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | integer | false | 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?q=byUrlConfigurable&urlConfigurable=false
200
{ "recordSetComplete": true, "recordSetCount": 1, "recordSetStartNumber": 0, "recordSetTotal": 1, "resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/page?q=byUrlConfigurable&urlConfigurable=false", "resourceName": "page", "resultList": [ { "deletable": false, "name": "HomePage", "nameEditable": false, "pageGroup": "Content", "pageId": "1008", "urlConfigurable": false } ] }
Finds a page by its ID.
findByPageId
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
pageId | The page ID. | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | 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. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10001/page/1001
200
{ "recordSetComplete": true, "recordSetCount": 1, "recordSetStartNumber": 0, "recordSetTotal": 1, "resourceId": "https:\/\/localhost:8006\/wcs\/previewresources\/store\/10001\/page\/1001", "resourceName": "page", "resultList": [ { "deletable": false, "name": "HelpPage", "nameEditable": false, "pageGroup": "Content", "pageId": "1001", "urlConfigurable": true } ] }
Finds a page by its name.
findByName
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | 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. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10001/page/name/HomePage?profileName=IBM_Store_Details&langId=-1&responseFormat=json
200
{ "recordSetComplete": true, "recordSetCount": 1, "recordSetStartNumber": 0, "recordSetTotal": 1, "resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/page\/name\/HomePage?profileName=IBM_Store_Details&langId=-1&responseFormat=json", "resourceName": "page", "resultList": [ { "deletable": false, "fullImageAltDescription": "Image for Aurora home page", "metaDescription": "Shop Aurora online. Commerce Model Store entity", "metaKeyword": "Aurora Commerce Model Store entity", "name": "HomePage", "nameEditable": false, "pageGroup": "Content", "pageId": "1008", "title": "Welcome to Aurora", "urlConfigurable": false } ] }
Name | Data Type | Required |
---|---|---|
metaKeyword | string | false |
catalogEntryId | string | false |
userDataField | page-CatalogEntryView.userDataField array | false |
metaDescription | string | false |
title | string | false |
partNumber | string | true |
fullImageAltDescription | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
metaKeyword | string | false |
userDataField | page-CatalogGroupView.userDataField array | false |
metaDescription | string | false |
categoryIdentifier | string | false |
title | string | false |
categoryId | string | false |
fullImageAltDescription | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
recordSetTotal | string | false |
recordSetComplete | string | false |
recordSetStartNumber | string | false |
resultList | page-IBM_Store_Details_item array | false |
recordSetCount | string | false |
Name | Data Type | Required |
---|---|---|
pageGroup | string | false |
metaKeyword | string | false |
deletable | string | false |
userDataField | page-IBM_Store_Details_item.userDataField array | false |
metaDescription | string | false |
urlConfigurable | string | false |
title | string | false |
pageId | string | false |
name | string | false |
nameEditable | string | false |
fullImageAltDescription | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
recordSetTotal | string | false |
recordSetComplete | string | false |
recordSetStartNumber | string | false |
resultList | page-CatalogGroupView array | false |
recordSetCount | string | false |
Name | Data Type | Required |
---|---|---|
recordSetTotal | string | false |
recordSetComplete | string | false |
recordSetStartNumber | string | false |
resultList | page-CatalogEntryView array | false |
recordSetCount | string | false |