Jump to

• Request
• Response

getConfigMetadataForWidgetDescriptor

get

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

Gets the user modifiable config metadata for a 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 : configMetadataForWidgetDescriptor

Type: object

Show Source

• items(optional): object items
  response

{
    "properties":{
        "items":{
            "description":"response",
            "type":"object",
            "properties":{
                "metadata":{
                    "description":"Metadata structure",
                    "type":"object",
                    "properties":{
                        "widgetDescriptorName":{
                            "description":"The short name of the widget descriptor aka widget type.",
                            "type":"string"
                        },
                        "properties":{
                            "description":"Array of metadata properties.",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "defaultValue":{
                                        "description":"Default value for the property.",
                                        "type":"string"
                                    },
                                    "name":{
                                        "description":"Internal name for the property.",
                                        "type":"string"
                                    },
                                    "options":{
                                        "description":"Describes possible values for an optionType property.",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "id":{
                                                    "description":"ID of option.",
                                                    "type":"string"
                                                },
                                                "labelResourceId":{
                                                    "description":"ID of option text.",
                                                    "type":"string"
                                                },
                                                "value":{
                                                    "description":"Value to use for option if it is selected.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "id":{
                                        "description":"Identifier for the property.",
                                        "type":"string"
                                    },
                                    "helpTextResourceId":{
                                        "description":"ID of property help text.",
                                        "type":"string"
                                    },
                                    "labelResourceId":{
                                        "description":"ID of property label text.",
                                        "type":"string"
                                    },
                                    "type":{
                                        "description":"The property type.",
                                        "type":"string"
                                    },
                                    "required":{
                                        "description":"Whether or not the property must contain a value.",
                                        "type":"boolean"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

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":{
                "widgetDescriptorName":{
                    "description":"The short name of the widget descriptor aka widget type.",
                    "type":"string"
                },
                "properties":{
                    "description":"Array of metadata properties.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "defaultValue":{
                                "description":"Default value for the property.",
                                "type":"string"
                            },
                            "name":{
                                "description":"Internal name for the property.",
                                "type":"string"
                            },
                            "options":{
                                "description":"Describes possible values for an optionType property.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "id":{
                                            "description":"ID of option.",
                                            "type":"string"
                                        },
                                        "labelResourceId":{
                                            "description":"ID of option text.",
                                            "type":"string"
                                        },
                                        "value":{
                                            "description":"Value to use for option if it is selected.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "id":{
                                "description":"Identifier for the property.",
                                "type":"string"
                            },
                            "helpTextResourceId":{
                                "description":"ID of property help text.",
                                "type":"string"
                            },
                            "labelResourceId":{
                                "description":"ID of property label text.",
                                "type":"string"
                            },
                            "type":{
                                "description":"The property type.",
                                "type":"string"
                            },
                            "required":{
                                "description":"Whether or not the property must contain a value.",
                                "type":"boolean"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : metadata

Type: object

Metadata structure

Show Source

• properties(optional): array properties
  Array of metadata properties.
• widgetDescriptorName(optional): string
  The short name of the widget descriptor aka widget type.

{
    "description":"Metadata structure",
    "type":"object",
    "properties":{
        "widgetDescriptorName":{
            "description":"The short name of the widget descriptor aka widget type.",
            "type":"string"
        },
        "properties":{
            "description":"Array of metadata properties.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "defaultValue":{
                        "description":"Default value for the property.",
                        "type":"string"
                    },
                    "name":{
                        "description":"Internal name for the property.",
                        "type":"string"
                    },
                    "options":{
                        "description":"Describes possible values for an optionType property.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "id":{
                                    "description":"ID of option.",
                                    "type":"string"
                                },
                                "labelResourceId":{
                                    "description":"ID of option text.",
                                    "type":"string"
                                },
                                "value":{
                                    "description":"Value to use for option if it is selected.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "id":{
                        "description":"Identifier for the property.",
                        "type":"string"
                    },
                    "helpTextResourceId":{
                        "description":"ID of property help text.",
                        "type":"string"
                    },
                    "labelResourceId":{
                        "description":"ID of property label text.",
                        "type":"string"
                    },
                    "type":{
                        "description":"The property type.",
                        "type":"string"
                    },
                    "required":{
                        "description":"Whether or not the property must contain a value.",
                        "type":"boolean"
                    }
                }
            }
        }
    }
}

Nested Schema : properties

Type: array

Array of metadata properties.

Show Source

• Array of: object items

{
    "description":"Array of metadata properties.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "defaultValue":{
                "description":"Default value for the property.",
                "type":"string"
            },
            "name":{
                "description":"Internal name for the property.",
                "type":"string"
            },
            "options":{
                "description":"Describes possible values for an optionType property.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "id":{
                            "description":"ID of option.",
                            "type":"string"
                        },
                        "labelResourceId":{
                            "description":"ID of option text.",
                            "type":"string"
                        },
                        "value":{
                            "description":"Value to use for option if it is selected.",
                            "type":"string"
                        }
                    }
                }
            },
            "id":{
                "description":"Identifier for the property.",
                "type":"string"
            },
            "helpTextResourceId":{
                "description":"ID of property help text.",
                "type":"string"
            },
            "labelResourceId":{
                "description":"ID of property label text.",
                "type":"string"
            },
            "type":{
                "description":"The property type.",
                "type":"string"
            },
            "required":{
                "description":"Whether or not the property must contain a value.",
                "type":"boolean"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• defaultValue(optional): string
  Default value for the property.
• helpTextResourceId(optional): string
  ID of property help text.
• id(optional): string
  Identifier for the property.
• labelResourceId(optional): string
  ID of property label text.
• name(optional): string
  Internal name for the property.
• options(optional): array options
  Describes possible values for an optionType property.
• required(optional): boolean
  Whether or not the property must contain a value.
• type(optional): string
  The property type.

{
    "type":"object",
    "properties":{
        "defaultValue":{
            "description":"Default value for the property.",
            "type":"string"
        },
        "name":{
            "description":"Internal name for the property.",
            "type":"string"
        },
        "options":{
            "description":"Describes possible values for an optionType property.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"ID of option.",
                        "type":"string"
                    },
                    "labelResourceId":{
                        "description":"ID of option text.",
                        "type":"string"
                    },
                    "value":{
                        "description":"Value to use for option if it is selected.",
                        "type":"string"
                    }
                }
            }
        },
        "id":{
            "description":"Identifier for the property.",
            "type":"string"
        },
        "helpTextResourceId":{
            "description":"ID of property help text.",
            "type":"string"
        },
        "labelResourceId":{
            "description":"ID of property label text.",
            "type":"string"
        },
        "type":{
            "description":"The property type.",
            "type":"string"
        },
        "required":{
            "description":"Whether or not the property must contain a value.",
            "type":"boolean"
        }
    }
}

Nested Schema : options

Type: array

Describes possible values for an optionType property.

Show Source

• Array of: object items

{
    "description":"Describes possible values for an optionType property.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"ID of option.",
                "type":"string"
            },
            "labelResourceId":{
                "description":"ID of option text.",
                "type":"string"
            },
            "value":{
                "description":"Value to use for option if it is selected.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  ID of option.
• labelResourceId(optional): string
  ID of option text.
• value(optional): string
  Value to use for option if it is selected.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"ID of option.",
            "type":"string"
        },
        "labelResourceId":{
            "description":"ID of option text.",
            "type":"string"
        },
        "value":{
            "description":"Value to use for option if it is selected.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "metadata":{
        "widgetDescriptorName":"luther",
        "properties":[
            {
                "name":"exampleStringProperty",
                "id":"exampleStringProperty",
                "helpTextResourceId":"exampleStringPropertyHelpText",
                "labelResourceId":"exampleStringPropertyLabel",
                "type":"stringType",
                "required":true
            },
            {
                "defaultValue":"option1",
                "name":"exampleOptionProperty",
                "options":[
                    {
                        "id":"exampleOption1",
                        "labelResourceId":"exampleOption1Label",
                        "value":"exampleOption1"
                    },
                    {
                        "id":"exampleOption2",
                        "labelResourceId":"exampleOption2Label",
                        "value":"exampleOption2"
                    },
                    {
                        "id":"exampleOption3",
                        "labelResourceId":"exampleOption3Label",
                        "value":"exampleOption3"
                    }
                ],
                "id":"exampleOptionProperty",
                "helpTextResourceId":"exampleOptionPropertyHelpText",
                "labelResourceId":"exampleOptionPropertyLabel",
                "type":"optionType"
            },
            {
                "defaultValue":true,
                "name":"exampleBooleanProperty",
                "id":"exampleBooleanProperty",
                "helpTextResourceId":"exampleBooleanPropertyHelpText",
                "labelResourceId":"exampleBooleanPropertyLabel",
                "type":"booleanType"
            }
        ]
    }
}

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