Jump to

• Request
• Response

getAllWidgetDescriptorsByPageType

get

/ccadmin/v1/widgetDescriptors/pageType/{id}

Get All Widget Descriptors By Page Type. Get all widget descriptors by page type

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  the id of the page type to get

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getAllWidgetDescriptorsByPageType_response

Type: object

Show Source

• items(optional): array items
  description

{
    "properties":{
        "items":{
            "description":"description",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"The widget display name",
                        "type":"string"
                    },
                    "availableToAllPages":{
                        "description":"Is this widget available to all pages",
                        "type":"boolean"
                    },
                    "repositoryId":{
                        "description":"The Repository Id",
                        "type":"string"
                    },
                    "id":{
                        "description":"the id of the widget descriptor",
                        "type":"string"
                    },
                    "editableWidget":{
                        "description":"Is this widget editable",
                        "type":"boolean"
                    },
                    "defaultLayout":{
                        "description":"The default layout ",
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"The Repository Id",
                                "type":"string"
                            },
                            "name":{
                                "description":"the layout name",
                                "type":"string"
                            },
                            "description":{
                                "description":"the layout description",
                                "type":"string"
                            },
                            "sourceLocation":{
                                "description":"the layout source location",
                                "type":"string"
                            },
                            "id":{
                                "description":"the layout id",
                                "type":"string"
                            }
                        }
                    },
                    "pageTypes":{
                        "description":"Array of page types",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "repositoryId":{
                                    "description":"the fragment text",
                                    "type":"string"
                                },
                                "alias":{
                                    "description":"the fragment text",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"the fragment text",
                                    "type":"string"
                                },
                                "shortName":{
                                    "description":"the fragment text",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "layouts":{
                        "description":"Array of layouts that this widget appears on",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "repositoryId":{
                                    "description":"The Repository Id",
                                    "type":"string"
                                },
                                "name":{
                                    "description":"the layout name",
                                    "type":"string"
                                },
                                "description":{
                                    "description":"the layout description",
                                    "type":"string"
                                },
                                "sourceLocation":{
                                    "description":"the layout source location",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"the layout id",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "widgetType":{
                        "description":"The widget type",
                        "type":"string"
                    }
                },
                "required":[
                    "id"
                ]
            }
        }
    }
}

Nested Schema : items

Type: array

description

Show Source

• Array of: object items

{
    "description":"description",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayName":{
                "description":"The widget display name",
                "type":"string"
            },
            "availableToAllPages":{
                "description":"Is this widget available to all pages",
                "type":"boolean"
            },
            "repositoryId":{
                "description":"The Repository Id",
                "type":"string"
            },
            "id":{
                "description":"the id of the widget descriptor",
                "type":"string"
            },
            "editableWidget":{
                "description":"Is this widget editable",
                "type":"boolean"
            },
            "defaultLayout":{
                "description":"The default layout ",
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The Repository Id",
                        "type":"string"
                    },
                    "name":{
                        "description":"the layout name",
                        "type":"string"
                    },
                    "description":{
                        "description":"the layout description",
                        "type":"string"
                    },
                    "sourceLocation":{
                        "description":"the layout source location",
                        "type":"string"
                    },
                    "id":{
                        "description":"the layout id",
                        "type":"string"
                    }
                }
            },
            "pageTypes":{
                "description":"Array of page types",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "repositoryId":{
                            "description":"the fragment text",
                            "type":"string"
                        },
                        "alias":{
                            "description":"the fragment text",
                            "type":"string"
                        },
                        "id":{
                            "description":"the fragment text",
                            "type":"string"
                        },
                        "shortName":{
                            "description":"the fragment text",
                            "type":"string"
                        }
                    }
                }
            },
            "layouts":{
                "description":"Array of layouts that this widget appears on",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "repositoryId":{
                            "description":"The Repository Id",
                            "type":"string"
                        },
                        "name":{
                            "description":"the layout name",
                            "type":"string"
                        },
                        "description":{
                            "description":"the layout description",
                            "type":"string"
                        },
                        "sourceLocation":{
                            "description":"the layout source location",
                            "type":"string"
                        },
                        "id":{
                            "description":"the layout id",
                            "type":"string"
                        }
                    }
                }
            },
            "widgetType":{
                "description":"The widget type",
                "type":"string"
            }
        },
        "required":[
            "id"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• availableToAllPages(optional): boolean
  Is this widget available to all pages
• defaultLayout(optional): object defaultLayout
  The default layout
• displayName(optional): string
  The widget display name
• editableWidget(optional): boolean
  Is this widget editable
• id: string
  the id of the widget descriptor
• layouts(optional): array layouts
  Array of layouts that this widget appears on
• pageTypes(optional): array pageTypes
  Array of page types
• repositoryId(optional): string
  The Repository Id
• widgetType(optional): string
  The widget type

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"The widget display name",
            "type":"string"
        },
        "availableToAllPages":{
            "description":"Is this widget available to all pages",
            "type":"boolean"
        },
        "repositoryId":{
            "description":"The Repository Id",
            "type":"string"
        },
        "id":{
            "description":"the id of the widget descriptor",
            "type":"string"
        },
        "editableWidget":{
            "description":"Is this widget editable",
            "type":"boolean"
        },
        "defaultLayout":{
            "description":"The default layout ",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"The Repository Id",
                    "type":"string"
                },
                "name":{
                    "description":"the layout name",
                    "type":"string"
                },
                "description":{
                    "description":"the layout description",
                    "type":"string"
                },
                "sourceLocation":{
                    "description":"the layout source location",
                    "type":"string"
                },
                "id":{
                    "description":"the layout id",
                    "type":"string"
                }
            }
        },
        "pageTypes":{
            "description":"Array of page types",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"the fragment text",
                        "type":"string"
                    },
                    "alias":{
                        "description":"the fragment text",
                        "type":"string"
                    },
                    "id":{
                        "description":"the fragment text",
                        "type":"string"
                    },
                    "shortName":{
                        "description":"the fragment text",
                        "type":"string"
                    }
                }
            }
        },
        "layouts":{
            "description":"Array of layouts that this widget appears on",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The Repository Id",
                        "type":"string"
                    },
                    "name":{
                        "description":"the layout name",
                        "type":"string"
                    },
                    "description":{
                        "description":"the layout description",
                        "type":"string"
                    },
                    "sourceLocation":{
                        "description":"the layout source location",
                        "type":"string"
                    },
                    "id":{
                        "description":"the layout id",
                        "type":"string"
                    }
                }
            }
        },
        "widgetType":{
            "description":"The widget type",
            "type":"string"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : defaultLayout

Type: object

The default layout

Show Source

• 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

{
    "description":"The default layout ",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The Repository Id",
            "type":"string"
        },
        "name":{
            "description":"the layout name",
            "type":"string"
        },
        "description":{
            "description":"the layout description",
            "type":"string"
        },
        "sourceLocation":{
            "description":"the layout source location",
            "type":"string"
        },
        "id":{
            "description":"the layout id",
            "type":"string"
        }
    }
}

