Retrieve config definition for a slot descriptor
get
/ccadmin/v1/slotDescriptors/{id}/config
Retrieves the configuration definition for a Slot Descriptor.
This configuration definition can then be used to dynamically build the UI for the Slot Descriptor's configuration settings.
Information returned about a configuration setting include the setting type, if it has default values and its max length of data.
Note: In order to use this endpoint, a Slot Descriptor's ID is required.
This configuration definition can then be used to dynamically build the UI for the Slot Descriptor's configuration settings.
Information returned about a configuration setting include the setting type, if it has default values and its max length of data.
Note: In order to use this endpoint, a Slot Descriptor's ID is required.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The Slot Descriptor's ID.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getConfigDefinitionForSlotDescriptor_response
Type:
Show Source
object
-
repositoryId(optional):
string
ID for the slot type in the repository
-
values(optional):
array values
Array of configurable properties for this slot type
Nested Schema : items
Type:
Show Source
object
-
defaultValue(optional):
string
The default value for the property
-
displayAsCheckboxes(optional):
boolean
description of displayAsCheckboxes
-
displayOnInstances(optional):
boolean
description of displayOnInstances
-
helpText(optional):
string
Help text to display with property
-
label(optional):
string
Label text to display with property
-
maxLength(optional):
integer
Maximum length value for the property
-
minLength(optional):
integer
Minimum length value for the property
-
name(optional):
string
Name for the property
-
options(optional):
array options
List of option values where property is a select/drop-down
-
regexText(optional):
string
Regular expression pattern for validation of the property value
-
repositoryId(optional):
string
ID for the property in the repository
-
required(optional):
boolean
Whether or not a value must be supplied for the property
-
type(optional):
string
Type of the property
Nested Schema : options
Type:
array
List of option values where property is a select/drop-down
Show Source
Example Response (application/json)
{
"values":[
{
"helpText":"Whether this slot is active",
"defaultValue":"true",
"minLength":0,
"label":"Enable Slot",
"type":"checkbox",
"required":false,
"displayOnInstances":null,
"name":null,
"repositoryId":"enableSlot",
"options":[
],
"regexText":null,
"displayAsCheckboxes":false,
"maxLength":1000
}
],
"repositoryId":"randomSlot",
"links":[
{
"rel":"self",
"href":"slotDescriptors/randomSlot/config"
}
]
}
Default Response
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
The error response:
Error Code | Description | |
---|---|---|
000000 | Config Definition not found | Ensure you have specified a valid slot descriptor id. |
The error response:
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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