REST API for Oracle Commerce Cloud December 2017

setSiteSettingConfigData

put

/ccadmin/v1/sitesettings/{id}

Set Site Setting Config Data. Update a Site Settings based on ID and request parameters.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The ID of the site settings.

Body Parameter

Root Schema : setSiteSettingConfigData_request

Example


{
    "properties":{
        "name":"CloudLake US Site test"
    }
}

Properties

properties: Type: object properties

Required: true

Additional Properties Allowed:

Object with updatable properties.

Nested Schema : properties

Type: object

Object with updatable properties.

Properties

name: Type: string

Required: true

Name of the site.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : setSiteSettingConfigData_response

Properties

id: Type: string

ID of the site.

Example application/json


{
    "repositoryId":"siteUS",
    "id":"siteUS"
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |33065|Given Site Settings id does not exist|

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

Additional Properties Allowed:

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

Additional Properties Allowed:

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 Request:

{"properties": {"name": "CloudLake US Site test"}}

Sample Response Payload returned by endpoint:

{
  "repositoryId": "siteUS",
  "id": "siteUS"
}