getFilter
get
/ccadmin/v1/responseFilters/{id}
Get Filter. Gets the filter object for the requested filterKey.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The key of the filter object to retrieve.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getFilter_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 as the pathParams, which is the filterKey for the filter object retrieved.
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|
|------------------|------------------|
|18004|Unable to retrieve data for the filter.|
|18002|No filter found for the filter key.|
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