updateReportFilterConfiguration
put
/ccadmin/v1/reportFilterConfigurations/{id}
Update Report Filter Configuration. Update the existing filter configuration for the last run report
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The Repository id of the filter configuration to be updated.
Root Schema : updateReportFilterConfiguration_request
Type:
Show Source
object
-
FilterConfigurationsItem:
object FilterConfigurationsItem
The Filter configurations which is to be updated
Example:
{
"reportingStartDate":"",
"transactionCurrency":"USD",
"billingRegions":[
"US-AB",
"US-AL"
],
"reportingEndDate":"",
"groupBy":"day",
"shippingCountries":[
"AS"
],
"timeFrame":"yesterday",
"priceListGroups":[
"UsDollar"
],
"billingCountries":[
"AS"
],
"metric":"grossRevenue",
"productIds":[
],
"shippingRegions":[
"US-AB",
"US-AL"
],
"context":"orders",
"siteIds":[
"siteUS"
]
}
Nested Schema : FilterConfigurationsItem
Type:
object
The Filter configurations which is to be updated
Show Source
-
billingCountries(optional):
array billingCountries
BillingCountries with all regions selected in the filter option
-
billingRegions(optional):
array billingRegions
BillingRegions Codes of the regions selected in the filter option
-
context:
string
Context selected in the filters.
-
groupBy(optional):
string
groupBy option selected in the filters
-
metric:
string
Metric selected in the filters
-
priceListGroup(optional):
string
Pricelist groups as comma separted string
-
productIds(optional):
array productIds
Product Ids of the products selected in the filter option
-
reportingEndDate(optional):
string
ReportingEndDate selected in the filters.
-
reportingStartDate(optional):
string
ReportingStartDate selected in the filters
-
shippingCountries(optional):
array shippingCountries
ShippingCountries with all regions selected in the filter option
-
shippingRegions(optional):
array shippingRegions
ShippingRegions Codes of the regions selected in the filter option
-
siteIds(optional):
array siteIds
Site Ids of the sites selected in the filter option
-
timeFrame:
string
TimeFrame selected in the filters.
-
transactionCurrency(optional):
string
currency for the reporting data
Nested Schema : billingCountries
Type:
array
BillingCountries with all regions selected in the filter option
Show Source
Nested Schema : billingRegions
Type:
array
BillingRegions Codes of the regions selected in the filter option
Show Source
Nested Schema : productIds
Type:
array
Product Ids of the products selected in the filter option
Show Source
Nested Schema : shippingCountries
Type:
array
ShippingCountries with all regions selected in the filter option
Show Source
Nested Schema : shippingRegions
Type:
array
ShippingRegions Codes of the regions selected in the filter option
Show Source
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateReportFilterConfiguration_response
Type:
Show Source
object
-
FilterConfigurationsItem(optional):
object FilterConfigurationsItem
The Filter configurations which is updated
Nested Schema : FilterConfigurationsItem
Type:
object
The Filter configurations which is updated
Show Source
-
billingCountries(optional):
array billingCountries
BillingCountries with all regions selected in the filter option
-
billingRegions(optional):
array billingRegions
BillingRegions Codes of the regions selected in the filter option
-
context(optional):
string
Context selected in the filters.
-
groupBy(optional):
string
groupBy option selected in the filters
-
metric(optional):
string
Metric selected in the filters
-
priceListGroup(optional):
string
Pricelist groups as comma separted string
-
productIds(optional):
array productIds
Product Ids of the products selected in the filter option
-
reportingEndDate(optional):
string
ReportingEndDate selected in the filters.
-
reportingStartDate(optional):
string
ReportingStartDate selected in the filters
-
repositoryId(optional):
string
Repository Id of the filter Configuration updated.
-
shippingCountries(optional):
array shippingCountries
ShippingCountries with all regions selected in the filter option
-
shippingRegions(optional):
array shippingRegions
ShippingRegions Codes of the regions selected in the filter option
-
siteIds(optional):
array siteIds
Site Ids of the sites selected in the filter option
-
timeFrame(optional):
string
TimeFrame selected in the filters.
-
transactionCurrency(optional):
string
currency for the reporting data
Nested Schema : billingCountries
Type:
array
BillingCountries with all regions selected in the filter option
Show Source
Nested Schema : billingRegions
Type:
array
BillingRegions Codes of the regions selected in the filter option
Show Source
Nested Schema : productIds
Type:
array
Product Ids of the products selected in the filter option
Show Source
Nested Schema : shippingCountries
Type:
array
ShippingCountries with all regions selected in the filter option
Show Source
Nested Schema : shippingRegions
Type:
array
ShippingRegions Codes of the regions selected in the filter option
Show Source
Example Response (application/json)
{
"reportingStartDate":null,
"transactionCurrency":"USD",
"billingRegions":[
"US-AL",
"US-AB"
],
"reportingEndDate":null,
"groupBy":null,
"shippingCountries":[
"AS"
],
"timeFrame":"yesterday",
"priceListGroups":[
"UsDollar"
],
"billingCountries":[
"AS"
],
"shippingRegions":[
],
"metric":"grossRevenue",
"productIds":[
],
"repositoryId":"admin-orders",
"context":"orders",
"siteIds":[
"siteUS"
],
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/reportFilterConfiguration/admin-overview"
}
]
}
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|
|------------------|------------------|
|94048|If some error while processing the endpoint action|
|94007|If some input for filter configuration is not valid or not available when required.|
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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