getFragmentMetadata
get
/ccadmin/v1/widgetDescriptors/{id}/element/{tag}/metadata
Gets the user modifiable metadata associated with the element under widget descriptor.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the widget descriptor
-
tag: string
The tag of the element
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : metadataForFragment
Type:
Show Source
object
-
code(optional):
object code
Object containing Global Element metadata
Nested Schema : code
Type:
object
Object containing Global Element metadata
Show Source
-
availableToAllWidgets(optional):
boolean
If set to true, the element will be usable with all widget types.
-
children(optional):
array children
Child element tags.
-
config(optional):
object config
Configuration object for fragment.
-
configOptions(optional):
array configOptions
Configuration options for element.
-
defaultText(optional):
string
The default text associated with the element.
-
inline(optional):
boolean
Whether to place the element in a span or div.
-
previewText(optional):
string
The preview text associated with the element - if any.
-
supportedWidgetType(optional):
array supportedWidgetType
The list of widget types that can be used with the element.
-
tag(optional):
string
The tag value associated with the element.
-
translations(optional):
object translations
The list of translations to be used when the element is displayed in Design Studio.
-
type(optional):
string
The type of the element.
Nested Schema : config
Type:
object
Configuration object for fragment.
Nested Schema : supportedWidgetType
Type:
array
The list of widget types that can be used with the element.
Show Source
Nested Schema : translations
Type:
object
The list of translations to be used when the element is displayed in Design Studio.
Show Source
Nested Schema : items
Type:
Show Source
object
-
description(optional):
string
Descriptive text for the element.
-
language(optional):
string
Language for the description and title.
-
title(optional):
string
Title text for the element.
Example Response (supportedWidgetType)
[
]
Example Response (availableToAllWidgets)
true
Example Response (inline)
false
Example Response (children)
[
]
Example Response (translations)
[
{
"description":"",
"language":"en",
"title":"Dog"
}
]
Example Response (global)
false
Example Response (tag)
dog
Example Response (type)
fragment
Example Response (version)
1
Example Response (configOptions)
[
"fontPicker"
]
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