SlotConfigurationSearch Resource (Data API 15.5)

Summary

Http Method Resource Description
POST /Sites/{Site_id}/Slot_configuration_search

Searches for slot configurations.

The query attribute specifies a complex query that can be used to narrow down the search. The set of fields that are available to search are:

  • configuration_id - String
  • context* - String
  • default - Boolean
  • description - String
  • enabled - Boolean
  • slot_id* - String

* - These fields can only be used in Queries as conjunctions (using AND). If the field is used in a disjunction (OR) an exception will be thrown.

Search Slots

Searches for slot configurations.

The query attribute specifies a complex query that can be used to narrow down the search. The set of fields that are available to search are:

* - These fields can only be used in Queries as conjunctions (using AND). If the field is used in a disjunction (OR) an exception will be thrown.

Url

POST https://hostname:port/dw/data/v15_5/sites/{site_id}/slot_configuration_search

Formats

json, xml

Request Document

SearchRequest

Response Document

SlotConfigurationSearchResult

Path Parameters

Parameter Type Description Constraints
site_id String The site context.  

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
400 TypeMissmatchException

field (String)

Thrown if the value to search with does not match the type of the search field.

Sample

REQUEST:
POST /s/-/dw/data/v15_5/sites/SiteGenesis/slot_configuration_search HTTP/1.1
Host: example.com
Authorization: Bearer a5b6eb0d-8312-41a3-88f3-2c53c4507367
Accept: application/json

{
    "query" : {
        "text_query": {
            "fields": ["configuration_id", "description"],
            "search_phrase": "header_banner_html"
        }
    },
    "select" : "(**)"
}

RESPONSE:
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
   "_v" : "15.5",
   "_type" : "slot_configuration_search_result",
   "count" : 1,
   "hits"  :
   [
        {
            "configuration_id":"header_banner_html",
            "context":"category", 
            "customer_groups":[
                "Administrators",
                "Registered"
            ],
            "callout_msg":
            {
                "default":"some message",
                "de-DE":"Deutsche Nachricht",
                "en-US":"US american message"
            },
        
            "context_id":"men_shoes", 
            "default":true, 
            "description":"slot configuration description", 
            "enabled":true,
            "link" : "https://example.com/s/-/dw/data/v15_5/sites/SiteGenesis/slot_configurations/fsdoi43ofijwdf" 
            "rank":2,
            "schedule":
            {
                "start_date":"2013-03-28T23:21:00.000Z", 
                "end_date":"2022-03-28T23:21:00.000Z", 
                "recurrence":
                {
                    "day_of_week":[
                        "monday",
                        "sunday"
                    ], 
                    "time_of_day":
                    {
                        "time_from":"00:00:00", 
                        "time_to":"23:59:00"
                    }
                }
            },
            "slot_content":
            {
                "type":"html",
                "body":
                {
                    "default":"<html>HTML content</html>",
                    "de-DE":"<html>HTML Inhalt</html>",
                    "en-US":"<html>HTML content</html>"
                }
            }, 
            "slot_id":"header-banner",
            "uuid":"fsdoi43ofijwdf",
    
        }
    ]
    "select" : "(**)",
    "start" : 0,
    "total" : 1
}
OCAPI obsolete versions 13.x and 14.x will be end of life in 2020 and versions 15.x and 16.x in 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.