getAllWidgetInstances
get
/ccadmin/v1/widgetDescriptors/instances
Get All Widget Instances. Get all widget descriptors along with their associated instances.
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 : getAllWidgetInstances_response
Type:
Show Source
object
-
items(optional):
array items
Widget Instances
Nested Schema : items
Type:
Show Source
object
-
availableToAllPages(optional):
boolean
Is this widget available to all pages
-
configurable(optional):
boolean
Is this widget configurable
-
displayName(optional):
string
the display name text
-
editableWidget(optional):
boolean
Is this widget editable
- hiddenFromSiteStudio(optional): boolean
-
id(optional):
string
the Widget Id
-
instances(optional):
array instances
Widget Instances
-
isLatestVersion(optional):
boolean
Is this the latest version of the widget
-
jsEditable(optional):
boolean
Is this widget JavaScript editable
-
latestVersion(optional):
integer
The latest version value of the widget
-
layouts(optional):
array layouts
description
-
minWidth(optional):
integer
The minimum width required my the widget
-
pageTypes(optional):
array pageTypes
a list of page types
-
repositoryId(optional):
string
The Repository Id
-
version(optional):
integer
The widget instance
-
widgetType(optional):
string
The widget type
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
the repository text
-
id(optional):
string
the instance id
-
pageIds(optional):
array pageIds
The Page Ids
-
pages(optional):
array pages
Pages this instance appears on
-
repositoryId(optional):
string
The Repository Id
Nested Schema : items
Type:
Show Source
object
-
description(optional):
string
the layout description
-
id(optional):
string
the layout id
-
name(optional):
string
the layout name
-
repositoryId(optional):
string
The Repository Id
-
sourceLocation(optional):
string
the layout source location
Nested Schema : items
Type:
Show Source
object
-
alias(optional):
string
the page type alias
-
id(optional):
string
the layout id
-
repositoryId(optional):
string
The Repository Id
-
shortName(optional):
string
the layout description
-
sourceLocation(optional):
string
the layout source location
Example Response (application/json)
[
{
"isLatestVersion":true,
"instances":[
{
"pages":[
"product"
],
"pageIds":[
"productPage"
],
"displayName":"Add Product To Wish List Widget",
"repositoryId":"productAddToSpaceWidgetInst",
"id":"productAddToSpaceWidgetInst"
}
],
"displayName":"Add Product To Space",
"availableToAllPages":false,
"jsEditable":false,
"minWidth":1,
"version":1,
"layouts":[
],
"javascript":[
],
"widgetType":"productAddToSpaceWidget",
"latestVersion":1,
"repositoryId":"productAddToSpaceWidget",
"editableWidget":false,
"id":"productAddToSpaceWidget",
"defaultLayout":null,
"pageTypes":[
],
"configurable":false
},
{
"isLatestVersion":true,
"instances":[
{
"pages":[
"cart"
],
"pageIds":[
"shoppingCartSummaryWithShippingPage"
],
"displayName":"Cart Shipping Widget",
"repositoryId":"cartShippingDetailsInst",
"id":"cartShippingDetailsInst"
}
],
"displayName":"Cart Shipping",
"availableToAllPages":false,
"jsEditable":false,
"minWidth":1,
"version":1,
"layouts":[
{
"name":"cartShippingDetailsDefaultLayout",
"repositoryId":"cartShippingDetailsDefaultLayout",
"description":"Default Panel",
"sourceLocation":"cartShippingDetailsDefaultLayout/widget.template",
"id":"cartShippingDetailsDefaultLayout"
}
],
"javascript":[
],
"widgetType":"cartShippingDetails",
"latestVersion":1,
"repositoryId":"cartShippingDetails",
"editableWidget":true,
"id":"cartShippingDetails",
"defaultLayout":{
"name":"cartShippingDetailsDefaultLayout",
"repositoryId":"cartShippingDetailsDefaultLayout",
"description":"Default Panel",
"sourceLocation":"cartShippingDetailsDefaultLayout/widget.template",
"id":"cartShippingDetailsDefaultLayout"
},
"pageTypes":[
{
"repositoryId":"shoppingCartSummaryPageType",
"alias":"/cart",
"id":"shoppingCartSummaryPageType",
"shortName":"cart"
}
],
"configurable":false
},
{
"isLatestVersion":true,
"instances":[
{
"pages":[
"checkout"
],
"pageIds":[
"checkoutPageWithGiftCard",
"checkoutPage"
],
"displayName":"Cart Summary Widget",
"repositoryId":"checkoutCartSummaryInst",
"id":"checkoutCartSummaryInst"
}
],
"displayName":"Cart Summary",
"availableToAllPages":false,
"jsEditable":false,
"minWidth":1,
"version":1,
"layouts":[
],
"javascript":[
],
"widgetType":"checkoutCartSummary",
"latestVersion":1,
"repositoryId":"checkoutCartSummary",
"editableWidget":true,
"id":"checkoutCartSummary",
"defaultLayout":null,
"pageTypes":[
{
"repositoryId":"checkoutPageType",
"alias":"/checkout",
"id":"checkoutPageType",
"shortName":"checkout"
}
],
"configurable":true
}
]
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