Oracle Commerce Cloud October 2017

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: Type: string

Required: true

setting type

Header Parameters

x-ccsite: Type: string

Required: true

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.

Body

Root Schema : getConfigurationSettings_response

Properties

config: Type: object config

configuration details of the setting
data: Type: object data

property details.

Nested Schema : config

Type: object

configuration details of the setting

Properties

description: Type: string

configuration setting description
displayName: Type: string

display name of the configuration
enabled: Type: boolean

configuration enabled flag
id: Type: string

configuration setting id

Nested Schema : data

Type: object

property details.

Properties

configuration_setting_type: Type: object configuration_setting_type

configuration setting properties

Nested Schema : configuration_setting_type

Type: object

configuration setting properties

Properties

configuration_property_1: Type: string

value of the configuration property 1
configuration_property_2: Type: string

value of the configuration property 2

Example application/json


{
    "data":{
        "cpqConfigSettings":{
            "CPQReConfigurationURL":"http://some.machine.example.com",
            "CPQIFrameURL":"http://some.machine.example.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
    },
    "___etag___":"eyJoYXNoIjoiU0FHdUFDbEhRMzlheURmeXNGNWVHaVNPd2N0Q21GaXpTUFpNcU04MGl5dz0iLCJ1cmkiOiIvY2NhZ2VudHVpL3YxL21lcmNoYW50L2NvbmZpZ3VyYXRpb25TZXR0aW5ncyIsInZlcnNpb24iOjB9"
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: 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

Items

Type: object items

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "data": {"cpqConfigSettings": {
    "CPQReConfigurationURL": "http://some.machine.example.com",
    "CPQIFrameURL": "http://some.machine.example.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
  },
  "___etag___": "eyJoYXNoIjoiU0FHdUFDbEhRMzlheURmeXNGNWVHaVNPd2N0Q21GaXpTUFpNcU04MGl5dz0iLCJ1cmkiOiIvY2NhZ2VudHVpL3YxL21lcmNoYW50L2NvbmZpZ3VyYXRpb25TZXR0aW5ncyIsInZlcnNpb24iOjB9"
}