{"items":[{"type":"link","label":"Search API","link":"/ch/search-api","routeSlug":"/ch/search-api","content":{"contentType":"overview","meta":{"name":"Search API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/ch/search-api/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/ch/search-api/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"closed source","url":"https://www.sitecore.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Search API (v1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Search API to execute a search query, retrieve facet values, remove search filters or retrieve a facet query. The Search API applies a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/developers/cloud-dev/configuration.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default search configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to all searches, using default values and filters. The search endpoint exposes a number of search types, including full-text search and faceted search as well as visual search. It supports various query operators as well as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/developers/cloud-dev/supported-visual-search-parameters.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visual search parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/ch/search-api"}],"sectionId":"/ch/search-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this API, you need:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of your Content Hub server. You can get this from your Content Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Administrator. Enter this URL in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{{server}}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" variable by hovering your mouse"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"over the variable in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pane and then clicking "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An access token and the client ID. Both are sent with every request. You"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can create a token through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/users/content-hub/create-an-oauth-client.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interface"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#grant-flows"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requesting one using the API"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"itself"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Search API does not use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, as there is no support for the creation of a resource."},"children":[]}]}]}]}]}],"sectionId":"/ch/search-api/section/authentication"}]}]}},{"type":"link","label":"Authentication","link":"/ch/search-api/section/authentication","routeSlug":"/ch/search-api/section/authentication","content":null},{"type":"group","label":"Search","link":"/ch/search-api/search","routeSlug":"/ch/search-api/search","items":[{"label":"Execute a complex search query","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/search-api/search/searchactions","routeSlug":"/ch/search-api/search/searchactions","metadata":{"seo":{"title":"Execute a complex search query","description":"Executes a search query and returns the search results. Use POST when the query parameters exceed the URL length limitations. Parameters are passed in a resource instead of URL arguments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SearchActions","name":"Execute a complex search query","isWebhook":false,"pointer":"/paths/~1api~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute a complex search query","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Executes a search query and returns the search results. Use POST when the query parameters exceed the URL length limitations. Parameters are passed in a resource instead of URL arguments."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/SearchRequest"},"application/json":{"schemaId":"components/schemas/SearchRequest"},"text/json":{"schemaId":"components/schemas/SearchRequest"},"application/*+json":{"schemaId":"components/schemas/SearchRequest"}},"schemaId":"components/schemas/SearchRequest","pointer":"/paths/~1api~1search/post/requestBody","description":"Resource containing all the parameters needed for a search."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/search","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/SearchRequest"},"application/json":{"schemaId":"components/schemas/SearchRequest"},"text/json":{"schemaId":"components/schemas/SearchRequest"},"application/*+json":{"schemaId":"components/schemas/SearchRequest"}},"responseCodes":["200","400","401"],"pointer":"/api/search","href":"search/searchactions","openApiOperationId":"SearchActions","summary":"Execute a complex search query"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"schemaId":"components/schemas/SearchRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/SearchRequest"},"application/json":{"schemaId":"components/schemas/SearchRequest"},"text/json":{"schemaId":"components/schemas/SearchRequest"},"application/*+json":{"schemaId":"components/schemas/SearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Resource"}},"schemaId":"components/schemas/Resource"},{"code":"400","description":"Request is not valid"},{"code":"401","description":"Unauthorized request or invalid access token"}],"pointer":"/paths/~1api~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Resource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Resource"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search/searchactions"}],"panels":[]}]},"httpPath":"/api/search"},{"label":"Execute a simple search query","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/search-api/search/getsearchactions","routeSlug":"/ch/search-api/search/getsearchactions","metadata":{"seo":{"title":"Execute a simple search query","description":"Executes a search query and returns the search results. Use GET for simple queries that fit within URL length limits, for example, to retrieve the current state of a resource, including its content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSearchActions","name":"Execute a simple search query","isWebhook":false,"pointer":"/paths/~1api~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute a simple search query","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Executes a search query and returns the search results. Use GET for simple queries that fit within URL length limits, for example, to retrieve the current state of a resource, including its content."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"query","in":"query","schemaId":"schema_937","description":"This parameter is generated automatically by Content Hub and contains the information required to restore a search state. Do not create or modify it manually."},{"name":"skip","in":"query","schemaId":"schema_938","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of results to skip, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"take","in":"query","schemaId":"schema_938","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of results to return, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/search","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[{"name":"query","in":"query","schemaId":"schema_937"},{"name":"skip","in":"query","schemaId":"schema_938"},{"name":"take","in":"query","schemaId":"schema_938"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/api/search","href":"search/getsearchactions","openApiOperationId":"GetSearchActions","summary":"Execute a simple search query"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Resource"}},"schemaId":"components/schemas/Resource"},{"code":"400","description":"Request is not valid"},{"code":"401","description":"Unauthorized request or invalid access token"}],"pointer":"/paths/~1api~1search/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Resource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Resource"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search/getsearchactions"}],"panels":[]}]},"httpPath":"/api/search"},{"label":"Retrieve all facet values","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/search-api/search/postallfacets","routeSlug":"/ch/search-api/search/postallfacets","metadata":{"seo":{"title":"Retrieve all facet values","description":"Retrieves all values for a specific facet field, including translations and selection state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostAllFacets","name":"Retrieve all facet values","isWebhook":false,"pointer":"/paths/~1api~1search~1allfacets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all facet values","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all values for a specific facet field, including translations and selection state."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/AllFacetsRequest"},"application/json":{"schemaId":"components/schemas/AllFacetsRequest"},"text/json":{"schemaId":"components/schemas/AllFacetsRequest"},"application/*+json":{"schemaId":"components/schemas/AllFacetsRequest"}},"schemaId":"components/schemas/AllFacetsRequest","pointer":"/paths/~1api~1search~1allfacets/post/requestBody","description":"Facet request resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/search/allfacets","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/AllFacetsRequest"},"application/json":{"schemaId":"components/schemas/AllFacetsRequest"},"text/json":{"schemaId":"components/schemas/AllFacetsRequest"},"application/*+json":{"schemaId":"components/schemas/AllFacetsRequest"}},"responseCodes":["200","400","401"],"pointer":"/api/search/allfacets","href":"search/postallfacets","openApiOperationId":"PostAllFacets","summary":"Retrieve all facet values"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"schemaId":"components/schemas/AllFacetsRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/AllFacetsRequest"},"application/json":{"schemaId":"components/schemas/AllFacetsRequest"},"text/json":{"schemaId":"components/schemas/AllFacetsRequest"},"application/*+json":{"schemaId":"components/schemas/AllFacetsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Resource"}},"schemaId":"components/schemas/Resource"},{"code":"400","description":"Request is not valid"},{"code":"401","description":"Unauthorized request or invalid access token"}],"pointer":"/paths/~1api~1search~1allfacets/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Resource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Resource"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search/postallfacets"}],"panels":[]}]},"httpPath":"/api/search/allfacets"},{"label":"Remove search filters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/search-api/search/searchremovefilters","routeSlug":"/ch/search-api/search/searchremovefilters","metadata":{"seo":{"title":"Remove search filters","description":"Removes the specified filters from the search query and returns the updated query."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SearchRemoveFilters","name":"Remove search filters","isWebhook":false,"pointer":"/paths/~1api~1search~1remove/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove search filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes the specified filters from the search query and returns the updated query."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/RemoveFiltersRequest"},"application/json":{"schemaId":"components/schemas/RemoveFiltersRequest"},"text/json":{"schemaId":"components/schemas/RemoveFiltersRequest"},"application/*+json":{"schemaId":"components/schemas/RemoveFiltersRequest"}},"schemaId":"components/schemas/RemoveFiltersRequest","pointer":"/paths/~1api~1search~1remove/post/requestBody","description":"Remove filters request resource."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/search/remove","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/RemoveFiltersRequest"},"application/json":{"schemaId":"components/schemas/RemoveFiltersRequest"},"text/json":{"schemaId":"components/schemas/RemoveFiltersRequest"},"application/*+json":{"schemaId":"components/schemas/RemoveFiltersRequest"}},"responseCodes":["200","401"],"pointer":"/api/search/remove","href":"search/searchremovefilters","openApiOperationId":"SearchRemoveFilters","summary":"Remove search filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"schemaId":"components/schemas/RemoveFiltersRequest","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/RemoveFiltersRequest"},"application/json":{"schemaId":"components/schemas/RemoveFiltersRequest"},"text/json":{"schemaId":"components/schemas/RemoveFiltersRequest"},"application/*+json":{"schemaId":"components/schemas/RemoveFiltersRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Filters successfully removed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RemoveFiltersResponse"}},"schemaId":"components/schemas/RemoveFiltersResponse"},{"code":"401","description":"Unauthorized request or invalid access token"}],"pointer":"/paths/~1api~1search~1remove/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RemoveFiltersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RemoveFiltersResponse"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search/searchremovefilters"}],"panels":[]}]},"httpPath":"/api/search/remove"},{"label":"Retrieve a facet query for an entity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/search-api/search/getfacetquerybyid","routeSlug":"/ch/search-api/search/getfacetquerybyid","metadata":{"seo":{"title":"Retrieve a facet query for an entity","description":"Retrieves a serialized facet query that can be used to filter search results to items related to a specific entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFacetQueryById","name":"Retrieve a facet query for an entity","isWebhook":false,"pointer":"/paths/~1api~1search~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a facet query for an entity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a serialized facet query that can be used to filter search results to items related to a specific entity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_939","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entity ID or identifier, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12345"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1search~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/search/{id}","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_939"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/api/search/{id}","href":"search/getfacetquerybyid","openApiOperationId":"getFacetQueryById","summary":"Retrieve a facet query for an entity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FacetQueryResponse"}},"schemaId":"components/schemas/FacetQueryResponse"},{"code":"400","description":"Request is not valid"},{"code":"401","description":"Unauthorized request or invalid access token"}],"pointer":"/paths/~1api~1search~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FacetQueryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FacetQueryResponse"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search/getfacetquerybyid"}],"panels":[]}]},"httpPath":"/api/search/{id}"}],"content":{"contentType":"group","meta":{"name":"Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search","showPageActions":true},{"nodeType":"markdoc","content":"Use the Search API for full-text searches, faceted searches, and visual searches."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/search","summary":"Execute a complex search query","prefix":{"name":"post","color":"post"},"badges":[],"link":"/search/searchactions","deprecated":false},{"title":"/api/search","summary":"Execute a simple search query","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search/getsearchactions","deprecated":false},{"title":"/api/search/allfacets","summary":"Retrieve all facet values","prefix":{"name":"post","color":"post"},"badges":[],"link":"/search/postallfacets","deprecated":false},{"title":"/api/search/remove","summary":"Remove search filters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/search/searchremovefilters","deprecated":false},{"title":"/api/search/{id}","summary":"Retrieve a facet query for an entity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search/getfacetquerybyid","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/SearchRequest":{"id":"components/schemas/SearchRequest","kind":"json-schema","title":"SearchRequest","data":{"type":"object","properties":{"query":{"type":"string","nullable":true,"description":"This parameter is generated automatically by Content Hub and contains the information required to restore a search state. Do not create or modify it manually."},"skip":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of results to skip, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"take":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of results to return, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"filters":{"type":"array","items":{"$ref":"#/components/schemas/FieldFilterRequestResource"},"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filters to apply to the search query. Each filter is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldFilterRequestResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},"sorting":{"$ref":"#/components/schemas/SortingRequestResource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sorting to apply to the search query. This is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SortingRequestResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object that specifies the field and order (ascending or descending)."},"children":[]}]}]}]},"aggregations":{"type":"array","items":{"$ref":"#/components/schemas/AggregationRequestResource"},"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The aggregations to apply to the search query. Each aggregation is an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AggregationRequestResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},"fulltext":{"type":"array","items":{"type":"string"},"nullable":true,"description":"The full-text search terms to apply to the query. This is an array of strings, where each string is a term to search for."},"fields":{"type":"array","items":{"type":"string"},"nullable":true,"description":"The fields to include in the search results. This is an array of strings, where each string is a field name."},"culture":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The culture to use for the search, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fr-FR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"view":{"type":"string","nullable":true,"description":"The view to use for the search (that is, the view name)."},"component":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The component ID to use for the search, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"logical_grouping_template":{"type":"string","nullable":true,"description":"The logical grouping template to use for the search."},"defaults":{"type":"string","nullable":true,"description":"The default values to use for the search."},"configuration_category":{"type":"string","nullable":true,"description":"The configuration category to use for the search."},"customSorting":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"nullable":true,"description":"Custom sorting options for the search. This is an object where keys are field names and values are integers representing the sort order."},"saved_selection":{"type":"integer","format":"int64","description":"The ID of a saved selection to use for the search."},"calendarStartDate":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date for the calendar filter. This is a string in date-time format, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2023-01-01T00:00:00Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"calendarStopDate":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The stop date for the calendar filter. This is a string in date-time format, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2023-12-31T23:59:59Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"selection_pool":{"$ref":"#/components/schemas/SelectionPoolFilterResource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The selection pool to use for the search. This is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SelectionPoolFilterResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object that specifies the selection pool and optional sub-pool ID."},"children":[]}]}]}]},"nested_relations":{"type":"array","items":{"$ref":"#/components/schemas/NestedRelationInfo"},"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The nested relations to include in the search. Each item is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NestedRelationInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object that specifies the relation, role, and properties to include."},"children":[]}]}]}]},"group":{"$ref":"#/components/schemas/SearchGroupRequestResource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grouping information for the search. This is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SearchGroupRequestResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object that specifies how to group the search results."},"children":[]}]}]}]},"is_initial_request":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this is the initial request for the search. This is a boolean value, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means it is the initial request and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means it is a subsequent request."},"children":[]}]}]}]},"containsUserFilters":{"type":"boolean","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the search query contains user-defined filters. This is a boolean value, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means it contains user filters and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means it does not."},"children":[]}]}]}]},"take_user_settings":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to take user settings into account for the search. This is a boolean value, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means user settings are taken into account and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means they are not."},"children":[]}]}]}]},"l10n":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to use localization for the search. This is a boolean value, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means localization is used and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means it is not."},"children":[]}]}]}]},"visualSearch":{"$ref":"#/components/schemas/VisualSearchRequestResource","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The visual search parameters to use for the search. This is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VisualSearchRequestResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object that specifies the image, color, text, and other parameters for visual search."},"children":[]}]}]}]}},"additionalProperties":{}}},"components/schemas/AllFacetsRequest":{"id":"components/schemas/AllFacetsRequest","kind":"json-schema","title":"AllFacetsRequest","data":{"type":"object","properties":{"facetField":{"type":"string","nullable":true,"description":"The name of the facet field to retrieve values for."},"query":{"type":"string","nullable":true,"description":"This parameter is generated automatically by Content Hub and contains the information required to restore a search state. Do not create or modify it manually."},"searchConfigurationName":{"type":"string","nullable":true,"description":"The name of the search configuration to use for retrieving facet values."},"culture":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The culture to use for retrieving facet values, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fr-FR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"component":{"type":"integer","format":"int64","nullable":true,"description":"The component ID to use when retrieving facet values."},"filters":{"type":"array","items":{"$ref":"#/components/schemas/FieldFilterRequestResource"},"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filters to apply to the facet values. Each filter is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FieldFilterRequestResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object that specifies the filter criteria."},"children":[]}]}]}]},"take_user_settings":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to take user settings into account for the facet values. This is a boolean value, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means user settings are taken into account and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means they are not."},"children":[]}]}]}]},"l10n":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to use localization for the facet values. This is a boolean value, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means localization is used and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means it is not."},"children":[]}]}]}]}},"additionalProperties":false}},"components/schemas/RemoveFiltersRequest":{"id":"components/schemas/RemoveFiltersRequest","kind":"json-schema","title":"RemoveFiltersRequest","data":{"type":"object","properties":{"query":{"type":"string","nullable":true,"description":"This parameter is generated automatically by Content Hub and contains the information required to restore a search state. Do not create or modify it manually."},"filters":{"type":"array","items":{"type":"string"},"nullable":true,"description":"The list of filter names to remove from the search query. Each item is a string that represents the name of a filter to be removed."}},"additionalProperties":false}},"components/schemas/RemoveFiltersResponse":{"id":"components/schemas/RemoveFiltersResponse","kind":"json-schema","title":"RemoveFiltersResponse","data":{"type":"object","properties":{"query":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/FacetQueryResponse":{"id":"components/schemas/FacetQueryResponse","kind":"json-schema","title":"FacetQueryResponse","data":{"type":"object","properties":{"query":{"type":"string","nullable":true},"filters":{"type":"array","items":{"$ref":"#/components/schemas/FieldFilterResponseResource"},"nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false}},"components/schemas/FieldFilterRequestResource":{"id":"components/schemas/FieldFilterRequestResource","kind":"json-schema","title":"FieldFilterRequestResource","data":{"type":"object","properties":{"name":{"type":"string","nullable":true},"definition":{"type":"string","nullable":true},"group_identifier":{"type":"string","nullable":true},"operator":{"$ref":"#/components/schemas/FilterOperator"},"values":{"type":"array","items":{},"nullable":true},"nested_values":{"type":"array","items":{"$ref":"#/components/schemas/FieldFilterRequestResource"},"nullable":true},"hidden":{"type":"boolean"},"type":{"$ref":"#/components/schemas/RequestedFilterType"},"role":{"type":"string","nullable":true},"visible":{"type":"boolean"},"multi_select":{"type":"boolean"},"selection_pool_specs":{"$ref":"#/components/schemas/SelectionPoolSpecs"}},"additionalProperties":false}},"components/schemas/FieldFilterResponseResource":{"id":"components/schemas/FieldFilterResponseResource","kind":"json-schema","title":"FieldFilterResponseResource","data":{"type":"object","properties":{"name":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"values":{"type":"array","items":{"$ref":"#/components/schemas/FieldFilterValueResponseResource"},"nullable":true},"nested_values":{"type":"array","items":{"$ref":"#/components/schemas/FieldFilterResponseResource"},"nullable":true},"definition":{"type":"string","nullable":true},"operator":{"$ref":"#/components/schemas/FilterOperator"},"removeQuery":{"type":"string","nullable":true},"dynamic":{"type":"boolean"},"nested":{"type":"boolean"},"group":{"type":"string","nullable":true},"visible":{"type":"boolean"},"multi_select":{"type":"boolean"}},"additionalProperties":false}},"components/schemas/FieldFilterValueResponseResource":{"id":"components/schemas/FieldFilterValueResponseResource","kind":"json-schema","title":"FieldFilterValueResponseResource","data":{"type":"object","properties":{"value":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"data":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/FilterOperator":{"id":"components/schemas/FilterOperator","kind":"json-schema","title":"FilterOperator","data":{"enum":["None","Equals","LessThan","GreaterThan","Between","StartsWith","EndsWith","Contains","FacetEquals","DoesNotContain","DoesNotStartWith","DoesNotEndWith","LessThanOrEquals","GreaterThanOrEquals","DoesNotEqual","AnyOf","AllOf","NoneOf","Missing","Exists","Changed"],"type":"string"}},"components/schemas/RequestedFilterType":{"id":"components/schemas/RequestedFilterType","kind":"json-schema","title":"RequestedFilterType","data":{"enum":["FieldFilter","InFilter","DynamicFilter","Nested","IdFilter","SelectionPoolFilter"],"type":"string"}},"components/schemas/SelectionPoolSpecs":{"id":"components/schemas/SelectionPoolSpecs","kind":"json-schema","title":"SelectionPoolSpecs","data":{"type":"object","properties":{"pool_id":{"type":"integer","format":"int64"},"sub_pool_id":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false}},"components/schemas/SortingRequestResource":{"id":"components/schemas/SortingRequestResource","kind":"json-schema","title":"SortingRequestResource","data":{"type":"object","properties":{"field":{"type":"string","nullable":true},"asc":{"type":"boolean"}},"additionalProperties":false}},"components/schemas/AggregationRequestResource":{"id":"components/schemas/AggregationRequestResource","kind":"json-schema","title":"AggregationRequestResource","data":{"type":"object","properties":{"name":{"type":"string","nullable":true},"field":{"type":"string","nullable":true},"size":{"type":"integer","format":"int32"},"datasource":{"type":"string","nullable":true},"children":{"type":"array","items":{"$ref":"#/components/schemas/AggregationRequestResource"},"nullable":true},"metric_option":{"$ref":"#/components/schemas/MetricOptionRequestResource"},"type":{"$ref":"#/components/schemas/RequestedAggregationType"},"interval":{"$ref":"#/components/schemas/DateInterval"},"format":{"type":"string","nullable":true},"include_missing":{"type":"boolean"}},"additionalProperties":false}},"components/schemas/MetricOptionRequestResource":{"id":"components/schemas/MetricOptionRequestResource","kind":"json-schema","title":"MetricOptionRequestResource","data":{"type":"object","properties":{"name":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"field":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/RequestedAggregationType":{"id":"components/schemas/RequestedAggregationType","kind":"json-schema","title":"RequestedAggregationType","data":{"enum":["Term","Metric","Date"],"type":"string"}},"components/schemas/DateInterval":{"id":"components/schemas/DateInterval","kind":"json-schema","title":"DateInterval","data":{"enum":["second","minute","hour","day","week","month","quarter","year"],"type":"string"}},"components/schemas/SelectionPoolFilterResource":{"id":"components/schemas/SelectionPoolFilterResource","kind":"json-schema","title":"SelectionPoolFilterResource","data":{"type":"object","properties":{"selection_pool":{"type":"string","nullable":true},"sub_pool_id":{"type":"integer","format":"int64","nullable":true},"definitions":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}},"components/schemas/NestedRelationInfo":{"id":"components/schemas/NestedRelationInfo","kind":"json-schema","title":"NestedRelationInfo","data":{"type":"object","properties":{"relation":{"type":"string","nullable":true},"role":{"$ref":"#/components/schemas/RelationRole"},"properties":{"type":"array","items":{"type":"string"},"nullable":true},"renditions":{"type":"array","items":{"type":"string"},"nullable":true},"limit":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false}},"components/schemas/RelationRole":{"id":"components/schemas/RelationRole","kind":"json-schema","title":"RelationRole","data":{"enum":["Parent","Child"],"type":"string"}},"components/schemas/SearchGroupRequestResource":{"id":"components/schemas/SearchGroupRequestResource","kind":"json-schema","title":"SearchGroupRequestResource","data":{"type":"object","properties":{"row":{"type":"string","nullable":true},"column":{"type":"string","nullable":true},"rowDefinitionId":{"type":"integer","format":"int64","nullable":true},"columnDefinitionId":{"type":"integer","format":"int64","nullable":true},"result_count":{"type":"integer","format":"int32"}},"additionalProperties":false}},"components/schemas/VisualSearchRequestResource":{"id":"components/schemas/VisualSearchRequestResource","kind":"json-schema","title":"VisualSearchRequestResource","data":{"type":"object","properties":{"image":{"type":"string","nullable":true},"color":{"type":"string","nullable":true},"text":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/VisualSearchType"},"imageEntityId":{"type":"integer","format":"int64","nullable":true},"IsDeepSearch":{"type":"boolean","nullable":true}},"additionalProperties":false}},"components/schemas/VisualSearchType":{"id":"components/schemas/VisualSearchType","kind":"json-schema","title":"VisualSearchType","data":{"enum":["vector","vector+text","text","vectorAndText","vectorOrText"],"type":"string"}},"components/schemas/Link":{"id":"components/schemas/Link","kind":"json-schema","title":"Link","data":{"type":"object","properties":{"href":{"type":"string","description":"Gets or sets the URI that points to the resource this link refers to.","nullable":true},"filename_properties":{"type":"array","items":{"type":"string"},"description":"Gets or sets the URI that points to the resource this link refers to.","nullable":true},"title":{"type":"string","description":"Gets or sets the title that describes this link.","nullable":true},"templated":{"type":"boolean","description":"Gets or sets a value indicating whether the contained URI is a template.","default":false}},"additionalProperties":false,"description":"Represents a link to a resource."}},"components/schemas/Resource":{"id":"components/schemas/Resource","kind":"json-schema","title":"Resource","data":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Represents a resource with a self-link and a modified date."}},"schema_937":{"kind":"json-schema","data":{"type":"string","default":""},"id":"schema_937"},"schema_938":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":0},"id":"schema_938"},"schema_939":{"kind":"json-schema","data":{"type":"string"},"id":"schema_939"}},"exampleStore":{},"securitySchemeStore":{"OAuth2.0":{"id":"OAuth2.0","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}},"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"specType":"openapi"},"options":{"hideInfoMetadata":true,"sanitize":true,"sortRequiredPropsFirst":true,"corsProxyUrl":"https://cors.redoc.ly","mockServer":{"off":true,"position":"off"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/ch/search-api/index.json?download"},{"url":"/_bundle/ch/search-api/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Search API","description":"\nUse the Search API to execute a search query, retrieve facet values, remove search filters or retrieve a facet query. The Search API applies a [default search configuration](https://doc.sitecore.com/ch/en/developers/cloud-dev/configuration.html) to all searches, using default values and filters. The search endpoint exposes a number of search types, including full-text search and faceted search as well as visual search. It supports various query operators as well as [visual search parameters](https://doc.sitecore.com/ch/en/developers/cloud-dev/supported-visual-search-parameters.html).\n## Authentication\nTo use this API, you need:\n- The URL of your Content Hub server. You can get this from your Content Hub\n  Administrator. Enter this URL in the <b>{{server}}</b> variable by hovering your mouse \n  over the variable in the <b>Try it</b> pane and then clicking <b>Edit</b>.\n\n- An access token and the client ID. Both are sent with every request. You \n  can create a token through the [Content Hub\n  interface](https://doc.sitecore.com/ch/en/users/content-hub/create-an-oauth-client.html) \n  or by [requesting one using the API\n  itself](https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#grant-flows).\n\n{% admonition type=\"info\" name=\"Note\" %}\n The Search API does not use the `Location` header, as there is no support for the creation of a resource.\n{% /admonition %}\n","product":"Content Hub"}},"baseSlug":"/ch/search-api","routesMapping":{}}