listComponents
get
/ccadmin/v1/components
List Components. Endpoint for getting all components.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listComponents_response
Type:
Show Source
object
-
items(optional):
array items
Component
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The display name for the component.
-
global(optional):
boolean
Is the component global.
- hiddenFromSiteStudio(optional): boolean
-
instances(optional):
array instances
The instances of the component.
-
isLatestVersion(optional):
boolean
Is this the latest version of the component.
-
latestVersion(optional):
integer
The latest version of the component.
-
repositoryId(optional):
string
The component's repository ID.
-
slotType(optional):
string
If component type of slot, the type of slot.
-
source(optional):
integer
Is this component out of the box (100) or uploaded (101).
-
stackType(optional):
string
If component type of stack, the type of stack.
-
type(optional):
string
The type of component.
-
updatesAvailable(optional):
boolean
Are there any updates available for this component.
-
version(optional):
integer
The current version of the component.
-
widgetFamily(optional):
string
If component type of widget, the family the widget belongs to.
-
widgetType(optional):
string
If component type of widget, the type of widget.
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name displayed for the component instance.
-
layoutAssociations(optional):
array layoutAssociations
The layouts the component instances are associated with.
-
repositoryId(optional):
string
The component's repository ID.
-
updateAvailable(optional):
boolean
Is there an update available for this component instance.
-
version(optional):
integer
The current version of the component instance.
Nested Schema : layoutAssociations
Type:
array
The layouts the component instances are associated with.
Show Source
Example Response (application/json)
{
"items":[
{
"isLatestVersion":true,
"updatesAvailable":false,
"slotType":"contentVariationSlot",
"latestVersion":1,
"instances":[
],
"displayName":"Content Variation Slot",
"repositoryId":"ContentVariationSlot",
"hiddenFromSiteStudio":false,
"global":false,
"source":100,
"type":"slot",
"version":1
},
{
"isLatestVersion":true,
"updatesAvailable":false,
"slotType":"experimentSlot",
"latestVersion":1,
"instances":[
],
"displayName":"Experiment Slot",
"repositoryId":"ExperimentSlot",
"hiddenFromSiteStudio":false,
"global":false,
"source":100,
"type":"slot",
"version":1
}
]
}
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