getConfigMetadataForWidgetDescriptor
get
/ccadmin/v1/widgetDescriptors/{id}/metadata/config
Gets the user modifiable config metadata for a widget descriptor.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
The ID of the widget descriptor
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : configMetadataForWidgetDescriptor
Type:
Show Source
object
-
items:
object items
response
Nested Schema : items
Type:
object
response
Show Source
-
metadata:
object metadata
Metadata structure
Nested Schema : metadata
Type:
object
Metadata structure
Show Source
-
properties:
array properties
Array of metadata properties.
-
widgetDescriptorName:
string
The short name of the widget descriptor aka widget type.
Nested Schema : items
Type:
Show Source
object
-
defaultValue:
string
Default value for the property.
-
helpTextResourceId:
string
ID of property help text.
-
id:
string
Identifier for the property.
-
labelResourceId:
string
ID of property label text.
-
name:
string
Internal name for the property.
-
options:
array options
Describes possible values for an optionType property.
-
required:
boolean
Whether or not the property must contain a value.
-
type:
string
The property type.
Nested Schema : options
Type:
array
Describes possible values for an optionType property.
Show Source
Nested Schema : items
Type:
Show Source
object
-
id:
string
ID of option.
-
labelResourceId:
string
ID of option text.
-
value:
string
Value to use for option if it is selected.
Example Response (application/json)
{
"metadata":{
"widgetDescriptorName":"luther",
"properties":[
{
"name":"exampleStringProperty",
"id":"exampleStringProperty",
"helpTextResourceId":"exampleStringPropertyHelpText",
"labelResourceId":"exampleStringPropertyLabel",
"type":"stringType",
"required":true
},
{
"defaultValue":"option1",
"name":"exampleOptionProperty",
"options":[
{
"id":"exampleOption1",
"labelResourceId":"exampleOption1Label",
"value":"exampleOption1"
},
{
"id":"exampleOption2",
"labelResourceId":"exampleOption2Label",
"value":"exampleOption2"
},
{
"id":"exampleOption3",
"labelResourceId":"exampleOption3Label",
"value":"exampleOption3"
}
],
"id":"exampleOptionProperty",
"helpTextResourceId":"exampleOptionPropertyHelpText",
"labelResourceId":"exampleOptionPropertyLabel",
"type":"optionType"
},
{
"defaultValue":true,
"name":"exampleBooleanProperty",
"id":"exampleBooleanProperty",
"helpTextResourceId":"exampleBooleanPropertyHelpText",
"labelResourceId":"exampleBooleanPropertyLabel",
"type":"booleanType"
}
]
}
}
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