REST API for Oracle Commerce Cloud December 2017

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: Type: string

Required: true

The key of the filter object to retrieve.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getFilter_response

Properties

exclude: Type: string

The fields to exclude from the endpoint response.
include: Type: string

The fields to include in the endpoint response.
key: Type: string

The key passed as the pathParams, which is the filterKey for the filter object retrieved.

Example 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.|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "include": "id,active,saleVolumePrices,listVolumePrices,route,configurable,productVariantOptions,primaryThumbImageURL,notForIndividualSale,displayName,childSKUs",
  "exclude": "childSKUs.unitOfMeasure",
  "key": "productData"
}