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

getAllSlotDescriptors

get

/ccadmin/v1/slotDescriptors

Get All Slot Descriptors. Retrieves all Slot Descriptors, optionally filtered by page type availability

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":"http://localhost:9080/ccadminui/v1/slotDescriptors?pageType=homePageType&includeSlotsAvailableToAll=true"
        }
    ],
    "autoWrap":true,
    "items":[
        {
            "isLatestVersion":true,
            "regions":[
                {
                    "repositoryId":"randomSlotControl"
                },
                {
                    "repositoryId":"randomSlotVariantOne"
                }
            ],
            "slotType":"randomSlot",
            "displayName":"Random Slot",
            "availableToAllPages":true,
            "minWidth":1,
            "version":1,
            "latestVersion":1,
            "maxVariants":3,
            "repositoryId":"randomSlot",
            "hiddenFromSiteStudio":false,
            "id":"randomSlot",
            "pageTypes":[
            ],
            "configurable":false
        }
    ]
}

Default Response

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