1. REST API for Oracle Commerce Cloud 21C
  2. Tasks
  3. Admin
  4. Slot Descriptors

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
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getAllSlotDescriptors_response
Type: object
Show Source
Nested Schema : items
Type: array
Array of slot types, optionally filtered by page type
Show Source
Nested Schema : items
Type: object
Show Source
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 : regions
Type: array
Default sub-regions for this slot type
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
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:
Error CodeDescriptionPossible Fix
32108Internal Error retrieving all slot descriptors.See returned error messages for further information.

The error response:
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top