REST API for Oracle Commerce Cloud 21C

getConfigDefinitionForWidgetDescriptor

get

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

Get Config Definition For Widget Descriptor. Get the Config Definition for the Widget Descriptor

Request

Supported Media Types

application/json

Path Parameters

id: string

the widget type id

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : getConfigDefinitionForWidgetDescriptor_response

Type: object

Show Source

items(optional): object items

response

{
    "properties":{
        "items":{
            "description":"response",
            "type":"object",
            "properties":{
                "values":{
                    "description":"Values array",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "helpText":{
                                "description":"The help text to be displayed Design Studio.",
                                "type":"string"
                            },
                            "defaultValue":{
                                "description":"The default value.",
                                "type":"string"
                            },
                            "minLength":{
                                "description":"Maximum length of the string value.",
                                "type":"integer"
                            },
                            "label":{
                                "description":"The label to be displayed in Design Studio.",
                                "type":"string"
                            },
                            "type":{
                                "description":"The type of this value it can be text.",
                                "type":"string"
                            },
                            "required":{
                                "description":"Validation is this value field required.",
                                "type":"boolean"
                            },
                            "displayOnInstances":{
                                "description":"Display on instances.",
                                "type":"string"
                            },
                            "name":{
                                "description":"Name of the value.",
                                "type":"string"
                            },
                            "repositoryId":{
                                "description":"The Repository Id",
                                "type":"string"
                            },
                            "options":{
                                "description":"Array of options to choose.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "displayText":{
                                            "description":"The option display text",
                                            "type":"string"
                                        },
                                        "value":{
                                            "description":"The option value",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "regexText":{
                                "description":"Regular expression text for validation.",
                                "type":"string"
                            },
                            "displayAsCheckboxes":{
                                "description":"When value is a list, display this list as checkboxes",
                                "type":"boolean"
                            },
                            "maxLength":{
                                "description":"Maximum length of the string value.",
                                "type":"integer"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

response

Show Source

values(optional): array values

Values array

{
    "description":"response",
    "type":"object",
    "properties":{
        "values":{
            "description":"Values array",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "helpText":{
                        "description":"The help text to be displayed Design Studio.",
                        "type":"string"
                    },
                    "defaultValue":{
                        "description":"The default value.",
                        "type":"string"
                    },
                    "minLength":{
                        "description":"Maximum length of the string value.",
                        "type":"integer"
                    },
                    "label":{
                        "description":"The label to be displayed in Design Studio.",
                        "type":"string"
                    },
                    "type":{
                        "description":"The type of this value it can be text.",
                        "type":"string"
                    },
                    "required":{
                        "description":"Validation is this value field required.",
                        "type":"boolean"
                    },
                    "displayOnInstances":{
                        "description":"Display on instances.",
                        "type":"string"
                    },
                    "name":{
                        "description":"Name of the value.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The Repository Id",
                        "type":"string"
                    },
                    "options":{
                        "description":"Array of options to choose.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "displayText":{
                                    "description":"The option display text",
                                    "type":"string"
                                },
                                "value":{
                                    "description":"The option value",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "regexText":{
                        "description":"Regular expression text for validation.",
                        "type":"string"
                    },
                    "displayAsCheckboxes":{
                        "description":"When value is a list, display this list as checkboxes",
                        "type":"boolean"
                    },
                    "maxLength":{
                        "description":"Maximum length of the string value.",
                        "type":"integer"
                    }
                }
            }
        }
    }
}

Nested Schema : values

Type: array

Values array

Show Source

Array of: object items

{
    "description":"Values array",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "helpText":{
                "description":"The help text to be displayed Design Studio.",
                "type":"string"
            },
            "defaultValue":{
                "description":"The default value.",
                "type":"string"
            },
            "minLength":{
                "description":"Maximum length of the string value.",
                "type":"integer"
            },
            "label":{
                "description":"The label to be displayed in Design Studio.",
                "type":"string"
            },
            "type":{
                "description":"The type of this value it can be text.",
                "type":"string"
            },
            "required":{
                "description":"Validation is this value field required.",
                "type":"boolean"
            },
            "displayOnInstances":{
                "description":"Display on instances.",
                "type":"string"
            },
            "name":{
                "description":"Name of the value.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The Repository Id",
                "type":"string"
            },
            "options":{
                "description":"Array of options to choose.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "displayText":{
                            "description":"The option display text",
                            "type":"string"
                        },
                        "value":{
                            "description":"The option value",
                            "type":"string"
                        }
                    }
                }
            },
            "regexText":{
                "description":"Regular expression text for validation.",
                "type":"string"
            },
            "displayAsCheckboxes":{
                "description":"When value is a list, display this list as checkboxes",
                "type":"boolean"
            },
            "maxLength":{
                "description":"Maximum length of the string value.",
                "type":"integer"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

defaultValue(optional): string

The default value.
displayAsCheckboxes(optional): boolean

When value is a list, display this list as checkboxes
displayOnInstances(optional): string

Display on instances.
helpText(optional): string

The help text to be displayed Design Studio.
label(optional): string

The label to be displayed in Design Studio.
maxLength(optional): integer

Maximum length of the string value.
minLength(optional): integer

Maximum length of the string value.
name(optional): string

Name of the value.
options(optional): array options

Array of options to choose.
regexText(optional): string

Regular expression text for validation.
repositoryId(optional): string

The Repository Id
required(optional): boolean

Validation is this value field required.
type(optional): string

The type of this value it can be text.

{
    "type":"object",
    "properties":{
        "helpText":{
            "description":"The help text to be displayed Design Studio.",
            "type":"string"
        },
        "defaultValue":{
            "description":"The default value.",
            "type":"string"
        },
        "minLength":{
            "description":"Maximum length of the string value.",
            "type":"integer"
        },
        "label":{
            "description":"The label to be displayed in Design Studio.",
            "type":"string"
        },
        "type":{
            "description":"The type of this value it can be text.",
            "type":"string"
        },
        "required":{
            "description":"Validation is this value field required.",
            "type":"boolean"
        },
        "displayOnInstances":{
            "description":"Display on instances.",
            "type":"string"
        },
        "name":{
            "description":"Name of the value.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The Repository Id",
            "type":"string"
        },
        "options":{
            "description":"Array of options to choose.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayText":{
                        "description":"The option display text",
                        "type":"string"
                    },
                    "value":{
                        "description":"The option value",
                        "type":"string"
                    }
                }
            }
        },
        "regexText":{
            "description":"Regular expression text for validation.",
            "type":"string"
        },
        "displayAsCheckboxes":{
            "description":"When value is a list, display this list as checkboxes",
            "type":"boolean"
        },
        "maxLength":{
            "description":"Maximum length of the string value.",
            "type":"integer"
        }
    }
}

Nested Schema : options

Type: array

Array of options to choose.

Show Source

Array of: object items

{
    "description":"Array of options to choose.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayText":{
                "description":"The option display text",
                "type":"string"
            },
            "value":{
                "description":"The option value",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

displayText(optional): string

The option display text
value(optional): string

The option value

{
    "type":"object",
    "properties":{
        "displayText":{
            "description":"The option display text",
            "type":"string"
        },
        "value":{
            "description":"The option value",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "values":[
        {
            "helpText":"Enter the number of items you want to display in the mini cart before scrolling is required.",
            "defaultValue":"3",
            "minLength":0,
            "label":"Number of items in mini cart before scrolling",
            "type":"text",
            "required":true,
            "displayOnInstances":null,
            "name":"miniCartNumberOfItems",
            "repositoryId":"100004",
            "options":[
            ],
            "regexText":null,
            "displayAsCheckboxes":false,
            "maxLength":1000
        },
        {
            "helpText":"Set whether mini-cart should be displayed for 'add to cart' notification.",
            "defaultValue":"true",
            "minLength":0,
            "label":"Display Mini-Cart",
            "type":"checkbox",
            "required":false,
            "displayOnInstances":null,
            "name":"displayMiniCart",
            "repositoryId":"100005",
            "options":[
            ],
            "regexText":null,
            "displayAsCheckboxes":false,
            "maxLength":1000
        },
        {
            "helpText":"Set the duration for the display of the mini-cart (in secs).",
            "defaultValue":"5",
            "minLength":0,
            "label":"Duration (in secs)",
            "type":"text",
            "required":true,
            "displayOnInstances":null,
            "name":"miniCartDuration",
            "repositoryId":"100006",
            "options":[
            ],
            "regexText":null,
            "displayAsCheckboxes":false,
            "maxLength":1000
        }
    ],
    "repositoryId":"headerWidget",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/widgetDescriptors/headerWidget/config"
        }
    ],
    "___etag___":"eyJoYXNoIjoiaG5KcDB0QU83eGphc0dKYVVlRXR5UUZGSG1acldFRWU2cGVGV1lXd25aRT0iLCJ1cmkiOiIvY2NhZG1pbnVpL3YxL3dpZGdldERlc2NyaXB0b3JzL2hlYWRlcldpZGdldC9jb25maWciLCJ2ZXJzaW9uIjowfQ=="
}

Default Response

The error response

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"
        }
    }
}