1. REST API for Oracle Commerce Cloud 21B
  2. Tasks
  3. Admin
  4. widgetDescriptors

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 Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getAllWidgetInstances_response
Type: object
Show Source
Nested Schema : items
Type: array
Widget Instances
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : instances
Type: array
Widget Instances
Show Source
Nested Schema : layouts
Type: array
description
Show Source
Nested Schema : pageTypes
Type: array
a list of page types
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : pageIds
Type: array
The Page Ids
Show Source
Nested Schema : pages
Type: array
Pages this instance appears on
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
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
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