1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Admin
  4. Report Filter Configuration

saveReportFilterConfiguration

post

/ccadmin/v1/reportFilterConfigurations

Save Report Filter Configuration. Save the filter configuration for the first time with the last run report

Request

Supported Media Types
Body ()
Root Schema : saveReportFilterConfiguration_request
Type: object
Show Source
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 saved
Show Source
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
Nested Schema : siteIds
Type: array
Site Ids of the sites selected in the filter option
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : saveReportFilterConfiguration_response
Type: object
Show Source
Nested Schema : FilterConfigurationsItem
Type: object
The Filter configurations which is saved
Show Source
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
Nested Schema : siteIds
Type: array
Site Ids of the sites 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":[
        "US-AL",
        "US-AB"
    ],
    "metric":"grossRevenue",
    "productIds":[
    ],
    "repositoryId":"admin-orders",
    "context":"orders",
    "siteIds":[
        "siteUS"
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/reportFilterConfiguration"
        }
    ]
}

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| |------------------|------------------| |94049|Filter Configuration for user already exists or error while saving the filter configuration.| |94007|If some input for filter configuration is not valid or not available when required.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top