SapccApiGetPageWithUserRequest
Request parameters for getPageWithUser operation in SapccApi. SapccApiGetPageWithUserRequest
interface SapccApiGetPageWithUserRequest {
readonly baseSiteId: string;
readonly code?: string;
readonly fields?: GetPageWithUserFieldsEnum;
readonly pageId?: string;
readonly pageLabel?: string;
readonly pageLabelOrId?: string;
readonly pageType?: GetPageWithUserPageTypeEnum;
readonly userId: string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
baseSiteId | Required | string | Base site identifier {string} SapccApiGetPageWithUser |
code | Optional | string | Page code. Examples: homepage, electronics, cameras, 585. {string} SapccApiGetPageWithUser |
fields | Optional | GetPageWithUserFieldsEnum | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL. {'BASIC' | 'DEFAULT' | 'FULL'} SapccApiGetPageWithUser |
pageId | Optional | string | Page id. When pageId is provided, pageLabelOrId will be ignored. {string} SapccApiGetPageWithUser |
pageLabel | Optional | string | Page label. If no page has a label that matches the page label exactly, try to find pages whose label starts with a section of the page label. Note: URL encoding on the page label should be applied when the label contains special characters. When pageLabel is provided, pageLabelOrId will be ignored. {string} SapccApiGetPageWithUser |
pageLabelOrId | Optional | string | Page Label or Id. If no page has a label that matches the page label exactly, try to find pages whose label starts with a section of the page label. Otherwise, try to find the page by id. When label and ID values can match, passing in the pageId parameter may result in obtaining variation pages with the same pageLabel but different pageId. Therefore, it is advisable to use both the pageId and pageLabel parameters to ensure accuracy.Note: URL encoding on the page label should be applied when the label contains special characters. {string} SapccApiGetPageWithUser |
pageType | Optional | GetPageWithUserPageTypeEnum | Page type {'ContentPage' | 'ProductPage' | 'CategoryPage' | 'CatalogPage'} SapccApiGetPageWithUser |
userId | Required | string | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user {string} SapccApiGetPageWithUser |