Jump to

• Request
• Response

refreshAllReportCaches

put

/ccadmin/v1/reportCaches

Refresh All Report Caches. Refreshes all the pre-configured report data caches with the updated report data from OBIEE

Request

Supported Media Types

• application/json

Body ()

Root Schema : refreshAllReportCaches_request

Show Source

{
    "properties":{
    },
    "example":{
        "op":"refreshAll"
    }
}

Example:

{
    "op":"refreshAll"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : refreshAllReportCaches_response

Type: object

Show Source

• Dashboard-OrderMetricsSummary-Yesterday-Cache(optional): string
  The cache short description.
• Dashboard-VisitsMetricSummary-Yesterday-Cache(optional): string
  The cache short description.
• FullReports-BillingLocationFilter-Cache(optional): string
  The cache short description.
• FullReports-ConversionsSummary-Last7Days-Cache(optional): string
  The cache short description.
• FullReports-ConversionsTotalCount-Last7Days-Metric(Visits)-GroupBy(Day)-Cache(optional): string
  The cache short description.
• FullReports-DetailedConversionsMetrics-Last7Days-First40Rows-Metric(visits)-GroupBy(Day)-Cache(optional): string
  The cache short description.
• FullReports-DetailedEngagementMetrics-Last7Days-First40Rows-Metric(visits)-GroupBy(Day)-Cache(optional): string
  The cache short description.
• FullReports-DetailedProductMetrics-Last7Days-First40Rows-Metric(GrossRevenue)-GroupBy(Day)-Cache(optional): string
  The cache short description.
• FullReports-DetailedTrafficVolumeMetrics-Last7Days-First40Rows-Metric(visits)-GroupBy(Day)-Cache(optional): string
  The cache short description.
• FullReports-EngagementCount-Last7Days-Metric(Visits)-GroupBy(Day)-Cache(optional): string
  The cache short description.
• FullReports-EngagementSummary-Last7Days-Cache(optional): string
  The cache short description.
• FullReports-LastRefreshDate-Cache(optional): string
  The cache short description.
• FullReports-MinimumReportingDate-Cache(optional): string
  The cache short description.
• FullReports-OrderMetricsSummary-Last7Days-Cache(optional): string
  The cache short description.
• FullReports-OrdersTotalCount-Last7Days-Metric(GrossRevenue)-GroupBy(Day)-Cache(optional): string
  The cache short description.
• FullReports-ProductFilter-Cache(optional): string
  The cache short description.
• FullReports-ProductMetricsSummary-Last7Days-Cache(optional): string
  The cache short description.
• FullReports-ProductsTotalCount-Last7Days-Metric(GrossRevenue)-GroupBy(Day)-Cache(optional): string
  The cache short description.
• FullReports-ShippingLocationFilter-Cache(optional): string
  The cache short description.
• FullReports-TimeFrame-Cache(optional): string
  The cache short description.
• FullReports-Top10-Products-Last7Days-Metric(GrossRevenue)-Cache(optional): string
  The cache short description.
• FullReports-TrafficVolumeSummary-Last7Days-Cache(optional): string
  The cache short description.
• FullReports-TrafficVolumeTotalCount-Last7Days-Metric(Visits)-GroupBy(Day)-Cache(optional): string
  The cache short description.
• FullReports/Dashboard-DetailedOrderMetrics-Last7Days-First40Rows-Metric(GrossRevenue)-GroupBy(Day)-Cache(optional): string
  The cache short description.
• FullReports/Dashboard-DetailedOrderMetrics-Last7Days-First40Rows-Metric(Orders)-GroupBy(Day)-Cache(optional): string
  The cache short description.

{
    "properties":{
        "FullReports-OrdersTotalCount-Last7Days-Metric(GrossRevenue)-GroupBy(Day)-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-ProductFilter-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-OrderMetricsSummary-Last7Days-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-TrafficVolumeTotalCount-Last7Days-Metric(Visits)-GroupBy(Day)-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-LastRefreshDate-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-TimeFrame-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-Top10-Products-Last7Days-Metric(GrossRevenue)-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-ShippingLocationFilter-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-EngagementSummary-Last7Days-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-ConversionsTotalCount-Last7Days-Metric(Visits)-GroupBy(Day)-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-DetailedTrafficVolumeMetrics-Last7Days-First40Rows-Metric(visits)-GroupBy(Day)-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports/Dashboard-DetailedOrderMetrics-Last7Days-First40Rows-Metric(Orders)-GroupBy(Day)-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-ConversionsSummary-Last7Days-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "Dashboard-VisitsMetricSummary-Yesterday-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-DetailedEngagementMetrics-Last7Days-First40Rows-Metric(visits)-GroupBy(Day)-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports/Dashboard-DetailedOrderMetrics-Last7Days-First40Rows-Metric(GrossRevenue)-GroupBy(Day)-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-DetailedProductMetrics-Last7Days-First40Rows-Metric(GrossRevenue)-GroupBy(Day)-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-TrafficVolumeSummary-Last7Days-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-ProductMetricsSummary-Last7Days-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "Dashboard-OrderMetricsSummary-Yesterday-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-DetailedConversionsMetrics-Last7Days-First40Rows-Metric(visits)-GroupBy(Day)-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-EngagementCount-Last7Days-Metric(Visits)-GroupBy(Day)-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-BillingLocationFilter-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-ProductsTotalCount-Last7Days-Metric(GrossRevenue)-GroupBy(Day)-Cache":{
            "description":"The cache short description.",
            "type":"string"
        },
        "FullReports-MinimumReportingDate-Cache":{
            "description":"The cache short description.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "FullReports-OrdersTotalCount-Last7Days-Metric(GrossRevenue)-GroupBy(Day)-Cache":"SUCCESS",
    "FullReports-ProductFilter-Cache":"SUCCESS",
    "FullReports-OrderMetricsSummary-Last7Days-Cache":"SUCCESS",
    "FullReports-TrafficVolumeTotalCount-Last7Days-Metric(Visits)-GroupBy(Day)-Cache":"SUCCESS",
    "FullReports-LastRefreshDate-Cache":"SUCCESS",
    "FullReports-TimeFrame-Cache":"SUCCESS",
    "FullReports-Top10-Products-Last7Days-Metric(GrossRevenue)-Cache":"SUCCESS",
    "FullReports-ShippingLocationFilter-Cache":"SUCCESS",
    "FullReports-EngagementSummary-Last7Days-Cache":"SUCCESS",
    "FullReports-ConversionsTotalCount-Last7Days-Metric(Visits)-GroupBy(Day)-Cache":"SUCCESS",
    "FullReports-DetailedTrafficVolumeMetrics-Last7Days-First40Rows-Metric(visits)-GroupBy(Day)-Cache":"SUCCESS",
    "FullReports/Dashboard-DetailedOrderMetrics-Last7Days-First40Rows-Metric(Orders)-GroupBy(Day)-Cache":"SUCCESS",
    "FullReports-ConversionsSummary-Last7Days-Cache":"SUCCESS",
    "Dashboard-VisitsMetricSummary-Yesterday-Cache":"SUCCESS",
    "FullReports-DetailedEngagementMetrics-Last7Days-First40Rows-Metric(visits)-GroupBy(Day)-Cache":"SUCCESS",
    "FullReports/Dashboard-DetailedOrderMetrics-Last7Days-First40Rows-Metric(GrossRevenue)-GroupBy(Day)-Cache":"SUCCESS",
    "FullReports-DetailedProductMetrics-Last7Days-First40Rows-Metric(GrossRevenue)-GroupBy(Day)-Cache":"SUCCESS",
    "FullReports-TrafficVolumeSummary-Last7Days-Cache":"SUCCESS",
    "FullReports-ProductMetricsSummary-Last7Days-Cache":"SUCCESS",
    "Dashboard-OrderMetricsSummary-Yesterday-Cache":"SUCCESS",
    "FullReports-DetailedConversionsMetrics-Last7Days-First40Rows-Metric(visits)-GroupBy(Day)-Cache":"SUCCESS",
    "FullReports-EngagementCount-Last7Days-Metric(Visits)-GroupBy(Day)-Cache":"SUCCESS",
    "FullReports-BillingLocationFilter-Cache":"SUCCESS",
    "FullReports-ProductsTotalCount-Last7Days-Metric(GrossRevenue)-GroupBy(Day)-Cache":"SUCCESS",
    "FullReports-MinimumReportingDate-Cache":"SUCCESS"
}

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| |------------------|------------------| |94028|Empty report cache parameters.| |94005|Invalid enum input error.| |94027|Failed to get report cache data.| |94004|Report data parsing error.| |94026|Invalid report data cache.| |94003|Product filter transform error.| |94025|Empty report cache ID.| |94009|Error in getting report data.| |94007|Input validation error.| |94029|Refresh all report data cache error.| |94002|Location filter transform error.| |94024|List report data cache error.| |94001|Product filter parsing error.| |94023|Unconfigured report variable.| |94000|Location filter parsing error.| |94022|Failed to get OBIEE analysis.| |94021|Invalid OBIEE analysis.| |94015|Report not configured error.| |94014|Log off to OBIEE failed.| |94019|Unsupported chart data error.| |94018|Unsupported report data error.| |94030|Inconsistent source response error.| |94013|Failed to get session from OBIEE.| |94012|Failed to get data from OBIEE.| |94034|Credential properties retrieval error.| |94033|Credential properties not set error.| |94032|Get data collection date error.|

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