getSlot
get
/ccadmin/v1/slots/{id}
Get Slot. Get a slot based on ID
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the slot instance to get
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getSlot_response
Type:
Show Source
object
-
instance(optional):
object instance
The slot instance
-
name(optional):
string
Name of the slot instance
-
notes(optional):
string
Notes for the slot instance
-
settings(optional):
array settings
Configuration settings for the slot instance
Nested Schema : instance
Type:
object
The slot instance
Show Source
-
descriptor(optional):
object descriptor
The slot descriptor associated with the slot instance
-
displayName(optional):
string
Display name for the slot instance
-
id(optional):
string
Slot instance ID
-
repositoryId(optional):
string
Repository ID for slot instance
Nested Schema : descriptor
Type:
object
The slot descriptor associated with the slot instance
Show Source
-
availableToAllPages(optional):
boolean
Whether slot descriptor is available to all pages
-
configurable(optional):
boolean
Whether slot is configurable
-
displayName(optional):
string
Display name of the slot descriptor
-
id(optional):
string
ID of the slot instance
-
isLatestVersion(optional):
boolean
Whether this is the latest version of the slot descriptor
-
latestVersion(optional):
integer
The latest version of the slot descriptor
-
minWidth(optional):
integer
The minimum width of the slot
-
pageTypes(optional):
array pageTypes
Array of page types that the slot descriptor can be used on
-
regions(optional):
array regions
List of regions for slot steps
-
repositoryId(optional):
string
Repository ID of the slot descriptor
-
slotType(optional):
string
Type of slot
-
version(optional):
integer
Version of the slot descriptor
Nested Schema : pageTypes
Type:
array
Array of page types that the slot descriptor can be used on
Show Source
Nested Schema : items
Type:
Show Source
object
-
alias(optional):
string
Page type alias
-
id(optional):
string
Page type ID
-
repositoryId(optional):
string
Page type repository ID
-
shortName(optional):
string
Page type name
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
Repository ID of slot step region
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"
}
]
}
Default Response
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