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

Update hidden slot descriptors

put

/ccadmin/v1/slotDescriptors/hidden

Sets whether a Slot Descriptor will be visible in the Admin Design Components library

This allows for Slot Descriptors, that are not going to be used, to be hidden from component drawer.

Note: Hidden Slot Descriptors will be returned by the Retrieve All Slot Descriptors Endpoint with the exception that their hiddenFromSiteStudio property will be set to true.

Request

Supported Media Types
Body ()
Root Schema : updateHiddenSlotTypes_request
Type: object
Show Source
Example:
{
    "slotDescriptors":[
        {
            "slotType":"randomSlot",
            "hiddenFromSiteStudio":true
        }
    ]
}
Nested Schema : slotDescriptors
Type: array
Array of slot types flag to show/hide each type in the Design tools
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateHiddenSlotTypes_200_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":"slotDescriptors/hidden"
        }
    ],
    "autoWrap":true,
    "items":[
        {
            "isLatestVersion":true,
            "regions":[
                {
                    "repositoryId":"randomSlotControl"
                },
                {
                    "repositoryId":"randomSlotVariantOne"
                }
            ],
            "slotType":"randomSlot",
            "displayName":"Random Slot",
            "availableToAllPages":true,
            "minWidth":1,
            "version":1,
            "maxVariants":3,
            "latestVersion":1,
            "repositoryId":"randomSlot",
            "hiddenFromSiteStudio":false,
            "id":"randomSlot",
            "pageTypes":[
            ],
            "configurable":false
        }
    ]
}

400 Response

JSON structure is not as expected
Body ()
Root Schema : updateHiddenSlotTypes_400_response
Type: object
Show Source

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.Ensure you have specified a valid slot descriptor id.

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