1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Admin
  4. Slots

updateSlot

put

/ccadmin/v1/slots/{id}

Update Slot. Update the settings of a slot

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : updateSlot_request
Type: object
Show Source
Example:
{
    "slotConfig":{
        "notes":"simple random slot",
        "name":"Random Slot"
    }
}
Nested Schema : slotConfig
Type: object
Slot Configuration
Show Source
Nested Schema : settings
Type: object
Settings
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateSlot_response
Type: object
Show Source
Nested Schema : descriptor
Type: object
The slot descriptor associated with the slot instance
Show Source
Nested Schema : pageTypes
Type: array
Page types that the slot descriptor can be used with
Show Source
Nested Schema : regions
Type: array
Slot sub-regions
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "settings":{
    },
    "instance":{
        "displayName":"Random Slot",
        "repositoryId":"re100002",
        "descriptor":{
            "isLatestVersion":true,
            "regions":[
                {
                    "repositoryId":"randomSlotControl"
                },
                {
                    "repositoryId":"randomSlotVariantOne"
                }
            ],
            "slotType":"randomSlot",
            "latestVersion":1,
            "displayName":"Random Slot",
            "availableToAllPages":true,
            "repositoryId":"randomSlot",
            "minWidth":1,
            "id":"randomSlot",
            "pageTypes":[
            ],
            "version":1,
            "configurable":true
        },
        "id":"re100002"
    },
    "notes":"",
    "name":"Random Slot",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/slots/re100002"
        }
    ]
}

412 Response

ETag mismatch. Asset has been updated by another user.

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