Jump to

• Request
• Response

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: string
  setting type

Header Parameters

• x-ccsite: string
  the site id corresponding to which site specific properties should be get

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getConfigurationSettings_response

Type: object

Show Source

• config(optional): object config
  configuration details of the setting
• data(optional): object data
  property details.

{
    "properties":{
        "data":{
            "description":"property details.",
            "type":"object",
            "properties":{
                "configuration_setting_type":{
                    "description":"configuration setting properties",
                    "type":"object",
                    "properties":{
                        "configuration_property_2":{
                            "description":"value of the configuration property 2",
                            "type":"string"
                        },
                        "configuration_property_1":{
                            "description":"value of the configuration property 1",
                            "type":"string"
                        }
                    }
                }
            }
        },
        "config":{
            "description":"configuration details of the setting",
            "type":"object",
            "properties":{
                "displayName":{
                    "description":"display name of the configuration",
                    "type":"string"
                },
                "description":{
                    "description":"configuration setting description",
                    "type":"string"
                },
                "id":{
                    "description":"configuration setting id",
                    "type":"string"
                },
                "enabled":{
                    "description":"configuration enabled flag",
                    "type":"boolean"
                }
            }
        }
    }
}

Nested Schema : config

Type: object

configuration details of the setting

Show Source

• description(optional): string
  configuration setting description
• displayName(optional): string
  display name of the configuration
• enabled(optional): boolean
  configuration enabled flag
• id(optional): string
  configuration setting id

{
    "description":"configuration details of the setting",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"display name of the configuration",
            "type":"string"
        },
        "description":{
            "description":"configuration setting description",
            "type":"string"
        },
        "id":{
            "description":"configuration setting id",
            "type":"string"
        },
        "enabled":{
            "description":"configuration enabled flag",
            "type":"boolean"
        }
    }
}

Nested Schema : data

Type: object

property details.

Show Source

• configuration_setting_type(optional): object configuration_setting_type
  configuration setting properties

{
    "description":"property details.",
    "type":"object",
    "properties":{
        "configuration_setting_type":{
            "description":"configuration setting properties",
            "type":"object",
            "properties":{
                "configuration_property_2":{
                    "description":"value of the configuration property 2",
                    "type":"string"
                },
                "configuration_property_1":{
                    "description":"value of the configuration property 1",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : configuration_setting_type

Type: object

configuration setting properties

Show Source

• configuration_property_1(optional): string
  value of the configuration property 1
• configuration_property_2(optional): string
  value of the configuration property 2

{
    "description":"configuration setting properties",
    "type":"object",
    "properties":{
        "configuration_property_2":{
            "description":"value of the configuration property 2",
            "type":"string"
        },
        "configuration_property_1":{
            "description":"value of the configuration property 1",
            "type":"string"
        }
    }
}

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

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