createFilter
post
/ccadmin/v1/responseFilters
Create Filter. Create the filter object, that can be used to filter the endpoint response. Though both include and exclude are not mandatory, atleast one of them should be populated with data.
Request
Supported Media Types
- application/json
Root Schema : createFilter_request
Type:
Show Source
object
-
exclude(optional):
string
The fields to exclude from the endpoint response.
-
include(optional):
string
The fields to include in the endpoint response.
-
key:
string
The filterKey for the filter to create.
Example:
{
"include":"id,active,saleVolumePrices,listVolumePrices,route,configurable,productVariantOptions,primaryThumbImageURL,notForIndividualSale,displayName,childSKUs",
"exclude":"childSKUs.unitOfMeasure",
"key":"productData"
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : createFilter_response
Type:
Show Source
object
-
exclude(optional):
string
The fields to exclude from the endpoint response.
-
include(optional):
string
The fields to include in the endpoint response.
-
key(optional):
string
The key passed in the request, which is the filterKey for the filter object created.
Example Response (application/json)
{
"include":"id,active,saleVolumePrices,listVolumePrices,route,configurable,productVariantOptions,primaryThumbImageURL,notForIndividualSale,displayName,childSKUs",
"exclude":"childSKUs.unitOfMeasure",
"key":"productData"
}
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|
|------------------|------------------|
|18005|FilterKey is mandatory.|
|18006|Required Data not found to create the filter.|
|18000|Unable to create filter for the key, because it already exist.|
|18001|A problem occurred when saving the data.|
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