Nested Schema : layouts

Type: array

Array of layouts that this widget appears on

Show Source

• Array of: object items

{
    "description":"Array of layouts that this widget appears on",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"The Repository Id",
                "type":"string"
            },
            "name":{
                "description":"the layout name",
                "type":"string"
            },
            "description":{
                "description":"the layout description",
                "type":"string"
            },
            "sourceLocation":{
                "description":"the layout source location",
                "type":"string"
            },
            "id":{
                "description":"the layout id",
                "type":"string"
            }
        }
    }
}

Nested Schema : pageTypes

Type: array

Array of page types

Show Source

• Array of: object items

{
    "description":"Array of page types",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"the fragment text",
                "type":"string"
            },
            "alias":{
                "description":"the fragment text",
                "type":"string"
            },
            "id":{
                "description":"the fragment text",
                "type":"string"
            },
            "shortName":{
                "description":"the fragment text",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The Repository Id",
            "type":"string"
        },
        "name":{
            "description":"the layout name",
            "type":"string"
        },
        "description":{
            "description":"the layout description",
            "type":"string"
        },
        "sourceLocation":{
            "description":"the layout source location",
            "type":"string"
        },
        "id":{
            "description":"the layout id",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• alias(optional): string
  the fragment text
• id(optional): string
  the fragment text
• repositoryId(optional): string
  the fragment text
• shortName(optional): string
  the fragment text

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"the fragment text",
            "type":"string"
        },
        "alias":{
            "description":"the fragment text",
            "type":"string"
        },
        "id":{
            "description":"the fragment text",
            "type":"string"
        },
        "shortName":{
            "description":"the fragment text",
            "type":"string"
        }
    }
}

Example Response (application/json)

[
    {
        "displayName":"Checkout Confirmation",
        "availableToAllPages":true,
        "repositoryId":"checkoutConfirmation",
        "id":"checkoutConfirmation",
        "editableWidget":true,
        "defaultLayout":null,
        "pageTypes":[
            {
                "repositoryId":"confirmation",
                "alias":"/confirmation",
                "id":"confirmation",
                "shortName":"confirmation"
            }
        ],
        "layouts":[
        ],
        "widgetType":"checkoutConfirmation"
    },
    {
        "displayName":"Confirmation Summary",
        "availableToAllPages":true,
        "repositoryId":"confirmationSummary",
        "id":"confirmationSummary",
        "editableWidget":true,
        "defaultLayout":null,
        "pageTypes":[
            {
                "repositoryId":"confirmation",
                "alias":"/confirmation",
                "id":"confirmation",
                "shortName":"confirmation"
            }
        ],
        "layouts":[
        ],
        "widgetType":"confirmationSummary"
    }
]

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