SlotConfigurationSearch resource (Data API 23.2)
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. Attributes are grouped into different buckets. These are the list of searchable attributes with their corresponding buckets: Main:
Slot:
Only fields in the same bucket can be joined using a disjunction (OR). For instance, when joining context and description above, only a conjunction is allowed (AND), whereas context and slot_id can be joined to each other using a disjunction because they are in the same bucket. If the field is used in a disjunction (OR) that violates this rule, an exception will be thrown. |
Search Slot Configurations
Searches for slot configurations.
The query attribute specifies a complex query that can be used to narrow down the search. Attributes are grouped into different buckets. These are the list of searchable attributes with their corresponding buckets:
Main:
- configuration_id - String
- default - Boolean
- description - String
- enabled - Boolean
Slot:
- context - String
- slot_id - String
Only fields in the same bucket can be joined using a disjunction (OR). For instance, when joining context and description above, only a conjunction is allowed (AND), whereas context and slot_id can be joined to each other using a disjunction because they are in the same bucket. If the field is used in a disjunction (OR) that violates this rule, an exception will be thrown.
Url
POST https://hostname:port/dw/data/v23_2/sites/{site_id}/slot_configuration_searchFormats
json, xml
Authentication
| Name | Description |
|---|---|
| OAuth | Authentication via OAuth token. |
Request Document
Response Document
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) |
Indicates that the value to search with does not match the type of the search field. |
Sample
REQUEST:
POST /s/-/dw/data/v23_2/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" : "23.2",
"_type" : "slot_configuration_search_result",
"count" : 1,
"hits" :
[
{
"_resource_state" : "860cde3040519cce439cd99e209f8a87c3ad0b7e2813edbf6f5501f763b73bd5",
"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/v23_2/sites/SiteGenesis/slots/header-banner/slot_configurations/fsdoi43ofijwdf?context=category%3Dmen_shoes"
"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"
}
]
"select" : "(**)",
"start" : 0,
"total" : 1
}