Jump to

• Request
• Response

getGlobalElementMetadata

get

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

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

Request

Supported Media Types

• application/json

Path Parameters

• tag: string
  The tag associated with the the Global Element Metadata file to retrieve.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : globalElementMetadata

Type: object

Show Source

• code(optional): object code
  Object containing Global Element metadata

{
    "properties":{
        "code":{
            "description":"Object containing Global Element metadata",
            "type":"object",
            "properties":{
                "supportedWidgetType":{
                    "description":"The list of widget types that can be used with the element.",
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "inline":{
                    "description":"Whether to place the element in a span or div.",
                    "type":"boolean"
                },
                "availableToAllWidgets":{
                    "description":"If set to true, the element will be usable with all widget types.",
                    "type":"boolean"
                },
                "children":{
                    "description":"Child element tags.",
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "translations":{
                    "description":"The list of translations to be used when the element is displayed in Design Studio.",
                    "type":"object",
                    "items":{
                        "type":"object",
                        "properties":{
                            "description":{
                                "description":"Descriptive text for the element.",
                                "type":"string"
                            },
                            "language":{
                                "description":"Language for the description and title.",
                                "type":"string"
                            },
                            "title":{
                                "description":"Title text for the element.",
                                "type":"string"
                            }
                        }
                    }
                },
                "defaultText":{
                    "description":"The default text associated with the element.",
                    "type":"string"
                },
                "tag":{
                    "description":"The tag value associated with the element.",
                    "type":"string"
                },
                "previewText":{
                    "description":"The preview text associated with the element - if any.",
                    "type":"string"
                },
                "type":{
                    "description":"The type of the element.",
                    "type":"string"
                },
                "config":{
                    "description":"Configuration object for fragment.",
                    "type":"object"
                },
                "configOptions":{
                    "description":"Configuration options for element.",
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

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.

{
    "description":"Object containing Global Element metadata",
    "type":"object",
    "properties":{
        "supportedWidgetType":{
            "description":"The list of widget types that can be used with the element.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "inline":{
            "description":"Whether to place the element in a span or div.",
            "type":"boolean"
        },
        "availableToAllWidgets":{
            "description":"If set to true, the element will be usable with all widget types.",
            "type":"boolean"
        },
        "children":{
            "description":"Child element tags.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "translations":{
            "description":"The list of translations to be used when the element is displayed in Design Studio.",
            "type":"object",
            "items":{
                "type":"object",
                "properties":{
                    "description":{
                        "description":"Descriptive text for the element.",
                        "type":"string"
                    },
                    "language":{
                        "description":"Language for the description and title.",
                        "type":"string"
                    },
                    "title":{
                        "description":"Title text for the element.",
                        "type":"string"
                    }
                }
            }
        },
        "defaultText":{
            "description":"The default text associated with the element.",
            "type":"string"
        },
        "tag":{
            "description":"The tag value associated with the element.",
            "type":"string"
        },
        "previewText":{
            "description":"The preview text associated with the element - if any.",
            "type":"string"
        },
        "type":{
            "description":"The type of the element.",
            "type":"string"
        },
        "config":{
            "description":"Configuration object for fragment.",
            "type":"object"
        },
        "configOptions":{
            "description":"Configuration options for element.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : children

Type: array

Child element tags.

Show Source

• Array of: string

{
    "description":"Child element tags.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : config

Type: object

Configuration object for fragment.

Nested Schema : configOptions

Type: array

Configuration options for element.

Show Source

• Array of: string

{
    "description":"Configuration options for element.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : supportedWidgetType

Type: array

The list of widget types that can be used with the element.

Show Source

• Array of: string

{
    "description":"The list of widget types that can be used with the element.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : translations

Type: object

The list of translations to be used when the element is displayed in Design Studio.

Show Source

• Array of: object items

{
    "description":"The list of translations to be used when the element is displayed in Design Studio.",
    "type":"object",
    "items":{
        "type":"object",
        "properties":{
            "description":{
                "description":"Descriptive text for the element.",
                "type":"string"
            },
            "language":{
                "description":"Language for the description and title.",
                "type":"string"
            },
            "title":{
                "description":"Title text for the element.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "description":{
            "description":"Descriptive text for the element.",
            "type":"string"
        },
        "language":{
            "description":"Language for the description and title.",
            "type":"string"
        },
        "title":{
            "description":"Title text for the element.",
            "type":"string"
        }
    }
}

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

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top