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(required): string
the id of the page type to get
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getAllWidgetDescriptorsByPageType_response
Type:
Show Source
object
-
items:
array items
description
Nested Schema : items
Type:
Show Source
object
-
availableToAllPages:
boolean
Is this widget available to all pages
-
defaultLayout:
object defaultLayout
The default layout
-
displayName:
string
The widget display name
-
editableWidget:
boolean
Is this widget editable
-
id(required):
string
the id of the widget descriptor
-
layouts:
array layouts
Array of layouts that this widget appears on
-
pageTypes:
array pageTypes
Array of page types
-
repositoryId:
string
The Repository Id
-
widgetType:
string
The widget type
Nested Schema : defaultLayout
Type:
object
The default layout
Show Source
-
description:
string
the layout description
-
id:
string
the layout id
-
name:
string
the layout name
-
repositoryId:
string
The Repository Id
-
sourceLocation:
string
the layout source location
Nested Schema : items
Type:
Show Source
object
-
description:
string
the layout description
-
id:
string
the layout id
-
name:
string
the layout name
-
repositoryId:
string
The Repository Id
-
sourceLocation:
string
the layout source location
Nested Schema : items
Type:
Show Source
object
-
alias:
string
the fragment text
-
id:
string
the fragment text
-
repositoryId:
string
the fragment text
-
shortName:
string
the fragment text
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
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code