getConfigurationSettings
get
/ccagent/v1/merchant/configurationSettings
Get Configuration Settings. To get the configuration details of a given configuration type
Request
Supported Media Types
- application/json
Query Parameters
-
type(required): string
setting type
Header Parameters
-
x-ccsite(required): string
the site id corresponding to which site specific properties should be get
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getConfigurationSettings_response
Type:
Show Source
object
-
config:
object config
configuration details of the setting
-
data:
object data
property details.
Nested Schema : config
Type:
object
configuration details of the setting
Show Source
-
description:
string
configuration setting description
-
displayName:
string
display name of the configuration
-
enabled:
boolean
configuration enabled flag
-
id:
string
configuration setting id
Nested Schema : data
Type:
object
property details.
Show Source
-
configuration_setting_type:
object configuration_setting_type
configuration setting properties
Nested Schema : configuration_setting_type
Type:
object
configuration setting properties
Show Source
-
configuration_property_1:
string
value of the configuration property 1
-
configuration_property_2:
string
value of the configuration property 2
Example Response (application/json)
{
"data":{
"cpqConfigSettings":{
"CPQReConfigurationURL":"http://slc10gpm.us.oracle.com",
"CPQIFrameURL":"http://slc10gpm.us.oracle.com"
}
},
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagentui/v1/merchant/configurationSettings?type=CPQConfigurationSettings"
}
],
"config":{
"displayName":"CPQ Configuration",
"description":"CPQ Configuration Settings",
"id":"CPQConfigurationSettings",
"enabled":true
}
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code