getGlobalElementMetadata

get

/ccadmin/v1/elements/{tag}/metadata

Get Global Element Metadata. Returns the specified Global Element Metadata.

Request

Supported Media Types
Path Parameters
  • The tag associated with the the Global Element Metadata file to retrieve.
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : globalElementMetadata
Type: object
Show Source
Nested Schema : code
Type: object
Object containing Global Element metadata
Show Source
Nested Schema : children
Type: array
Child element tags.
Show Source
Nested Schema : config
Type: object
Configuration object for fragment.
Nested Schema : configOptions
Type: array
Configuration options for element.
Show Source
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: object
Show Source
Example Response (application/json)
{
    "supportedWidgetType":[
    ],
    "availableToAllWidgets":true,
    "inline":false,
    "children":[
    ],
    "translations":[
        {
            "description":"",
            "language":"en",
            "title":"My Element"
        }
    ],
    "global":false,
    "tag":"my-element",
    "type":"fragment",
    "version":1,
    "configOptions":[
        "fontPicker"
    ]
}

Default Response

The error response
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top