Retrieve all slot descriptors
get
/ccadmin/v1/slotDescriptors
Retrieves all Slot Descriptors.
Slot Descriptors simply represent the types of Slots available in Oracle Commerce Cloud, where a Slot is an area of variable content within a page layout.
Examples include:
- Content Variation Slot - This allows content to change based on date, time and audience segment
- Experiment Slot - Used to test effectiveness of different content
- Role-based slot - Used to display different content to different user roles in the Preview Environment
This endpoint takes an optional parameter pageType which, when specified, allows the results to be filtered by 'page type'.
Note: When using the pageType parameter you can also include slots available to all page layouts by including the includeSlotsAvailableToAll parameter.
Request
Supported Media Types
- application/json
Query Parameters
-
includeSlotsAvailableToAll(optional): boolean
If using pagetype, include slots which are available to all.Default Value:
false
-
pageType(optional): string
Page type to filter slot descriptor by availability.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getAllSlotDescriptors_response
Type:
Show Source
object
-
autoWrap(optional):
boolean
description of autoWrap
-
items(optional):
array items
Array of slot types, optionally filtered by page type
Nested Schema : items
Type:
Show Source
object
-
availableToAllPages(optional):
boolean
Whether or not this slot type is available to all page types
-
configurable(optional):
boolean
Whether or not this slot type has configuration properties
-
displayName(optional):
string
Localised name for this slot type
-
id(optional):
string
ID for this slot type
-
isLatestVersion(optional):
boolean
Whether or not this is the latest verison of this slot type
-
latestVersion(optional):
integer
Latest version of this slot type
-
minWidth(optional):
integer
Minimum number of columns, in layout grid, that this slot type fits into
-
pageTypes(optional):
array pageTypes
Array of page types that this slot type can be added to. Will be empty if availableToAllPages is true.
-
regions(optional):
array regions
Default sub-regions for this slot type
-
repositoryId(optional):
string
ID for the slot type in the repository
-
slotType(optional):
string
The type name for this slot type
-
version(optional):
integer
The version of the slot type
Nested Schema : pageTypes
Type:
array
Array of page types that this slot type can be added to. Will be empty if availableToAllPages is true.
Show Source
Nested Schema : items
Type:
Show Source
object
-
alias(optional):
string
path for the page type
-
id(optional):
string
ID of the page type
-
repositoryId(optional):
string
ID for the page type in the repository
-
shortName(optional):
string
Name of the page type
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
ID for the region in the repository
Example Response (application/json)
{
"links":[
{
"rel":"self",
"href":"ccadminui/v1/slotDescriptors"
}
],
"autoWrap":true,
"items":[
{
"isLatestVersion":true,
"regions":[
{
"repositoryId":"cvSlotDefaultControl"
},
{
"repositoryId":"cvSlotDefaultVariant"
}
],
"slotType":"contentVariationSlot",
"displayName":"Content Variation Slot",
"availableToAllPages":true,
"minWidth":1,
"version":1,
"maxVariants":11,
"latestVersion":1,
"repositoryId":"ContentVariationSlot",
"hiddenFromSiteStudio":false,
"id":"ContentVariationSlot",
"pageTypes":[
],
"configurable":false
},
{
"isLatestVersion":true,
"regions":[
{
"repositoryId":"exptSlotDefaultControl"
},
{
"repositoryId":"exptSlotDefaultVariant"
}
],
"slotType":"experimentSlot",
"displayName":"Experiment Slot",
"availableToAllPages":false,
"minWidth":1,
"version":1,
"maxVariants":6,
"latestVersion":1,
"repositoryId":"exptSlot",
"hiddenFromSiteStudio":false,
"id":"exptSlot",
"pageTypes":[
{
"repositoryId":"articlePageType",
"alias":"/article",
"id":"articlePageType",
"shortName":"article"
},
{
"repositoryId":"categoryPageType",
"alias":"/category",
"id":"categoryPageType",
"shortName":"category"
},
{
"repositoryId":"checkoutConfirmationPageType",
"alias":"/confirmation",
"id":"checkoutConfirmationPageType",
"shortName":"confirmation"
},
{
"repositoryId":"errorPageType",
"alias":"/error",
"id":"errorPageType",
"shortName":"error"
},
{
"repositoryId":"homePageType",
"alias":"/home",
"id":"homePageType",
"shortName":"home"
},
{
"repositoryId":"noSearchResultsPageType",
"alias":"/noSearchresults",
"id":"noSearchResultsPageType",
"shortName":"noSearchResults"
},
{
"repositoryId":"orderDetailsPageType",
"alias":"/orderDetails",
"id":"orderDetailsPageType",
"shortName":"orderDetails"
},
{
"repositoryId":"orderHistoryPageType",
"alias":"/orderHistory",
"id":"orderHistoryPageType",
"shortName":"orderHistory"
},
{
"repositoryId":"productPageType",
"alias":"/product",
"id":"productPageType",
"shortName":"product"
},
{
"repositoryId":"profilePageType",
"alias":"/profile",
"id":"profilePageType",
"shortName":"profile"
},
{
"repositoryId":"searchResultsPageType",
"alias":"/searchresults",
"id":"searchResultsPageType",
"shortName":"searchResults"
},
{
"repositoryId":"shoppingCartSummaryPageType",
"alias":"/cart",
"id":"shoppingCartSummaryPageType",
"shortName":"cart"
},
{
"repositoryId":"signupPageType",
"alias":"/signup",
"id":"signupPageType",
"shortName":"signup"
},
{
"repositoryId":"swmPageType",
"alias":"/swm",
"id":"swmPageType",
"shortName":"swm"
},
{
"repositoryId":"swmSettingsPageType",
"alias":"/swmSettings",
"id":"swmSettingsPageType",
"shortName":"swmSettings"
},
{
"repositoryId":"assetDetailsPageType",
"alias":"/assetDetails",
"id":"assetDetailsPageType",
"shortName":"assetDetails"
},
{
"repositoryId":"assetsPageType",
"alias":"/assets",
"id":"assetsPageType",
"shortName":"assets"
},
{
"repositoryId":"purchaseListPageType",
"alias":"/purchaseList",
"id":"purchaseListPageType",
"shortName":"purchaseList"
},
{
"repositoryId":"returnItemsPageType",
"alias":"/returnItems",
"id":"returnItemsPageType",
"shortName":"returnItems"
},
{
"repositoryId":"scheduledOrderPageType",
"alias":"/scheduledOrder",
"id":"scheduledOrderPageType",
"shortName":"scheduledOrder"
},
{
"repositoryId":"checkoutPageType",
"alias":"/checkout",
"id":"checkoutPageType",
"shortName":"checkout"
},
{
"repositoryId":"paymentPageType",
"alias":"/payment",
"id":"paymentPageType",
"shortName":"payment"
},
{
"repositoryId":"cmsContentPageType",
"alias":"/cmsContent",
"id":"cmsContentPageType",
"shortName":"cmsContent"
}
],
"configurable":false
},
{
"isLatestVersion":true,
"regions":[
{
"repositoryId":"rbSlotDefaultControl"
},
{
"repositoryId":"rbSlotDefaultVariant"
}
],
"slotType":"roleBasedSlot",
"displayName":"Role Based Slot",
"availableToAllPages":true,
"minWidth":1,
"version":1,
"maxVariants":11,
"latestVersion":1,
"repositoryId":"RoleBasedSlot",
"hiddenFromSiteStudio":false,
"id":"RoleBasedSlot",
"pageTypes":[
],
"configurable":false
}
]
}
Default Response
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
The error response:
Error Code | Description | Possible Fix |
---|---|---|
32108 | Internal Error retrieving all slot descriptors. | See returned error messages for further information. |
The error response:
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code