REST API for Oracle Commerce Cloud

getSelfServiceCacheConfiguration

get

/ccadmin/v1/merchant/selfServiceCacheConfiguration

Get settings for the self service cache configuration

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : getSelfServiceCacheConfiguration_response

Type: object

Show Source

cacheConfiguration: object cacheConfiguration

regular expression of URIs to be cached with the refresh time in minutes.
defaultCacheConfiguration: object defaultCacheConfiguration

regular expression of Default URIs to be cached with the refresh time in minutes.
enabled: boolean

Indicates whether the self service cache is enabled.

{
    "properties":{
        "cacheConfiguration":{
            "description":"regular expression of URIs to be cached with the refresh time in minutes.",
            "type":"object"
        },
        "defaultCacheConfiguration":{
            "description":"regular expression of Default URIs to be cached with the refresh time in minutes.",
            "type":"object"
        },
        "enabled":{
            "description":"Indicates whether the self service cache is enabled.",
            "type":"boolean"
        }
    },
    "example":{
        "cacheConfiguration":{
            "^/ccstore/v1/selfservice/quotes[?]limit=10&offset=0&totalResults=true&orderby=lastUpdatedDate_t:asc$":15,
            "^/ccstore/v1/selfservice/subscriptionProducts[?]orderBy=EndDate:asc&q=SalesProductType='SUBSCRIPTION' AND Status in [(]'ORA_ACTIVE'[)] AND [(]EndDate BETWEEN '\\d{4}\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])' AND '\\d{4}\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])'[)]&totalResults=true$":5
        },
        "defaultCacheConfiguration":{
            "^/ccstore/v1/selfservice/subscriptionProducts[?]orderBy=EndDate:asc&q=SalesProductType='SUBSCRIPTION' AND Status in [(]'ORA_ACTIVE'[)] AND [(]EndDate BETWEEN '\\d{4}\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])' AND '\\d{4}\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])'[)]&totalResults=true$":5
        },
        "enabled":true
    }
}

Example:

{
    "cacheConfiguration":{
        "^/ccstore/v1/selfservice/quotes[?]limit=10&offset=0&totalResults=true&orderby=lastUpdatedDate_t:asc$":15,
        "^/ccstore/v1/selfservice/subscriptionProducts[?]orderBy=EndDate:asc&q=SalesProductType='SUBSCRIPTION' AND Status in [(]'ORA_ACTIVE'[)] AND [(]EndDate BETWEEN '\\d{4}\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])' AND '\\d{4}\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])'[)]&totalResults=true$":5
    },
    "defaultCacheConfiguration":{
        "^/ccstore/v1/selfservice/subscriptionProducts[?]orderBy=EndDate:asc&q=SalesProductType='SUBSCRIPTION' AND Status in [(]'ORA_ACTIVE'[)] AND [(]EndDate BETWEEN '\\d{4}\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])' AND '\\d{4}\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])'[)]&totalResults=true$":5
    },
    "enabled":true
}

Nested Schema : cacheConfiguration

Type: object

regular expression of URIs to be cached with the refresh time in minutes.

Nested Schema : defaultCacheConfiguration

Type: object

regular expression of Default URIs to be cached with the refresh time in minutes.

Example Response (application/json)

{
    "cacheConfiguration":{
        "^/ccstore/v1/selfservice/quotes[?]limit=10&offset=0&totalResults=true&orderby=lastUpdatedDate_t:asc$":15,
        "^/ccstore/v1/selfservice/subscriptionProducts[?]orderBy=EndDate:asc&q=SalesProductType='SUBSCRIPTION' AND Status in [(]'ORA_ACTIVE'[)] AND [(]EndDate BETWEEN '\\d{4}\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])' AND '\\d{4}\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])'[)]&totalResults=true$":5
    },
    "defaultCacheConfiguration":{
        "^/ccstore/v1/selfservice/subscriptionProducts[?]orderBy=EndDate:asc&q=SalesProductType='SUBSCRIPTION' AND Status in [(]'ORA_ACTIVE'[)] AND [(]EndDate BETWEEN '\\d{4}\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])' AND '\\d{4}\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])'[)]&totalResults=true$":5
    },
    "enabled":true
}

Default Response

The error response

Root Schema : errorModel

Type: object

Show Source

devMessage: string

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

The numerical code identifying the error
errors: array errors

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

The localized message describing the error
moreInfo: string

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

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

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

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

The numerical code identifying the error
message: string

The localized message describing the error
moreInfo: string

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

An optional machine readable description of where the error occurred
status: 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"
        }
    }
}