Jump to

• Request
• Response

Update the compilation settings for themes

put

/ccadmin/v1/themes/compilationSettings

Sets the theme compilation settings

Request

Supported Media Types

• application/json

Body ()

Root Schema : setCompilationSettings_request

Type: object

Show Source

• compileThemesAutomatically: boolean
  Whether themes will be compiled automatically as layouts and widgets are updated

{
    "properties":{
        "compileThemesAutomatically":{
            "description":"Whether themes will be compiled automatically as layouts and widgets are updated",
            "type":"boolean"
        }
    },
    "required":[
        "compileThemesAutomatically"
    ],
    "example":{
        "compileThemesAutomatically":false
    }
}

Example:

{
    "compileThemesAutomatically":false
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : setCompilationSettings_response

Type: object

Show Source

• compileThemesAutomatically(optional): boolean
  Whether themes will be compiled automatically as layouts and widgets are updated

{
    "properties":{
        "compileThemesAutomatically":{
            "description":"Whether themes will be compiled automatically as layouts and widgets are updated",
            "type":"boolean"
        }
    }
}

Example Response (application/json)

{
    "compileThemesAutomatically":false,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/themes/compilationSettings"
        }
    ]
}

400 Response

The compilation settings cannot be saved.

Body ()

Root Schema : setCompilationSettings_400response

Type: object

Show Source

• errorCode(optional): string
  The error code
• message(optional): string
  The localized message describing the error
• status(optional): string
  HTTP status code

{
    "properties":{
        "errorCode":{
            "description":"The error code",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "errorCode":"70031",
    "message":"Unable to save configuration data",
    "status":"400"
}

Default Response

The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:

Error Code	Description	Possible Fix
70030	Invalid compilation setting specified.	Revise the specified compilation settings.
70031	Unable to save compilation settings.	See returned error message for further information.

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