PageLayout: Page Noun

The Page noun is used to represent a URL (or page) on a site. A page contains information such as an administrative name, a page URL and SEO meta properties.

BOD Summary

Access Profile and Expression Builder columns are for Get BOD only.
BOD Action Code / Access Profile Action Expression Service Provided Sample XML Message Client Library / Expression Builder
ProcessPage Create /Page[i] Creates a new page entry in the database.
A create page operation should be followed by a ChangePage service to set the SEO properties and SEO URL of the page.
You can use this action to create the following fields:
  • Name
 Request
Response

PageLayoutFacadeClient.processPage(ProcessPageType)
Delete /Page[i] Deletes a page entry in the database.
Calling this service triggers a ChangePage service that uses a Delete action to remove the associated SEO URL and properties.
 Request
Response

PageLayoutFacadeClient.processPage(ProcessPageType)
ChangePage Add /Page[1]/SEOProperties[1] Changes a page to add SEO details that are locale-dependent.
You can use this action to add the following fields:
  • Title
  • MetaDescription
  • MetaKeyword
 Request
Response

PageLayoutFacadeClient.changePage(ChangePageType)
Add /Page[1]/SEOURL[1] Changes a page to add a SEO URL.
You can use this action to add the following locale-dependent fields:
  • Keyword
 Request
Response

PageLayoutFacadeClient.changePage(ChangePageType)
Change /Page[1] Updates page properties such as the administrative name of the page.
You can use this action to change the following fields:
  • Name
 Request
Response

PageLayoutFacadeClient.changePage(ChangePageType)
Change /Page[1]/SEOProperties[1] Changes page SEO properties including the page title, meta description and meta keyword.
You can use this action to change the following locale-dependent fields:
  • Title
  • MetaDescription
  • MetaKeyword
 Request
Response

PageLayoutFacadeClient.changePage(ChangePageType)
Change /Page[1]/SEOURL[1] Changes the SEO URL for a page.
You can use this action to change the following locale-dependent fields:
  • Keyword
 Request
Response

PageLayoutFacadeClient.changePage(ChangePageType)
Delete /Page[1]/SEOProperties[1] Changes a page to remove the SEO associations including the page URL, title, meta description and meta keyword.
 Request
Response

PageLayoutFacadeClient.changePage(ChangePageType)
GetPage IBM_Store_Summary IBM_Admin_Summary IBM_Admin_Details /Page[PageIdentifier[(UniqueID=$pageId$)]] Gets page information using the unique ID of the page. Request
Response

getPage
IBM_Store_Summary IBM_Admin_Summary IBM_Admin_Details /Page[PageIdentifier[(UniqueID=)]] Gets a list of pages given a list of page unique IDs. Request
Response

fetchPagesById
IBM_Admin_Summary IBM_Admin_Details /Page[search(PageIdentifier/ExternalIdentifier/Name='$searchText$')] Searches for pages by name in the current store. Request
Response

searchPagesByName
IBM_Store_Summary /Page[PageIdentifier[ExternalIdentifier[(Name=)]]] Gets a page by name. Request
Response

fetchPagesByNamesForStore
IBM_Admin_Summary IBM_Admin_Details /Page Gets all pages in the current store. Request
Response

fetchAllPages
IBM_Admin_Summary IBM_Admin_Details /Page[@pageGroup='$pageGroup$'] Gets all pages in the current store by a specified page group.
 Request
Response

fetchPagesByPageGroup
IBM_Store_Summary /Page[@urlConfigurable='$isUrlConfigurable$'] Gets all content pages for the current store.
Some content pages can have configurable URLs while other pages do not have configurable URLs. For example, a content page that does not allow the URL to be configured is the home page.
@urlConfigurable indicates if the page allows a configurable URL or not. The value can be 'true' or 'false'. 		Request
Response

fetchAllURLConfigurablePages

Access Profile

Some sample XML request and response web service messages are provided for each noun. These sample messages might not include all properties or attributes. To view a sample message that includes other properties or attributes, enable logging and tracing for the appropriate component and then call the web service to set or change the properties or attributes. Review the corresponding log file to see the request or response information.

Access Profile Data Returned
IBM_Store_Summary
  • /Page(@deletable @nameEditable @pageGroup @urlConfigurable)
  • /Page/PageIdentifier/UniqueID
  • /Page/PageIdentifier/ExternalIdentifier(@ownerID)
  • /Page/PageIdentifier/ExternalIdentifier(@ownerID)/Name
  • /Page/PageIdentifier/ExternalIdentifier(@ownerID)/StoreIdentifier/UniqueID
 This access profile is designed for store pages and returns the minimal information needed about a page.
IBM_Admin_Details IBM_Store_Summary
+ 		This access profile is designed for the Commerce Composer business tool and returns details about the page.
IBM_Admin_Details IBM_Store_Summary
+
  • /Page/SEOURL/URLKeywordID
  • /Page/SEOURL/TokenValue
  • /Page/SEOURL/Usage
  • /Page/SEOURL/ParentStoreIdentifier/UniqueID
  • /Page/SEOURL/ParentStoreIdentifier/ExternalIdentifier(@ownerID)
  • /Page/SEOURL/URLKeyword(@language)
  • /Page/SEOURL/URLKeyword(@language)/GeneratedKeyword
  • /Page/SEOURL/URLKeyword(@language)/GeneratedMobileKeyword
  • /Page/SEOURL/URLKeyword(@language)/Keyword
  • /Page/SEOURL/URLKeyword(@language)/MobileKeyword
  • /Page/SEOURL/URLKeyword(@language)/URLPrefix
  • /Page/SEOURL/URLKeyword(@language)/MobileURLPrefix
  • /Page/SEOURL/URLKeyword(@language)/PreviewURL
  • /Page/SEOURL/URLKeyword(@language)/PreviewMobileURL
  • /Page/SEOURL/SiteMapInfo/Priority
  • /Page/SEOURL/SiteMapInfo/ChangeFrequency
  • /Page/SEOURL/SiteMapInfo/MobilePriority
  • /Page/SEOURL/SiteMapInfo/MobileChangeFrequency
  • /Page/SEOProperties(@language @pageGroup @resolved)
  • /Page/SEOProperties/SEOPageDefID
  • /Page/SEOProperties/ObjectIdentifier
  • /Page/SEOProperties/Title
  • /Page/SEOProperties/MetaDescription
  • /Page/SEOProperties/MetaKeyword
  • /Page/SEOProperties/FullImageAltDescription
  • /Page/SEOProperties/ParentStoreIdentifier/UniqueID
  • /Page/SEOProperties/ParentStoreIdentifier/ExternalIdentifier(@ownerID)
 This access profile is designed for the Commerce Composer business tool. This profile returns the detailed information about a page including the SEO data.

XSD files