Jump to

• Request
• Response

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.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The Slot Descriptor's ID.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getConfigDefinitionForSlotDescriptor_response

Type: object

Show Source

• repositoryId(optional): string
  ID for the slot type in the repository
• values(optional): array values
  Array of configurable properties for this slot type

{
    "properties":{
        "values":{
            "description":"Array of configurable properties for this slot type",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "helpText":{
                        "description":"Help text to display with property",
                        "type":"string"
                    },
                    "defaultValue":{
                        "description":"The default value for the property",
                        "type":"string"
                    },
                    "minLength":{
                        "description":"Minimum length value for the property",
                        "type":"integer"
                    },
                    "label":{
                        "description":"Label text to display with property",
                        "type":"string"
                    },
                    "type":{
                        "description":"Type of the property",
                        "type":"string"
                    },
                    "required":{
                        "description":"Whether or not a value must be supplied for the property",
                        "type":"boolean"
                    },
                    "displayOnInstances":{
                        "description":"description of displayOnInstances",
                        "type":"boolean"
                    },
                    "name":{
                        "description":"Name for the property",
                        "type":"string"
                    },
                    "options":{
                        "description":"List of option values where property is a select/drop-down",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "repositoryId":{
                        "description":"ID for the property in the repository",
                        "type":"string"
                    },
                    "regexText":{
                        "description":"Regular expression pattern for validation of the property value",
                        "type":"string"
                    },
                    "displayAsCheckboxes":{
                        "description":"description of displayAsCheckboxes",
                        "type":"boolean"
                    },
                    "maxLength":{
                        "description":"Maximum length value for the property",
                        "type":"integer"
                    }
                }
            }
        },
        "repositoryId":{
            "description":"ID for the slot type in the repository",
            "type":"string"
        }
    }
}

Nested Schema : values

Type: array

Array of configurable properties for this slot type

Show Source

• Array of: object items

{
    "description":"Array of configurable properties for this slot type",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "helpText":{
                "description":"Help text to display with property",
                "type":"string"
            },
            "defaultValue":{
                "description":"The default value for the property",
                "type":"string"
            },
            "minLength":{
                "description":"Minimum length value for the property",
                "type":"integer"
            },
            "label":{
                "description":"Label text to display with property",
                "type":"string"
            },
            "type":{
                "description":"Type of the property",
                "type":"string"
            },
            "required":{
                "description":"Whether or not a value must be supplied for the property",
                "type":"boolean"
            },
            "displayOnInstances":{
                "description":"description of displayOnInstances",
                "type":"boolean"
            },
            "name":{
                "description":"Name for the property",
                "type":"string"
            },
            "options":{
                "description":"List of option values where property is a select/drop-down",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "repositoryId":{
                "description":"ID for the property in the repository",
                "type":"string"
            },
            "regexText":{
                "description":"Regular expression pattern for validation of the property value",
                "type":"string"
            },
            "displayAsCheckboxes":{
                "description":"description of displayAsCheckboxes",
                "type":"boolean"
            },
            "maxLength":{
                "description":"Maximum length value for the property",
                "type":"integer"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "helpText":{
            "description":"Help text to display with property",
            "type":"string"
        },
        "defaultValue":{
            "description":"The default value for the property",
            "type":"string"
        },
        "minLength":{
            "description":"Minimum length value for the property",
            "type":"integer"
        },
        "label":{
            "description":"Label text to display with property",
            "type":"string"
        },
        "type":{
            "description":"Type of the property",
            "type":"string"
        },
        "required":{
            "description":"Whether or not a value must be supplied for the property",
            "type":"boolean"
        },
        "displayOnInstances":{
            "description":"description of displayOnInstances",
            "type":"boolean"
        },
        "name":{
            "description":"Name for the property",
            "type":"string"
        },
        "options":{
            "description":"List of option values where property is a select/drop-down",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "repositoryId":{
            "description":"ID for the property in the repository",
            "type":"string"
        },
        "regexText":{
            "description":"Regular expression pattern for validation of the property value",
            "type":"string"
        },
        "displayAsCheckboxes":{
            "description":"description of displayAsCheckboxes",
            "type":"boolean"
        },
        "maxLength":{
            "description":"Maximum length value for the property",
            "type":"integer"
        }
    }
}

Nested Schema : options

Type: array

List of option values where property is a select/drop-down

Show Source

• Array of: string

{
    "description":"List of option values where property is a select/drop-down",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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:

Error Code	Description
000000	Config Definition not found	Ensure you have specified a valid slot descriptor id.

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