updateWidgetDescriptorMetadata
put
/ccadmin/v1/widgetDescriptors/{id}/metadata
Update widget descriptor metadata.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the widget descriptor
Root Schema : metadataForWidgetDescriptor
Type:
Show Source
object
-
items(optional):
object items
response
Nested Schema : items
Type:
object
response
Show Source
-
metadata(optional):
object metadata
Metadata structure
Nested Schema : metadata
Type:
object
Metadata structure
Show Source
-
availableToAllPages(optional):
boolean
Whether or not the widget can be used with all page types.
-
config(optional):
object config
Additional Properties Allowed: additionalPropertiesConfiguration values for the widget.
-
globalEnabled(optional):
boolean
Whether or not the widget is enabled.
-
imports(optional):
array imports
Widget import names.
-
jsEditable(optional):
boolean
Whether or not the widget JavaScript can be edited.
-
minWidth(optional):
integer
Minimum number of columns the widget should occupy.
-
pageTypes(optional):
array pageTypes
List of page types usable with the widget.
-
translations(optional):
array translations
Widget translations for display name.
Nested Schema : config
Type:
object
Additional Properties Allowed
Show Source
Configuration values for the widget.
Nested Schema : items
Type:
Show Source
object
-
language(optional):
string
Language code.
-
name(optional):
string
National language text for the display name.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : metadataForWidgetDescriptor
Type:
Show Source
object
-
items(optional):
object items
response
Nested Schema : items
Type:
object
response
Show Source
-
metadata(optional):
object metadata
Metadata structure
Nested Schema : metadata
Type:
object
Metadata structure
Show Source
-
availableToAllPages(optional):
boolean
Whether or not the widget can be used with all page types.
-
config(optional):
object config
Additional Properties Allowed: additionalPropertiesConfiguration values for the widget.
-
globalEnabled(optional):
boolean
Whether or not the widget is enabled.
-
imports(optional):
array imports
Widget import names.
-
jsEditable(optional):
boolean
Whether or not the widget JavaScript can be edited.
-
minWidth(optional):
integer
Minimum number of columns the widget should occupy.
-
pageTypes(optional):
array pageTypes
List of page types usable with the widget.
-
translations(optional):
array translations
Widget translations for display name.
Nested Schema : config
Type:
object
Additional Properties Allowed
Show Source
Configuration values for the widget.
Nested Schema : items
Type:
Show Source
object
-
language(optional):
string
Language code.
-
name(optional):
string
National language text for the display name.
Example Response (application/json)
{
"metadata":{
"imports":[
],
"translations":[
{
"name":"Luther [th]",
"language":"th"
},
{
"name":"Luther [pt_BR]",
"language":"pt_BR"
}
],
"availableToAllPages":true,
"jsEditable":true,
"minWidth":1,
"globalEnabled":true,
"config":{
}
}
}
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