Jump to

• Request
• Response

getWidgetDescriptorMetadata

get

/ccadmin/v1/widgetDescriptors/{id}/metadata

Gets the user modifiable metadata associated with the widget descriptor.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The ID of the widget descriptor

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : metadataForWidgetDescriptor

Type: object

Show Source

• items(optional): object items
  response

{
    "properties":{
        "items":{
            "description":"response",
            "type":"object",
            "properties":{
                "metadata":{
                    "description":"Metadata structure",
                    "type":"object",
                    "properties":{
                        "imports":{
                            "description":"Widget import names.",
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "translations":{
                            "description":"Widget translations for display name.",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "name":{
                                        "description":"National language text for the display name.",
                                        "type":"string"
                                    },
                                    "language":{
                                        "description":"Language code.",
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "availableToAllPages":{
                            "description":"Whether or not the widget can be used with all page types.",
                            "type":"boolean"
                        },
                        "jsEditable":{
                            "description":"Whether or not the widget JavaScript can be edited.",
                            "type":"boolean"
                        },
                        "minWidth":{
                            "description":"Minimum number of columns the widget should occupy.",
                            "type":"integer"
                        },
                        "globalEnabled":{
                            "description":"Whether or not the widget is enabled.",
                            "type":"boolean"
                        },
                        "pageTypes":{
                            "description":"List of page types usable with the widget.",
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "config":{
                            "description":"Configuration values for the widget.",
                            "additionalProperties":{
                            },
                            "type":"object"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

response

Show Source

• metadata(optional): object metadata
  Metadata structure

{
    "description":"response",
    "type":"object",
    "properties":{
        "metadata":{
            "description":"Metadata structure",
            "type":"object",
            "properties":{
                "imports":{
                    "description":"Widget import names.",
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "translations":{
                    "description":"Widget translations for display name.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "description":"National language text for the display name.",
                                "type":"string"
                            },
                            "language":{
                                "description":"Language code.",
                                "type":"string"
                            }
                        }
                    }
                },
                "availableToAllPages":{
                    "description":"Whether or not the widget can be used with all page types.",
                    "type":"boolean"
                },
                "jsEditable":{
                    "description":"Whether or not the widget JavaScript can be edited.",
                    "type":"boolean"
                },
                "minWidth":{
                    "description":"Minimum number of columns the widget should occupy.",
                    "type":"integer"
                },
                "globalEnabled":{
                    "description":"Whether or not the widget is enabled.",
                    "type":"boolean"
                },
                "pageTypes":{
                    "description":"List of page types usable with the widget.",
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "config":{
                    "description":"Configuration values for the widget.",
                    "additionalProperties":{
                    },
                    "type":"object"
                }
            }
        }
    }
}

Nested Schema : metadata

Type: object

Metadata structure

Show Source

• availableToAllPages(optional): boolean
  Whether or not the widget can be used with all page types.
• config(optional): object config
  Additional Properties Allowed: additionalProperties

  Configuration values for the widget.
• globalEnabled(optional): boolean
  Whether or not the widget is enabled.
• imports(optional): array imports
  Widget import names.
• jsEditable(optional): boolean
  Whether or not the widget JavaScript can be edited.
• minWidth(optional): integer
  Minimum number of columns the widget should occupy.
• pageTypes(optional): array pageTypes
  List of page types usable with the widget.
• translations(optional): array translations
  Widget translations for display name.

{
    "description":"Metadata structure",
    "type":"object",
    "properties":{
        "imports":{
            "description":"Widget import names.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "translations":{
            "description":"Widget translations for display name.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"National language text for the display name.",
                        "type":"string"
                    },
                    "language":{
                        "description":"Language code.",
                        "type":"string"
                    }
                }
            }
        },
        "availableToAllPages":{
            "description":"Whether or not the widget can be used with all page types.",
            "type":"boolean"
        },
        "jsEditable":{
            "description":"Whether or not the widget JavaScript can be edited.",
            "type":"boolean"
        },
        "minWidth":{
            "description":"Minimum number of columns the widget should occupy.",
            "type":"integer"
        },
        "globalEnabled":{
            "description":"Whether or not the widget is enabled.",
            "type":"boolean"
        },
        "pageTypes":{
            "description":"List of page types usable with the widget.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "config":{
            "description":"Configuration values for the widget.",
            "additionalProperties":{
            },
            "type":"object"
        }
    }
}

Nested Schema : config

Type: object

Additional Properties Allowed

Show Source

{
    "description":"Configuration values for the widget.",
    "additionalProperties":{
    },
    "type":"object"
}

Configuration values for the widget.

Nested Schema : imports

Type: array

Widget import names.

Show Source

• Array of: string

{
    "description":"Widget import names.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : pageTypes

Type: array

List of page types usable with the widget.

Show Source

• Array of: string

{
    "description":"List of page types usable with the widget.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : translations

Type: array

Widget translations for display name.

Show Source

• Array of: object items

{
    "description":"Widget translations for display name.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"National language text for the display name.",
                "type":"string"
            },
            "language":{
                "description":"Language code.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• language(optional): string
  Language code.
• name(optional): string
  National language text for the display name.

{
    "type":"object",
    "properties":{
        "name":{
            "description":"National language text for the display name.",
            "type":"string"
        },
        "language":{
            "description":"Language code.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "metadata":{
        "imports":[
        ],
        "translations":[
            {
                "name":"Luther",
                "language":"en"
            }
        ],
        "availableToAllPages":true,
        "jsEditable":true,
        "minWidth":1,
        "globalEnabled":true,
        "config":{
        }
    }
}

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