Jump to

• Request
• Response

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getSlot_response

Type: object

Show Source

• 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

{
    "properties":{
        "settings":{
            "description":"Configuration settings for the slot instance",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "instance":{
            "description":"The slot instance",
            "type":"object",
            "properties":{
                "displayName":{
                    "description":"Display name for the slot instance",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"Repository ID for slot instance",
                    "type":"string"
                },
                "descriptor":{
                    "description":"The slot descriptor associated with the slot instance",
                    "type":"object",
                    "properties":{
                        "isLatestVersion":{
                            "description":"Whether this is the latest version of the slot descriptor",
                            "type":"boolean"
                        },
                        "regions":{
                            "description":"List of regions for slot steps",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "repositoryId":{
                                        "description":"Repository ID of slot step region",
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "slotType":{
                            "description":"Type of slot",
                            "type":"string"
                        },
                        "latestVersion":{
                            "description":"The latest version of the slot descriptor",
                            "type":"integer"
                        },
                        "displayName":{
                            "description":"Display name of the slot descriptor",
                            "type":"string"
                        },
                        "availableToAllPages":{
                            "description":"Whether slot descriptor is available to all pages",
                            "type":"boolean"
                        },
                        "repositoryId":{
                            "description":"Repository ID of the slot descriptor",
                            "type":"string"
                        },
                        "minWidth":{
                            "description":"The minimum width of the slot",
                            "type":"integer"
                        },
                        "id":{
                            "description":"ID of the slot instance",
                            "type":"string"
                        },
                        "pageTypes":{
                            "description":"Array of page types that the slot descriptor can be used on",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "repositoryId":{
                                        "description":"Page type repository ID",
                                        "type":"string"
                                    },
                                    "alias":{
                                        "description":"Page type alias",
                                        "type":"string"
                                    },
                                    "id":{
                                        "description":"Page type ID",
                                        "type":"string"
                                    },
                                    "shortName":{
                                        "description":"Page type name",
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "version":{
                            "description":"Version of the slot descriptor",
                            "type":"integer"
                        },
                        "configurable":{
                            "description":"Whether slot is configurable",
                            "type":"boolean"
                        }
                    }
                },
                "id":{
                    "description":"Slot instance ID",
                    "type":"string"
                }
            }
        },
        "notes":{
            "description":"Notes for the slot instance",
            "type":"string"
        },
        "name":{
            "description":"Name of the slot instance",
            "type":"string"
        }
    }
}

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

{
    "description":"The slot instance",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Display name for the slot instance",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID for slot instance",
            "type":"string"
        },
        "descriptor":{
            "description":"The slot descriptor associated with the slot instance",
            "type":"object",
            "properties":{
                "isLatestVersion":{
                    "description":"Whether this is the latest version of the slot descriptor",
                    "type":"boolean"
                },
                "regions":{
                    "description":"List of regions for slot steps",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"Repository ID of slot step region",
                                "type":"string"
                            }
                        }
                    }
                },
                "slotType":{
                    "description":"Type of slot",
                    "type":"string"
                },
                "latestVersion":{
                    "description":"The latest version of the slot descriptor",
                    "type":"integer"
                },
                "displayName":{
                    "description":"Display name of the slot descriptor",
                    "type":"string"
                },
                "availableToAllPages":{
                    "description":"Whether slot descriptor is available to all pages",
                    "type":"boolean"
                },
                "repositoryId":{
                    "description":"Repository ID of the slot descriptor",
                    "type":"string"
                },
                "minWidth":{
                    "description":"The minimum width of the slot",
                    "type":"integer"
                },
                "id":{
                    "description":"ID of the slot instance",
                    "type":"string"
                },
                "pageTypes":{
                    "description":"Array of page types that the slot descriptor can be used on",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"Page type repository ID",
                                "type":"string"
                            },
                            "alias":{
                                "description":"Page type alias",
                                "type":"string"
                            },
                            "id":{
                                "description":"Page type ID",
                                "type":"string"
                            },
                            "shortName":{
                                "description":"Page type name",
                                "type":"string"
                            }
                        }
                    }
                },
                "version":{
                    "description":"Version of the slot descriptor",
                    "type":"integer"
                },
                "configurable":{
                    "description":"Whether slot is configurable",
                    "type":"boolean"
                }
            }
        },
        "id":{
            "description":"Slot instance ID",
            "type":"string"
        }
    }
}

Nested Schema : settings

Type: array

Configuration settings for the slot instance

Show Source

• Array of: string

{
    "description":"Configuration settings for the slot instance",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

{
    "description":"The slot descriptor associated with the slot instance",
    "type":"object",
    "properties":{
        "isLatestVersion":{
            "description":"Whether this is the latest version of the slot descriptor",
            "type":"boolean"
        },
        "regions":{
            "description":"List of regions for slot steps",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository ID of slot step region",
                        "type":"string"
                    }
                }
            }
        },
        "slotType":{
            "description":"Type of slot",
            "type":"string"
        },
        "latestVersion":{
            "description":"The latest version of the slot descriptor",
            "type":"integer"
        },
        "displayName":{
            "description":"Display name of the slot descriptor",
            "type":"string"
        },
        "availableToAllPages":{
            "description":"Whether slot descriptor is available to all pages",
            "type":"boolean"
        },
        "repositoryId":{
            "description":"Repository ID of the slot descriptor",
            "type":"string"
        },
        "minWidth":{
            "description":"The minimum width of the slot",
            "type":"integer"
        },
        "id":{
            "description":"ID of the slot instance",
            "type":"string"
        },
        "pageTypes":{
            "description":"Array of page types that the slot descriptor can be used on",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Page type repository ID",
                        "type":"string"
                    },
                    "alias":{
                        "description":"Page type alias",
                        "type":"string"
                    },
                    "id":{
                        "description":"Page type ID",
                        "type":"string"
                    },
                    "shortName":{
                        "description":"Page type name",
                        "type":"string"
                    }
                }
            }
        },
        "version":{
            "description":"Version of the slot descriptor",
            "type":"integer"
        },
        "configurable":{
            "description":"Whether slot is configurable",
            "type":"boolean"
        }
    }
}

Nested Schema : pageTypes

Type: array

Array of page types that the slot descriptor can be used on

Show Source

• Array of: object items

{
    "description":"Array of page types that the slot descriptor can be used on",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"Page type repository ID",
                "type":"string"
            },
            "alias":{
                "description":"Page type alias",
                "type":"string"
            },
            "id":{
                "description":"Page type ID",
                "type":"string"
            },
            "shortName":{
                "description":"Page type name",
                "type":"string"
            }
        }
    }
}

Nested Schema : regions

Type: array

List of regions for slot steps

Show Source

• Array of: object items

{
    "description":"List of regions for slot steps",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"Repository ID of slot step region",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Page type repository ID",
            "type":"string"
        },
        "alias":{
            "description":"Page type alias",
            "type":"string"
        },
        "id":{
            "description":"Page type ID",
            "type":"string"
        },
        "shortName":{
            "description":"Page type name",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): string
  Repository ID of slot step region

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of slot step region",
            "type":"string"
        }
    }
}

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

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top