Salesforce B2C Commerce 24.7 > Open Commerce API 23.2 > Data API resources 23.2

Settings resource (Data API 23.2)

Summary

Http Method	Resource	Description
GET	/settings/logging/custom	Action to get custom log settings.
PATCH	/settings/logging/custom	Updates the custom log settings.

Get Custom Log Settings

Action to get custom log settings.

Url

GET https://hostname:port/dw/data/v23_2/settings/logging/custom

Formats

json, xml

Authentication

Name	Description
OAuth	Authentication via OAuth token.

Response Document

CustomLogSettings

Sample

REQUEST:
GET /s/-/dw/data/v23_2/settings/logging/custom HTTP/1.1
Host: example.com
Authorization: Bearer a5b6eb0d-8312-41a3-88f3-2c53c4507367
Content-Type: application/json; charset=UTF-8

# in case of success:

RESPONSE:
HTTP/1.1 200 OK
{
   "_v" : "23.2",
   "_resource_state" : "860cde3040519cce439cd99e209f8a87c3ad0b7e2813edbf6f5501f763b73bd5",
   "_type" : "custom_log_settings",
   "debug_to_file" : false,
   "info_to_file" : false,
   "error_to_file" : true,
   "fatal_to_file" : true,
   "warn_to_file" : true,
   "debug_permitted": true,
   "email_to" : "[email protected]",
   "root_level" : "WARN"
}

Update Custom Log Settings

Updates the custom log settings.

Url

PATCH https://hostname:port/dw/data/v23_2/settings/logging/custom

Formats

json, xml

Authentication

Name	Description
OAuth	Authentication via OAuth token.

Request Document

CustomLogSettings

Response Document

CustomLogSettings

In case of a failure Fault Document is returned.

Faults

Status	Type	Arguments	Description
400	`InvalidRecipientEmailException`	email (String)	if the email addresses are invalid.
400	`InvalidCustomLogCategoryException`		if one of the categories names are invalid.
400	`InvalidLogLevelException`		if on a production instance the configured level is DEBUG.

Sample

REQUEST:
PATCH /s/-/dw/data/v23_2/settings/logging/custom HTTP/1.1
Host: example.com
Authorization: Bearer a5b6eb0d-8312-41a3-88f3-2c53c4507367
Content-Type: application/json; charset=UTF-8
{
   "_resource_state" : "847f9c3c5867f641470b3046aeec31f07757991b792d722e10079926f7a289fb",
   debug_to_file : false,
   info_to_file : false,
   error_to_file : true,
   fatal_to_file : true,
   warn_to_file : true,
   email_to : "[email protected]",
   root_level : "ERROR"
}

# in case of success:

RESPONSE:
HTTP/1.1 200 OK
{
   "_v" : "23.2",
   "_resource_state" : "860cde3040519cce439cd99e209f8a87c3ad0b7e2813edbf6f5501f763b73bd5",
   "_type" : "custom_log_settings",
   "debug_to_file" : false,
   "info_to_file" : false,
   "error_to_file" : true,
   "fatal_to_file" : true,
   "warn_to_file" : true,
   "debug_permitted": true,
   "email_to" : "[email protected]",
   "root_level" : "ERROR"
}

# in case of failure:

RESPONSE:
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
{
   "_v" : "23.2",
   "fault" :
   {
      "type" : "InvalidEmailToAddressException",
      "message" : "The email address is invalid."
   }
}

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.