getWidgetDescriptorById
get
/ccadmin/v1/widgetDescriptors/{id}
Get Widget Descriptor By Id. Get the widget descriptor by the id
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
the id of the widget descriptor
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getWidgetDescriptorById_response
Type:
Show Source
object
-
items(optional):
object items
Widget details
Nested Schema : items
Type:
object
Widget details
Show Source
-
availableToAllPages(optional):
boolean
Is this widget available to all pages
-
configurable(optional):
boolean
Is this widget configurable
-
defaultLayout(optional):
object defaultLayout
The default layout
-
displayName(optional):
string
the display name text
-
editableWidget(optional):
boolean
Is this widget editable
-
id(optional):
string
the Widget Id
-
isLatestVersion(optional):
boolean
Is this 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
Array of layouts that this widget appears on
-
minWidth(optional):
integer
The minimum width required by the widget
-
pageTypes(optional):
array pageTypes
An array of page types
-
repositoryId(optional):
string
The Repository Id
-
version(optional):
integer
The widget instance
-
widgetType(optional):
string
The widget type
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
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
Example Response (application/json)
{
"isLatestVersion":true,
"displayName":"Header",
"availableToAllPages":true,
"jsEditable":false,
"minWidth":1,
"version":1,
"layouts":[
{
"name":"headerWidgetDefaultLayout",
"repositoryId":"headerWidgetDefaultLayout",
"description":"Default Panel",
"sourceLocation":"headerWidgetDefaultLayout/widget.template",
"id":"headerWidgetDefaultLayout"
}
],
"widgetType":"headerWidget",
"latestVersion":1,
"repositoryId":"headerWidget",
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/widgetDescriptors/headerWidget"
}
],
"editableWidget":true,
"id":"headerWidget",
"defaultLayout":{
"name":"headerWidgetDefaultLayout",
"repositoryId":"headerWidgetDefaultLayout",
"description":"Default Panel",
"sourceLocation":"headerWidgetDefaultLayout/widget.template",
"id":"headerWidgetDefaultLayout"
},
"pageTypes":[
],
"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