20 lines
9.2 KiB
HTML
20 lines
9.2 KiB
HTML
<!DOCTYPE html SYSTEM "about:legacy-compat">
|
|
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"><meta name="built-on" content="2026-03-17T15:39:43.038668993"><title>System-wide search | Copenhagen Truck Wash API</title><script type="application/json" id="virtual-toc-data">[{"id":"endpoint","level":0,"title":"Endpoint","anchor":"#endpoint"},{"id":"operation","level":0,"title":"Operation","anchor":"#operation"},{"id":"authentication","level":0,"title":"Authentication","anchor":"#authentication"},{"id":"parameters","level":0,"title":"Parameters","anchor":"#parameters"},{"id":"responses","level":0,"title":"Responses","anchor":"#responses"}]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.26.0-b913/app.css" rel="stylesheet"><meta name="msapplication-TileColor" content="#000000"><link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="System-wide search | Copenhagen Truck Wash API"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Copenhagen Truck Wash API Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/systemwidesearchget.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="System-wide search | Copenhagen Truck Wash API"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
|
|
"@context": "http://schema.org",
|
|
"@type": "WebPage",
|
|
"@id": "writerside-documentation/systemwidesearchget.html#webpage",
|
|
"url": "writerside-documentation/systemwidesearchget.html",
|
|
"name": "System-wide search | Copenhagen Truck Wash API",
|
|
"description": "",
|
|
"image": "",
|
|
"inLanguage":"en-US"
|
|
}</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json">{
|
|
"@type": "WebSite",
|
|
"@id": "writerside-documentation/#website",
|
|
"url": "writerside-documentation/",
|
|
"name": "Copenhagen Truck Wash API Help"
|
|
}</script><!-- End Schema.org --></head><body data-id="systemWideSearchGet" data-main-title="System-wide search" data-article-props="{"seeAlsoStyle":"links"}" data-template="article" data-breadcrumbs="API-Reference.topic|API Reference///Tag_Search.topic|Search///Tag_Search_Page_1.topic|Search - Page 1 of 1"><div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Copenhagen Truck Wash API Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="systemWideSearchGet" id="systemWideSearchGet.topic">System-wide search</h1><p id="r67pm6_2">This endpoint documentation is generated directly from <code class="code" id="r67pm6_8">openapi.yaml</code>.</p><section class="chapter"><h2 id="endpoint" data-toc="endpoint">Endpoint</h2><div class="code-block" data-lang="http">GET /search/system</div></section><section class="chapter"><h2 id="operation" data-toc="operation">Operation</h2><p id="r67pm6_10">Operation ID: <code class="code" id="r67pm6_12">systemWideSearchGet</code></p><p id="r67pm6_11">Search across all supported entities with permission-aware filtering and optional intent parsing debug metadata. Customer records and customer-related entities are matched against a local e-conomic customer index (name/address/email/CVR) that is refreshed by cron. Intent parsing is invoked adaptively when lexical confidence is low or when the query looks intent-driven. Results are ordered by relevance, with recent records preferred when relevance is comparable.</p></section><section class="chapter"><h2 id="authentication" data-toc="authentication">Authentication</h2><p id="r67pm6_13">Security requirements:</p><div class="table-wrapper"><table class="wide" id="r67pm6_14"><thead><tr class="ijRowHead" id="r67pm6_15"><th id="r67pm6_17"><p>Scheme</p></th><th id="r67pm6_18"><p>Scopes</p></th></tr></thead><tbody><tr id="r67pm6_16"><td id="r67pm6_19"><p>BearerAuth</p></td><td id="r67pm6_20"><p>-</p></td></tr></tbody></table></div></section><section class="chapter"><h2 id="parameters" data-toc="parameters">Parameters</h2><div class="table-wrapper"><table class="wide" id="r67pm6_21"><thead><tr class="ijRowHead" id="r67pm6_22"><th id="r67pm6_30"><p>Name</p></th><th id="r67pm6_31"><p>In</p></th><th id="r67pm6_32"><p>Required</p></th><th id="r67pm6_33"><p>Type</p></th><th id="r67pm6_34"><p>Description</p></th></tr></thead><tbody><tr id="r67pm6_23"><td id="r67pm6_35"><p>query</p></td><td id="r67pm6_36"><p>query</p></td><td id="r67pm6_37"><p>yes</p></td><td id="r67pm6_38"><p>string</p></td><td id="r67pm6_39"><p>Free-text query to search for. Supports natural-language intent fallback and domain synonyms such as `rabat` -> `discount`.</p></td></tr><tr id="r67pm6_24"><td id="r67pm6_40"><p>include_types</p></td><td id="r67pm6_41"><p>query</p></td><td id="r67pm6_42"><p>no</p></td><td id="r67pm6_43"><p>array<SystemSearchEntityType></p></td><td id="r67pm6_44"><p>Comma-separated list of entity types to include. Defaults to all allowed types.</p></td></tr><tr id="r67pm6_25"><td id="r67pm6_45"><p>exclude_types</p></td><td id="r67pm6_46"><p>query</p></td><td id="r67pm6_47"><p>no</p></td><td id="r67pm6_48"><p>array<SystemSearchEntityType></p></td><td id="r67pm6_49"><p>Comma-separated list of entity types to exclude.</p></td></tr><tr id="r67pm6_26"><td id="r67pm6_50"><p>include_associations</p></td><td id="r67pm6_51"><p>query</p></td><td id="r67pm6_52"><p>no</p></td><td id="r67pm6_53"><p>boolean</p></td><td id="r67pm6_54"><p>Include associated objects when matching a primary entity such as a customer.</p></td></tr><tr id="r67pm6_27"><td id="r67pm6_55"><p>debug_intent</p></td><td id="r67pm6_56"><p>query</p></td><td id="r67pm6_57"><p>no</p></td><td id="r67pm6_58"><p>boolean</p></td><td id="r67pm6_59"><p>Include intent parser diagnostics in `meta.intent_parser`.</p></td></tr><tr id="r67pm6_28"><td id="r67pm6_60"><p>limit</p></td><td id="r67pm6_61"><p>query</p></td><td id="r67pm6_62"><p>no</p></td><td id="r67pm6_63"><p>integer</p></td><td id="r67pm6_64"></td></tr><tr id="r67pm6_29"><td id="r67pm6_65"><p>offset</p></td><td id="r67pm6_66"><p>query</p></td><td id="r67pm6_67"><p>no</p></td><td id="r67pm6_68"><p>integer</p></td><td id="r67pm6_69"></td></tr></tbody></table></div></section><section class="chapter"><h2 id="responses" data-toc="responses">Responses</h2><div class="table-wrapper"><table class="wide" id="r67pm6_70"><thead><tr class="ijRowHead" id="r67pm6_73"><th id="r67pm6_78"><p>Status</p></th><th id="r67pm6_79"><p>Description</p></th><th id="r67pm6_80"><p>Content Types</p></th></tr></thead><tbody><tr id="r67pm6_74"><td id="r67pm6_81"><p>200</p></td><td id="r67pm6_82"><p>Search results returned successfully</p></td><td id="r67pm6_83"><p>application/json</p></td></tr><tr id="r67pm6_75"><td id="r67pm6_84"><p>400</p></td><td id="r67pm6_85"></td><td id="r67pm6_86"></td></tr><tr id="r67pm6_76"><td id="r67pm6_87"><p>401</p></td><td id="r67pm6_88"></td><td id="r67pm6_89"></td></tr><tr id="r67pm6_77"><td id="r67pm6_90"><p>403</p></td><td id="r67pm6_91"></td><td id="r67pm6_92"></td></tr></tbody></table></div><p id="r67pm6_71">Schema for response <code class="code" id="r67pm6_93">200</code> (<code class="code" id="r67pm6_94">application/json</code>):</p><div class="code-block" data-lang="json">
|
|
{
|
|
"$ref": "#/components/schemas/SystemSearchResponse"
|
|
}
|
|
</div></section><div class="last-modified">17 March 2026</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"><a href="tag-search-page-1.html" class="navigation-links__prev">Search - Page 1 of 1</a><a href="systemwidesearchpost.html" class="navigation-links__next">System-wide search</a></div></article><div id="disqus_thread"></div></div></section></main></div><script src="https://resources.jetbrains.com/writerside/apidoc/6.26.0-b913/app.js"></script></body></html> |