getConfigLocaleContentForWidgetDescriptor
get
/ccadmin/v1/widgetDescriptors/{id}/metadata/config/locale/{locale}
Gets the config locale content for widget descriptor for the specified locale.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
The ID of the widget descriptor
-
locale(required): string
The locale of the of the desired content
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : configLocaleContentForWidgetDescriptor
Type:
Show Source
object
-
items:
object items
response
Nested Schema : items
Type:
object
response
Show Source
-
localeData:
object localeData
Locale strings structure
Nested Schema : localeData
Type:
object
Locale strings structure
Show Source
-
resources:
object resources
Additional Properties Allowed: additionalPropertiesLocale strings sub-structure
Nested Schema : resources
Type:
object
Additional Properties Allowed
Show Source
Locale strings sub-structure
Example Response (application/json)
{
"localeData":{
"resources":{
"exampleStringPropertyHelpText":"Example string property help text",
"exampleOption3Label":"Example Option 3",
"exampleBooleanPropertyLabel":"Example Boolean Property Label",
"exampleStringPropertyLabel":"Example String Property Label",
"exampleOptionPropertyLabel":"Example Option Property Label",
"exampleOption1Label":"Example Option 1",
"exampleBooleanPropertyHelpText":"Example boolean property help text",
"exampleOptionPropertyHelpText":"Example option property help text",
"exampleOption2Label":"Example Option 2"
}
}
}
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