Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
A query that matches items matching boolean combinations of other queries.
It is built using one or more boolean clauses, which can be of types: and, or or not
The cursor to get the next page of results (if available). The search endpoint only gives a limited number of results. A missing nextCursor does not imply there are no more results for the provided search.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Cognite Docs","description":"Cognite Data Fusion (CDF) documentation for developers, data engineers, and administrators.","colors":{"primary":"#3C5FFB","light":"#4D8AFF","dark":"#3C5FFB"},"logo":{"light":"https://mintcdn.com/cognite/dkctM57aym6D8Toa/_images/logo/cognite-docs-black.svg?fit=max\u0026auto=format\u0026n=dkctM57aym6D8Toa\u0026q=85\u0026s=38c50e5be94d9baf1ff1c794ae17d6ea","dark":"https://mintcdn.com/cognite/dkctM57aym6D8Toa/_images/logo/cognite-docs-white.svg?fit=max\u0026auto=format\u0026n=dkctM57aym6D8Toa\u0026q=85\u0026s=06ff6278a32e16b65bc691b91f7bfe6d"},"favicon":"https://mintcdn.com/cognite/dkctM57aym6D8Toa/_images/CogniteIcon.svg?fit=max\u0026auto=format\u0026n=dkctM57aym6D8Toa\u0026q=85\u0026s=eaf7720816d261929421c888d58b8914","footer":{"socials":{"website":"https://www.cognite.com","linkedin":"https://www.linkedin.com/company/cognitedata","youtube":"https://www.youtube.com/c/cognite"},"links":[{"header":"Resources","items":[{"label":"Academy","href":"https://academy.cognite.com"},{"label":"Community","href":"https://hub.cognite.com"},{"label":"Support","href":"https://cognite.zendesk.com/hc/en-us"},{"label":"Trust Center","href":"https://trust.cognite.com/"},{"label":"CogDocs","href":"/cogdocs/concepts/platform-overview"}]},{"header":"Company","items":[{"label":"About us","href":"https://www.cognite.com/company/about-us-cognite"},{"label":"Careers","href":"https://www.cognite.com/company/careers"},{"label":"Blog","href":"https://www.cognite.com/resources/blog"}]},{"header":"Status","items":[{"label":"Cognite services","href":"https://status.cognite.com"}]}]},"search":{"prompt":"Search documentation"},"seo":{"metatags":{"canonical":"https://docs.cognite.com","google-site-verification":"kX2vFxX0NcdV88MV5ooALR09TbeSd8xDN-rVd6fiTG4"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"languages":{"custom":["/_languages/kuiper.json"]}},"latex":true},"banner":{"content":"New: build custom CDF applications with Cognite Flows. [Documentation](/cdf/flows) · [What's new](/cdf/whatsnew).","dismissible":true},"contextual":{"options":["mcp","copy","chatgpt","claude","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"metadata":{"timestamp":true},"markdown":{"instructions":["Cognite Data Fusion (CDF) is an industrial DataOps platform. Prefer English docs unless the user asks for another locale.","Follow /_llms/ index links recursively until you reach page URLs ending in .md. Fetch those Markdown twins instead of HTML.","For REST APIs, default to calendar version 20230101 (stable). Use 20230101-beta or 20230101-alpha only if the user is on a preview API. Cite paths under /api-reference/concepts/\u003cversion>/ and the Cdf-Version header. Prefer the Python SDK (cognite-sdk) unless the user is in JavaScript/TypeScript.","Start here by task: platform overview /cdf/index.md; data modeling /cdf/dm/index.md; data integration /cdf/integration/index.md; access /cdf/access/index.md; CDF Toolkit /cdf/deploy/cdf_toolkit/index.md; REST quickstart /dev/quickstart.md; Python SDK https://cognite-sdk-python.readthedocs-hosted.com/en/stable/; Atlas AI /cdf/atlas_ai/concepts/index.md; Flows apps /cdf/flows/index.md; MCP and IDE setup /dev/guides/ide_ai_integration.md.","For implementation work, also load /skill.md."]},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"de","href":"de"},{"language":"es","href":"es"},{"language":"fr","href":"fr"},{"language":"ko","href":"ko"},{"language":"it","href":"it"},{"language":"lv","href":"lv"},{"language":"nl","href":"nl"},{"language":"ja","href":"ja"},{"language":"no","href":"no"},{"language":"pt","href":"pt"},{"language":"ro","href":"ro"},{"language":"sv","href":"sv"},{"language":"zh","href":"zh"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cognite","hasAudioNarration":false,"actualSubdomain":"cognite","customDomains":["docs.cognite.com"],"gitSource":{"type":"github","owner":"cognitedata","repo":"docs.cognite.com","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true,"contextualFeedback":{"allowEmail":true}},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af312d02e595ebec461cc3b","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"en","tag":"API reference","count":1600},{"language":"en","tag":"Alpha (20230101-alpha)","count":557},{"language":"en","tag":"API reference (20230101-alpha)","count":557},{"language":"en","tag":"Beta (20230101-beta)","count":521},{"language":"en","tag":"API reference (20230101-beta)","count":521},{"language":"en","tag":"Stable (20230101)","count":515},{"language":"en","tag":"API reference (20230101)","count":515},{"language":"en","tag":"Data engineering","count":452},{"language":"en","tag":"Core data","count":314},{"language":"en","tag":"Build","count":294},{"language":"de","tag":"Flows","count":25},{"language":"es","tag":"Flows","count":25},{"language":"fr","tag":"Flows","count":25},{"language":"it","tag":"Flows","count":25},{"language":"ja","tag":"Flows","count":25},{"language":"ko","tag":"Flows","count":25},{"language":"lv","tag":"Flows","count":25},{"language":"nl","tag":"Flows","count":25},{"language":"no","tag":"Flows","count":25},{"language":"pt","tag":"Flows","count":25},{"language":"ro","tag":"Flows","count":25},{"language":"sv","tag":"Flows","count":25},{"language":"zh","tag":"Flows","count":25},{"language":"de","tag":"InField","count":6},{"language":"es","tag":"InField","count":6},{"language":"fr","tag":"InField","count":6},{"language":"it","tag":"InField","count":6},{"language":"ja","tag":"InField","count":6},{"language":"ko","tag":"InField","count":6},{"language":"lv","tag":"InField","count":6},{"language":"nl","tag":"InField","count":6},{"language":"no","tag":"InField","count":6},{"language":"pt","tag":"InField","count":6},{"language":"ro","tag":"InField","count":6},{"language":"sv","tag":"InField","count":6},{"language":"zh","tag":"InField","count":6},{"language":"de","tag":"Willkommen","count":5},{"language":"es","tag":"Bienvenidos","count":5},{"language":"fr","tag":"Bienvenue","count":5},{"language":"it","tag":"Benvenuto","count":5},{"language":"ja","tag":"ようこそ","count":5},{"language":"ko","tag":"환영합니다","count":5},{"language":"lv","tag":"Laipni lūdzam","count":5},{"language":"nl","tag":"Welkom","count":5},{"language":"no","tag":"Velkommen","count":5},{"language":"pt","tag":"Boas-vindas","count":5},{"language":"ro","tag":"Bine ați venit","count":5},{"language":"sv","tag":"Välkommen","count":5},{"language":"zh","tag":"欢迎","count":5},{"language":"de","tag":"Erste Schritte","count":3},{"language":"de","tag":"Maintain","count":3},{"language":"es","tag":"Comenzando","count":3},{"language":"es","tag":"Maintain","count":3},{"language":"fr","tag":"Commencer","count":3},{"language":"fr","tag":"Maintain","count":3},{"language":"it","tag":"Iniziare","count":3},{"language":"it","tag":"Maintain","count":3},{"language":"ja","tag":"始める","count":3},{"language":"ja","tag":"Maintain","count":3},{"language":"ko","tag":"시작하기","count":3},{"language":"ko","tag":"Maintain","count":3},{"language":"lv","tag":"Sākt","count":3},{"language":"lv","tag":"Maintain","count":3},{"language":"nl","tag":"Aan de slag","count":3},{"language":"nl","tag":"Maintain","count":3},{"language":"no","tag":"Kom i gang","count":3},{"language":"no","tag":"Maintain","count":3},{"language":"pt","tag":"Introdução","count":3},{"language":"pt","tag":"Maintain","count":3},{"language":"ro","tag":"Începere","count":3},{"language":"ro","tag":"Maintain","count":3},{"language":"sv","tag":"Komma igång","count":3},{"language":"sv","tag":"Maintain","count":3},{"language":"zh","tag":"开始使用","count":3},{"language":"zh","tag":"Maintain","count":3},{"language":"default","tag":"Build","count":2},{"language":"default","tag":"Industrial Data Science Library","count":1}],"searchSettings":{"fullPageSearch":true}},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":true,"enableAskAiSearchBar":false,"deflection":{"enabled":true,"email":"support@cognite.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"use-workflow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6967906434f9dd976594538d","deploymentId":"68e65d91d34a0d869e1b696c","questionText":"How do I query industrial data?","status":"active","generatedBy":"manual","createdAt":"2026-01-14T12:47:32.944Z","updatedAt":"2026-01-14T12:47:32.944Z","__v":0},{"_id":"6967906134f9dd9765945358","deploymentId":"68e65d91d34a0d869e1b696c","questionText":"What is data modeling in CDF?","status":"active","generatedBy":"manual","createdAt":"2026-01-14T12:47:29.227Z","updatedAt":"2026-01-14T12:47:29.227Z","__v":0},{"_id":"6967905d34f9dd9765945312","deploymentId":"68e65d91d34a0d869e1b696c","questionText":"How do I set up the Cognite Toolkit?","status":"active","generatedBy":"manual","createdAt":"2026-01-14T12:47:25.018Z","updatedAt":"2026-01-14T12:47:25.018Z","__v":0}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"_css/cognite.css","content":".ui-element{font-weight:bold!important}del{text-decoration:none!important}em>strong{font-style:normal!important}em,strong{font-weight:500!important}h5{font-weight:600!important}:root{--cog-table-row-odd-bg: #ffffff;--cog-table-row-even-bg: #f6f8fa}html.dark,[data-theme=\"dark\"]{--cog-table-row-odd-bg: rgba(255, 255, 255, 0.02);--cog-table-row-even-bg: rgba(255, 255, 255, 0.06)}@media (prefers-color-scheme: dark){:root:not(.light):not([data-theme=\"light\"]){--cog-table-row-odd-bg: rgba(255, 255, 255, 0.02);--cog-table-row-even-bg: rgba(255, 255, 255, 0.06)}}table th{text-align:left}.prose table th,.prose table td,.prose table th:first-child,.prose table td:first-child,.prose table th:last-child,.prose table td:last-child{padding-inline-start:0.75rem;padding-inline-end:0.75rem;padding-top:0.5rem;padding-bottom:0.5rem}table tr:nth-child(even){background-color:var(--cog-table-row-even-bg)}table tr:nth-child(odd){background-color:var(--cog-table-row-odd-bg)}.nav-logo{height:36px}.relative.w-4.h-4.rounded-full img{display:none}#localization-select-trigger img.w-full.h-full.rounded-full,#localization-select-trigger .absolute.top-0.left-0{display:none}.absolute.top-0.left-0.w-full.h-full.border.rounded-full{display:none}.back-to-top-container{position:fixed;bottom:80px;right:30px;z-index:50;display:none;transition:right 0.3s ease}@media (max-width: 1280px){.back-to-top-container{bottom:100px;right:20px}}.back-to-top-button{background-color:rgba(60, 95, 251, 0.1);color:#3C5FFB;width:40px;height:40px;border-radius:50%;display:flex;align-items:center;justify-content:center;text-decoration:none;box-shadow:0 4px 6px rgba(0,0,0,0.05);border:1px solid rgba(60, 95, 251, 0.1);cursor:pointer;transition:all 0.2s ease}.back-to-top-button:hover{background-color:rgba(60, 95, 251, 0.2)}html.dark .back-to-top-button,[data-theme=\"dark\"] .back-to-top-button{background-color:rgba(60, 95, 251, 0.25);color:#81a1ff;border-color:rgba(60, 95, 251, 0.4);box-shadow:0 4px 12px rgba(0,0,0,0.3)}html.dark .back-to-top-button:hover,[data-theme=\"dark\"] .back-to-top-button:hover{background-color:rgba(60, 95, 251, 0.35);color:#ffffff}@media (prefers-color-scheme: dark){:root:not(.light):not([data-theme=\"light\"]) .back-to-top-button{background-color:rgba(60, 95, 251, 0.25);color:#81a1ff;border-color:rgba(60, 95, 251, 0.4);box-shadow:0 4px 12px rgba(0,0,0,0.3)}:root:not(.light):not([data-theme=\"light\"]) .back-to-top-button:hover{background-color:rgba(60, 95, 251, 0.35);color:#ffffff}}div[class*=\"code\"] button [role=\"tooltip\"],div[class*=\"Code\"] button [role=\"tooltip\"],pre button [role=\"tooltip\"],button[aria-label*=\"Copy\"] [role=\"tooltip\"],button[aria-label*=\"copy\"] [role=\"tooltip\"],button[aria-label*=\"Ask\"] [role=\"tooltip\"],button[aria-label*=\"Report\"] [role=\"tooltip\"],.group\\/copy-button [role=\"tooltip\"],button.group\\/copy-button [role=\"tooltip\"],[class*=\"copy-button\"] [role=\"tooltip\"]{top:auto!important;bottom:100%!important;margin-bottom:8px!important;transform:translateX(-50%)!important}.code-block:has(.code-block-wrap) [data-floating-buttons=\"true\"]{opacity:1!important}html{scroll-padding-top:120px}@media (max-width: 768px){html{scroll-padding-top:100px}}"},{"filePath":"_styles/aura-primitive-content.css","content":"html[data-current-path^=\"/cdf/aura/primitives/\"] #header .mt-2.text-lg.prose,#content[data-page-href*=\"/cdf/aura/primitives/\"]:not([data-page-href$=\"/index\"]) #header .mt-2.text-lg.prose{max-width:700px}html[data-current-path^=\"/cdf/aura/primitives/\"] #content>:is(h2,h3,h4,h5,h6,p,span[data-as=\"p\"],ul,ol,blockquote,pre,hr),#content[data-page-href*=\"/cdf/aura/primitives/\"]:not([data-page-href$=\"/index\"])>:is(h2,h3,h4,h5,h6,p,span[data-as=\"p\"],ul,ol,blockquote,pre,hr){max-width:700px}"}],"page":{"pagePath":"20230101/documents/search-for-documents","slug":"/20230101/documents/search-for-documents","pageMetadata":{"title":"Search for documents","description":"Searches document text and properties. Requires `filesAcl:READ`. See [Document search](/api-reference/concepts/20230101/search).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /documents/search","href":"/20230101/documents/search-for-documents","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Searches document text and properties. Requires \", _jsx(_components.code, {\n children: \"filesAcl:READ\"\n }), \". See \", _jsx(_components.a, {\n href: \"/api-reference/concepts/20230101/search\",\n children: \"Document search\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"languages":{"custom":["/_languages/kuiper.json"]}},"config":{},"pageMetadata":{"title":"Search for documents","description":"Searches document text and properties. Requires `filesAcl:READ`. See [Document search](/api-reference/concepts/20230101/search).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /documents/search","href":"/20230101/documents/search-for-documents","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/cognite/cb9533f9ff163898/_scripts/back-to-top.js","/_mintlify/custom/cognite/77f6ac33743a5817/_scripts/sidebar-api-20230101-collapse.js","/_mintlify/custom/cognite/237ae201703aad29/_scripts/storybook-theme-sync.js"],"openApiReferenceData":{"operation":{"tags":["Documents"],"summary":"Search for documents","description":"Searches document text and properties. Requires `filesAcl:READ`. See [Document search](/api-reference/concepts/20230101/search).","operationId":"documentsSearch","requestBody":"e842c311-f83c-4a60-9b84-bf0eaccff6b7","responses":{"200":"5ed7a589-461a-43cc-8524-2d2d19fa5b48","400":"ca562fb7-dca9-4bf0-b167-4082782f2d0a"},"x-capability":["filesAcl:READ",null],"x-code-samples":[{"lang":"JavaScript","label":"JavaScript SDK","source":"const documents = await client.documents.search({\n search: {\n query: 'Stuck pipe'\n },\n filter: {\n in: {\n property: ['type'],\n values: ['Document', 'PDF']\n }\n },\n limit: 5\n});"},{"lang":"Python","label":"Python SDK","source":"from cognite.client.data_classes import filters\nfrom cognite.client.data_classes.documents import DocumentProperty\nis_pdf = filters.Equals(DocumentProperty.mime_type, \"application/pdf\")\ndocuments = client.documents.search(\"pump 123\", filter=is_pdf)\n\nfrom datetime import datetime, timedelta\nfrom cognite.client.data_classes import filters\nfrom cognite.client.data_classes.documents import DocumentProperty\nfrom cognite.client.utils import timestamp_to_ms\nis_plain_text = filters.Equals(DocumentProperty.mime_type, \"text/plain\")\nlast_week = filters.Range(DocumentProperty.created_time,\n gt=timestamp_to_ms(datetime.now() - timedelta(days=7)))\ndocuments = client.documents.search('\"CPLEX Error 1217: No Solution exists.\"',\n highlight=True,\n filter=filters.And(is_plain_text, last_week))\n"}],"method":"post","type":"path","servers":["f24fe7dc-1cd1-47fd-aa89-e7ae89a58c10"],"security":["5ed9a804-cdc8-4acd-990a-35c16030ddf0","4bb1f079-a3bf-49ad-99ce-c8631276ee89","fa14b4f0-38c1-441b-b444-8693e76e9d56","4a8349a8-55c0-487f-86ec-cd6ecb3f0725"],"path":"/documents/search","baseUrlOptions":["https://{cluster}.cognitedata.com/api/v1/projects/{project}"],"title":"Search for documents","codeSamples":[{"label":"JavaScript SDK","lang":"JavaScript","source":"const documents = await client.documents.search({\n search: {\n query: 'Stuck pipe'\n },\n filter: {\n in: {\n property: ['type'],\n values: ['Document', 'PDF']\n }\n },\n limit: 5\n});"},{"label":"Python SDK","lang":"Python","source":"from cognite.client.data_classes import filters\nfrom cognite.client.data_classes.documents import DocumentProperty\nis_pdf = filters.Equals(DocumentProperty.mime_type, \"application/pdf\")\ndocuments = client.documents.search(\"pump 123\", filter=is_pdf)\n\nfrom datetime import datetime, timedelta\nfrom cognite.client.data_classes import filters\nfrom cognite.client.data_classes.documents import DocumentProperty\nfrom cognite.client.utils import timestamp_to_ms\nis_plain_text = filters.Equals(DocumentProperty.mime_type, \"text/plain\")\nlast_week = filters.Range(DocumentProperty.created_time,\n gt=timestamp_to_ms(datetime.now() - timedelta(days=7)))\ndocuments = client.documents.search('\"CPLEX Error 1217: No Solution exists.\"',\n highlight=True,\n filter=filters.And(is_plain_text, last_week))\n"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"Fields to be set for the search request.","content":{"application/json":{"schema":{"type":"object","description":"Filter with exact match","properties":{"search":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"The free text search query as described in detail above.","maxLength":1000,"example":"cognite \"lorem ipsum\"","isRequired":true,"uniqueKey":"search.query","typeLabel":"string"},"highlight":{"deprecated":true,"type":"boolean","description":"Whether or not matches in search results should be highlighted.","default":false,"uniqueKey":"search.highlight","typeLabel":"boolean"}},"uniqueKey":"search","typeLabel":"object"},"filter":{"oneOf":[{"type":"object","title":"and","description":"A query that matches items matching boolean combinations of other queries.\nIt is built using one or more boolean clauses, which can be of types: `and`, `or` or `not`\n","required":["and"],"properties":{"and":{"description":"All of the sub-clauses in the query must appear in matching items.","type":"array","minItems":1,"items":{"$circularRef":"1464b7c1-f7ca-4a95-b5e5-37c2c2373530"},"example":[{"prefix":{"property":["name"],"value":"Report"}},{"equals":{"property":["type"],"value":"PDF"}}],"isRequired":true,"uniqueKey":"filter.oneOf.0.and","typeLabel":"array"}},"uniqueKey":"filter.oneOf.0","typeLabel":"and · object"},{"type":"object","title":"or","description":"A query that matches items matching boolean combinations of other queries.\nIt is built using one or more boolean clauses, which can be of types: `and`, `or` or `not`\n","required":["or"],"properties":{"or":{"description":"At least one of the sub-clauses in the query must appear in matching items.","type":"array","minItems":1,"items":{"$circularRef":"1464b7c1-f7ca-4a95-b5e5-37c2c2373530"},"example":[{"prefix":{"property":["name"],"value":"Report"}},{"prefix":{"property":["name"],"value":"Summary"}}],"isRequired":true,"uniqueKey":"filter.oneOf.1.or","typeLabel":"array"}},"uniqueKey":"filter.oneOf.1","typeLabel":"or · object"},{"type":"object","title":"not","description":"A query that matches items matching boolean combinations of other queries.\nIt is built using one or more boolean clauses, which can be of types: `and`, `or` or `not`\n","required":["not"],"properties":{"not":{"type":"object","title":"Filter","description":"Sub-clauses in the query must not appear in matching items.","example":[{"equals":{"property":["type"],"value":"PDF"}}],"isRequired":true,"uniqueKey":"filter.oneOf.2.not","typeLabel":"Filter · object"}},"uniqueKey":"filter.oneOf.2","typeLabel":"not · object"},{"type":"object","title":"equals","description":"Leaf filter","required":["equals"],"properties":{"equals":{"required":["property","value"],"description":"Matches items that contain the exact value in the provided property.","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string","uniqueKey":"filter.oneOf.3.equals.property.items.[INDEX]","typeLabel":"string"},"example":["sourceFile","name"],"isRequired":true,"uniqueKey":"filter.oneOf.3.equals.property","typeLabel":"string[]"},"value":{"oneOf":[{"type":"string","description":"Value you wish to find in the provided property.","isRequired":true,"uniqueKey":"filter.oneOf.3.equals.value.oneOf.0","typeLabel":"string"},{"type":"number","description":"Value you wish to find in the provided property.","isRequired":true,"uniqueKey":"filter.oneOf.3.equals.value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Value you wish to find in the provided property.","isRequired":true,"uniqueKey":"filter.oneOf.3.equals.value.oneOf.2","typeLabel":"boolean"},{"type":"object","title":"Label","description":"Value you wish to find in the provided property.","required":["externalId"],"properties":{"externalId":{"type":"string","description":"An external ID to a predefined label definition.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"filter.oneOf.3.equals.value.oneOf.3.externalId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"filter.oneOf.3.equals.value.oneOf.3","typeLabel":"Label · object"},{"type":"object","description":"Value you wish to find in the provided property.","required":["space","externalId"],"properties":{"space":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$","minLength":1,"maxLength":43,"isRequired":true,"uniqueKey":"filter.oneOf.3.equals.value.oneOf.4.space","typeLabel":"string"},"externalId":{"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"filter.oneOf.3.equals.value.oneOf.4.externalId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"filter.oneOf.3.equals.value.oneOf.4","typeLabel":"object"}],"isRequired":true,"uniqueKey":"filter.oneOf.3.equals.value","typeLabel":"string | number | boolean | Label · object | object"}},"example":{"property":["type"],"value":"PDF"},"isRequired":true,"uniqueKey":"filter.oneOf.3.equals","typeLabel":"object"}},"uniqueKey":"filter.oneOf.3","typeLabel":"equals · object"},{"type":"object","title":"in","description":"Leaf filter","required":["in"],"properties":{"in":{"required":["property","values"],"description":"Matches items where the property matches one of the given values","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string","uniqueKey":"filter.oneOf.4.in.property.items.[INDEX]","typeLabel":"string"},"example":["sourceFile","name"],"isRequired":true,"uniqueKey":"filter.oneOf.4.in.property","typeLabel":"string[]"},"values":{"description":"One or more values you wish to find in the provided property.","type":"array","minItems":1,"maxItems":100,"items":{"oneOf":[{"type":"string","description":"Value you wish to find in the provided property.","uniqueKey":"filter.oneOf.4.in.values.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","description":"Value you wish to find in the provided property.","uniqueKey":"filter.oneOf.4.in.values.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Value you wish to find in the provided property.","uniqueKey":"filter.oneOf.4.in.values.items.[INDEX].oneOf.2","typeLabel":"boolean"},{"type":"object","title":"Label","description":"Value you wish to find in the provided property.","required":["externalId"],"properties":{"externalId":{"type":"string","description":"An external ID to a predefined label definition.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"filter.oneOf.4.in.values.items.[INDEX].oneOf.3.externalId","typeLabel":"string"}},"uniqueKey":"filter.oneOf.4.in.values.items.[INDEX].oneOf.3","typeLabel":"Label · object"},{"type":"object","description":"Value you wish to find in the provided property.","required":["space","externalId"],"properties":{"space":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$","minLength":1,"maxLength":43,"isRequired":true,"uniqueKey":"filter.oneOf.4.in.values.items.[INDEX].oneOf.4.space","typeLabel":"string"},"externalId":{"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"filter.oneOf.4.in.values.items.[INDEX].oneOf.4.externalId","typeLabel":"string"}},"uniqueKey":"filter.oneOf.4.in.values.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"filter.oneOf.4.in.values.items.[INDEX]","typeLabel":"string | number | boolean | Label · object | object"},"isRequired":true,"uniqueKey":"filter.oneOf.4.in.values","typeLabel":"(string | number | boolean | Label · object | object)[]"}},"example":{"property":["author"],"values":["Etiam Eget","Praesent Vestibulum"]},"isRequired":true,"uniqueKey":"filter.oneOf.4.in","typeLabel":"object"}},"uniqueKey":"filter.oneOf.4","typeLabel":"in · object"},{"type":"object","title":"containsAny","description":"Leaf filter","required":["containsAny"],"properties":{"containsAny":{"required":["property","values"],"description":"Matches items where the property contains one or more of the given values","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string","uniqueKey":"filter.oneOf.5.containsAny.property.items.[INDEX]","typeLabel":"string"},"example":["sourceFile","name"],"isRequired":true,"uniqueKey":"filter.oneOf.5.containsAny.property","typeLabel":"string[]"},"values":{"description":"One or more values you wish to find in the provided property.","type":"array","minItems":1,"maxItems":100,"items":{"oneOf":[{"type":"string","description":"Value you wish to find in the provided property.","uniqueKey":"filter.oneOf.5.containsAny.values.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","description":"Value you wish to find in the provided property.","uniqueKey":"filter.oneOf.5.containsAny.values.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Value you wish to find in the provided property.","uniqueKey":"filter.oneOf.5.containsAny.values.items.[INDEX].oneOf.2","typeLabel":"boolean"},{"type":"object","title":"Label","description":"Value you wish to find in the provided property.","required":["externalId"],"properties":{"externalId":{"type":"string","description":"An external ID to a predefined label definition.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"filter.oneOf.5.containsAny.values.items.[INDEX].oneOf.3.externalId","typeLabel":"string"}},"uniqueKey":"filter.oneOf.5.containsAny.values.items.[INDEX].oneOf.3","typeLabel":"Label · object"},{"type":"object","description":"Value you wish to find in the provided property.","required":["space","externalId"],"properties":{"space":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$","minLength":1,"maxLength":43,"isRequired":true,"uniqueKey":"filter.oneOf.5.containsAny.values.items.[INDEX].oneOf.4.space","typeLabel":"string"},"externalId":{"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"filter.oneOf.5.containsAny.values.items.[INDEX].oneOf.4.externalId","typeLabel":"string"}},"uniqueKey":"filter.oneOf.5.containsAny.values.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"filter.oneOf.5.containsAny.values.items.[INDEX]","typeLabel":"string | number | boolean | Label · object | object"},"isRequired":true,"uniqueKey":"filter.oneOf.5.containsAny.values","typeLabel":"(string | number | boolean | Label · object | object)[]"}},"example":{"property":["assetIds"],"values":[51276,94287]},"isRequired":true,"uniqueKey":"filter.oneOf.5.containsAny","typeLabel":"object"}},"uniqueKey":"filter.oneOf.5","typeLabel":"containsAny · object"},{"type":"object","title":"containsAll","description":"Leaf filter","required":["containsAll"],"properties":{"containsAll":{"required":["property","values"],"description":"Matches items where the property contains all the given values","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string","uniqueKey":"filter.oneOf.6.containsAll.property.items.[INDEX]","typeLabel":"string"},"example":["sourceFile","name"],"isRequired":true,"uniqueKey":"filter.oneOf.6.containsAll.property","typeLabel":"string[]"},"values":{"description":"One or more values you wish to find in the provided property.","type":"array","minItems":1,"maxItems":100,"items":{"oneOf":[{"type":"string","description":"Value you wish to find in the provided property.","uniqueKey":"filter.oneOf.6.containsAll.values.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","description":"Value you wish to find in the provided property.","uniqueKey":"filter.oneOf.6.containsAll.values.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Value you wish to find in the provided property.","uniqueKey":"filter.oneOf.6.containsAll.values.items.[INDEX].oneOf.2","typeLabel":"boolean"},{"type":"object","title":"Label","description":"Value you wish to find in the provided property.","required":["externalId"],"properties":{"externalId":{"type":"string","description":"An external ID to a predefined label definition.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"filter.oneOf.6.containsAll.values.items.[INDEX].oneOf.3.externalId","typeLabel":"string"}},"uniqueKey":"filter.oneOf.6.containsAll.values.items.[INDEX].oneOf.3","typeLabel":"Label · object"},{"type":"object","description":"Value you wish to find in the provided property.","required":["space","externalId"],"properties":{"space":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$","minLength":1,"maxLength":43,"isRequired":true,"uniqueKey":"filter.oneOf.6.containsAll.values.items.[INDEX].oneOf.4.space","typeLabel":"string"},"externalId":{"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"filter.oneOf.6.containsAll.values.items.[INDEX].oneOf.4.externalId","typeLabel":"string"}},"uniqueKey":"filter.oneOf.6.containsAll.values.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"filter.oneOf.6.containsAll.values.items.[INDEX]","typeLabel":"string | number | boolean | Label · object | object"},"isRequired":true,"uniqueKey":"filter.oneOf.6.containsAll.values","typeLabel":"(string | number | boolean | Label · object | object)[]"}},"example":{"property":["assetIds"],"values":[51276,94287]},"isRequired":true,"uniqueKey":"filter.oneOf.6.containsAll","typeLabel":"object"}},"uniqueKey":"filter.oneOf.6","typeLabel":"containsAll · object"},{"type":"object","title":"range","description":"Leaf filter","required":["range"],"properties":{"range":{"required":["property"],"description":"Matches items that contain terms within the provided range.\nRange must include both an upper and a lower bound. It is not allowed to specify both inclusive and exclusive\nbounds (like `gte`, `gt`) together.\n`gte`: Greater than or equal to.\n`gt`: Greater than.\n`lte`: Less than or equal to.\n`lt`: Less than.\n","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string","uniqueKey":"filter.oneOf.7.range.property.items.[INDEX]","typeLabel":"string"},"example":["sourceFile","name"],"isRequired":true,"uniqueKey":"filter.oneOf.7.range.property","typeLabel":"string[]"},"gte":{"description":"Value you wish to find in the provided property using a range clause.","type":"number","uniqueKey":"filter.oneOf.7.range.gte","typeLabel":"number"},"gt":{"description":"Value you wish to find in the provided property using a range clause.","type":"number","uniqueKey":"filter.oneOf.7.range.gt","typeLabel":"number"},"lte":{"description":"Value you wish to find in the provided property using a range clause.","type":"number","uniqueKey":"filter.oneOf.7.range.lte","typeLabel":"number"},"lt":{"description":"Value you wish to find in the provided property using a range clause.","type":"number","uniqueKey":"filter.oneOf.7.range.lt","typeLabel":"number"}},"example":{"property":["createdTime"],"gte":1609459200000,"lt":1640995200000},"isRequired":true,"uniqueKey":"filter.oneOf.7.range","typeLabel":"object"}},"uniqueKey":"filter.oneOf.7","typeLabel":"range · object"},{"type":"object","title":"prefix","description":"Leaf filter","required":["prefix"],"properties":{"prefix":{"required":["property","value"],"description":"Matches items that contain a specific prefix in the provided property.","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string","uniqueKey":"filter.oneOf.8.prefix.property.items.[INDEX]","typeLabel":"string"},"example":["sourceFile","name"],"isRequired":true,"uniqueKey":"filter.oneOf.8.prefix.property","typeLabel":"string[]"},"value":{"oneOf":[{"type":"string","description":"Value you wish to find in the provided property.","isRequired":true,"uniqueKey":"filter.oneOf.8.prefix.value.oneOf.0","typeLabel":"string"},{"type":"number","description":"Value you wish to find in the provided property.","isRequired":true,"uniqueKey":"filter.oneOf.8.prefix.value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Value you wish to find in the provided property.","isRequired":true,"uniqueKey":"filter.oneOf.8.prefix.value.oneOf.2","typeLabel":"boolean"},{"type":"object","title":"Label","description":"Value you wish to find in the provided property.","required":["externalId"],"properties":{"externalId":{"type":"string","description":"An external ID to a predefined label definition.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"filter.oneOf.8.prefix.value.oneOf.3.externalId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"filter.oneOf.8.prefix.value.oneOf.3","typeLabel":"Label · object"},{"type":"object","description":"Value you wish to find in the provided property.","required":["space","externalId"],"properties":{"space":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$","minLength":1,"maxLength":43,"isRequired":true,"uniqueKey":"filter.oneOf.8.prefix.value.oneOf.4.space","typeLabel":"string"},"externalId":{"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"filter.oneOf.8.prefix.value.oneOf.4.externalId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"filter.oneOf.8.prefix.value.oneOf.4","typeLabel":"object"}],"isRequired":true,"uniqueKey":"filter.oneOf.8.prefix.value","typeLabel":"string | number | boolean | Label · object | object"}},"example":{"property":["name"],"value":"Report"},"isRequired":true,"uniqueKey":"filter.oneOf.8.prefix","typeLabel":"object"}},"uniqueKey":"filter.oneOf.8","typeLabel":"prefix · object"},{"type":"object","title":"search","description":"Leaf filter","required":["search"],"properties":{"search":{"required":["property","value"],"description":"Matches items that contains the search query.","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string","uniqueKey":"filter.oneOf.9.search.property.items.[INDEX]","typeLabel":"string"},"example":["sourceFile","name"],"isRequired":true,"uniqueKey":"filter.oneOf.9.search.property","typeLabel":"string[]"},"value":{"type":"string","isRequired":true,"uniqueKey":"filter.oneOf.9.search.value","typeLabel":"string"}},"example":{"property":["content"],"value":"Report"},"isRequired":true,"uniqueKey":"filter.oneOf.9.search","typeLabel":"object"}},"uniqueKey":"filter.oneOf.9","typeLabel":"search · object"},{"type":"object","title":"exists","description":"Leaf filter","required":["exists"],"properties":{"exists":{"required":["property"],"description":"Matches items that contain a value for the provided property.","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string","uniqueKey":"filter.oneOf.10.exists.property.items.[INDEX]","typeLabel":"string"},"example":["sourceFile","name"],"isRequired":true,"uniqueKey":"filter.oneOf.10.exists.property","typeLabel":"string[]"}},"example":{"property":["language"]},"isRequired":true,"uniqueKey":"filter.oneOf.10.exists","typeLabel":"object"}},"uniqueKey":"filter.oneOf.10","typeLabel":"exists · object"},{"type":"object","title":"geojsonIntersects","description":"Leaf filter","required":["geojsonIntersects"],"properties":{"geojsonIntersects":{"required":["property","geometry"],"description":"Matches items with geolocations that intersect the provided geometry","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string","uniqueKey":"filter.oneOf.11.geojsonIntersects.property.items.[INDEX]","typeLabel":"string"},"example":["sourceFile","name"],"isRequired":true,"uniqueKey":"filter.oneOf.11.geojsonIntersects.property","typeLabel":"string[]"},"geometry":{"description":"GeoJSON Geometry.","type":"object","required":["type"],"properties":{"type":{"description":"Type of the GeoJSON Geometry. When filtering there is a limit of specifying up to 100 positions in the data.","type":"string","example":"Point","isRequired":true,"uniqueKey":"filter.oneOf.11.geojsonIntersects.geometry.type","typeLabel":"string"},"coordinates":{"oneOf":[{"type":"array","items":{"type":"number","format":"float","uniqueKey":"filter.oneOf.11.geojsonIntersects.geometry.coordinates.oneOf.0.items.[INDEX]","typeLabel":"number\u003cfloat>"},"description":"Coordinates of the geometry.","example":[10.74609,59.91273],"uniqueKey":"filter.oneOf.11.geojsonIntersects.geometry.coordinates.oneOf.0","typeLabel":"number\u003cfloat>[]"},{"type":"array","items":{"type":"array","items":{"type":"number","format":"float","uniqueKey":"filter.oneOf.11.geojsonIntersects.geometry.coordinates.oneOf.1.items.[INDEX].items.[INDEX]","typeLabel":"number\u003cfloat>"},"uniqueKey":"filter.oneOf.11.geojsonIntersects.geometry.coordinates.oneOf.1.items.[INDEX]","typeLabel":"number\u003cfloat>[]"},"description":"Coordinates of the geometry.","uniqueKey":"filter.oneOf.11.geojsonIntersects.geometry.coordinates.oneOf.1","typeLabel":"number\u003cfloat>[][]"},{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number","format":"float","uniqueKey":"filter.oneOf.11.geojsonIntersects.geometry.coordinates.oneOf.2.items.[INDEX].items.[INDEX].items.[INDEX]","typeLabel":"number\u003cfloat>"},"uniqueKey":"filter.oneOf.11.geojsonIntersects.geometry.coordinates.oneOf.2.items.[INDEX].items.[INDEX]","typeLabel":"number\u003cfloat>[]"},"uniqueKey":"filter.oneOf.11.geojsonIntersects.geometry.coordinates.oneOf.2.items.[INDEX]","typeLabel":"number\u003cfloat>[][]"},"description":"Coordinates of the geometry.","uniqueKey":"filter.oneOf.11.geojsonIntersects.geometry.coordinates.oneOf.2","typeLabel":"number\u003cfloat>[][][]"}],"uniqueKey":"filter.oneOf.11.geojsonIntersects.geometry.coordinates","typeLabel":"number\u003cfloat>[] | number\u003cfloat>[][] | number\u003cfloat>[][][]"},"geometries":{"type":"array","description":"List of geometries for a GeometryCollection. Nested GeometryCollection is not supported","items":{"$circularRef":"af0a78cf-bce7-4c92-8c65-4dbe1df102bf"},"uniqueKey":"filter.oneOf.11.geojsonIntersects.geometry.geometries","typeLabel":"array"}},"example":{"type":"Point","coordinates":[10.74609,59.91273]},"isRequired":true,"uniqueKey":"filter.oneOf.11.geojsonIntersects.geometry","typeLabel":"object"}},"isRequired":true,"uniqueKey":"filter.oneOf.11.geojsonIntersects","typeLabel":"object"}},"uniqueKey":"filter.oneOf.11","typeLabel":"geojsonIntersects · object"},{"type":"object","title":"geojsonDisjoint","description":"Leaf filter","required":["geojsonDisjoint"],"properties":{"geojsonDisjoint":{"required":["property","geometry"],"description":"Matches items with geolocations that are disjoint from the provided geometry","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string","uniqueKey":"filter.oneOf.12.geojsonDisjoint.property.items.[INDEX]","typeLabel":"string"},"example":["sourceFile","name"],"isRequired":true,"uniqueKey":"filter.oneOf.12.geojsonDisjoint.property","typeLabel":"string[]"},"geometry":{"description":"GeoJSON Geometry.","type":"object","required":["type"],"properties":{"type":{"description":"Type of the GeoJSON Geometry. When filtering there is a limit of specifying up to 100 positions in the data.","type":"string","example":"Point","isRequired":true,"uniqueKey":"filter.oneOf.12.geojsonDisjoint.geometry.type","typeLabel":"string"},"coordinates":{"oneOf":[{"type":"array","items":{"type":"number","format":"float","uniqueKey":"filter.oneOf.12.geojsonDisjoint.geometry.coordinates.oneOf.0.items.[INDEX]","typeLabel":"number\u003cfloat>"},"description":"Coordinates of the geometry.","example":[10.74609,59.91273],"uniqueKey":"filter.oneOf.12.geojsonDisjoint.geometry.coordinates.oneOf.0","typeLabel":"number\u003cfloat>[]"},{"type":"array","items":{"type":"array","items":{"type":"number","format":"float","uniqueKey":"filter.oneOf.12.geojsonDisjoint.geometry.coordinates.oneOf.1.items.[INDEX].items.[INDEX]","typeLabel":"number\u003cfloat>"},"uniqueKey":"filter.oneOf.12.geojsonDisjoint.geometry.coordinates.oneOf.1.items.[INDEX]","typeLabel":"number\u003cfloat>[]"},"description":"Coordinates of the geometry.","uniqueKey":"filter.oneOf.12.geojsonDisjoint.geometry.coordinates.oneOf.1","typeLabel":"number\u003cfloat>[][]"},{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number","format":"float","uniqueKey":"filter.oneOf.12.geojsonDisjoint.geometry.coordinates.oneOf.2.items.[INDEX].items.[INDEX].items.[INDEX]","typeLabel":"number\u003cfloat>"},"uniqueKey":"filter.oneOf.12.geojsonDisjoint.geometry.coordinates.oneOf.2.items.[INDEX].items.[INDEX]","typeLabel":"number\u003cfloat>[]"},"uniqueKey":"filter.oneOf.12.geojsonDisjoint.geometry.coordinates.oneOf.2.items.[INDEX]","typeLabel":"number\u003cfloat>[][]"},"description":"Coordinates of the geometry.","uniqueKey":"filter.oneOf.12.geojsonDisjoint.geometry.coordinates.oneOf.2","typeLabel":"number\u003cfloat>[][][]"}],"uniqueKey":"filter.oneOf.12.geojsonDisjoint.geometry.coordinates","typeLabel":"number\u003cfloat>[] | number\u003cfloat>[][] | number\u003cfloat>[][][]"},"geometries":{"type":"array","description":"List of geometries for a GeometryCollection. Nested GeometryCollection is not supported","items":{"$circularRef":"af0a78cf-bce7-4c92-8c65-4dbe1df102bf"},"uniqueKey":"filter.oneOf.12.geojsonDisjoint.geometry.geometries","typeLabel":"array"}},"example":{"type":"Point","coordinates":[10.74609,59.91273]},"isRequired":true,"uniqueKey":"filter.oneOf.12.geojsonDisjoint.geometry","typeLabel":"object"}},"isRequired":true,"uniqueKey":"filter.oneOf.12.geojsonDisjoint","typeLabel":"object"}},"uniqueKey":"filter.oneOf.12","typeLabel":"geojsonDisjoint · object"},{"type":"object","title":"geojsonWithin","description":"Leaf filter","required":["geojsonWithin"],"properties":{"geojsonWithin":{"required":["property","geometry"],"description":"Matches items with geolocations that are within the provided geometry","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string","uniqueKey":"filter.oneOf.13.geojsonWithin.property.items.[INDEX]","typeLabel":"string"},"example":["sourceFile","name"],"isRequired":true,"uniqueKey":"filter.oneOf.13.geojsonWithin.property","typeLabel":"string[]"},"geometry":{"description":"GeoJSON Geometry.","type":"object","required":["type"],"properties":{"type":{"description":"Type of the GeoJSON Geometry. When filtering there is a limit of specifying up to 100 positions in the data.","type":"string","example":"Point","isRequired":true,"uniqueKey":"filter.oneOf.13.geojsonWithin.geometry.type","typeLabel":"string"},"coordinates":{"oneOf":[{"type":"array","items":{"type":"number","format":"float","uniqueKey":"filter.oneOf.13.geojsonWithin.geometry.coordinates.oneOf.0.items.[INDEX]","typeLabel":"number\u003cfloat>"},"description":"Coordinates of the geometry.","example":[10.74609,59.91273],"uniqueKey":"filter.oneOf.13.geojsonWithin.geometry.coordinates.oneOf.0","typeLabel":"number\u003cfloat>[]"},{"type":"array","items":{"type":"array","items":{"type":"number","format":"float","uniqueKey":"filter.oneOf.13.geojsonWithin.geometry.coordinates.oneOf.1.items.[INDEX].items.[INDEX]","typeLabel":"number\u003cfloat>"},"uniqueKey":"filter.oneOf.13.geojsonWithin.geometry.coordinates.oneOf.1.items.[INDEX]","typeLabel":"number\u003cfloat>[]"},"description":"Coordinates of the geometry.","uniqueKey":"filter.oneOf.13.geojsonWithin.geometry.coordinates.oneOf.1","typeLabel":"number\u003cfloat>[][]"},{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number","format":"float","uniqueKey":"filter.oneOf.13.geojsonWithin.geometry.coordinates.oneOf.2.items.[INDEX].items.[INDEX].items.[INDEX]","typeLabel":"number\u003cfloat>"},"uniqueKey":"filter.oneOf.13.geojsonWithin.geometry.coordinates.oneOf.2.items.[INDEX].items.[INDEX]","typeLabel":"number\u003cfloat>[]"},"uniqueKey":"filter.oneOf.13.geojsonWithin.geometry.coordinates.oneOf.2.items.[INDEX]","typeLabel":"number\u003cfloat>[][]"},"description":"Coordinates of the geometry.","uniqueKey":"filter.oneOf.13.geojsonWithin.geometry.coordinates.oneOf.2","typeLabel":"number\u003cfloat>[][][]"}],"uniqueKey":"filter.oneOf.13.geojsonWithin.geometry.coordinates","typeLabel":"number\u003cfloat>[] | number\u003cfloat>[][] | number\u003cfloat>[][][]"},"geometries":{"type":"array","description":"List of geometries for a GeometryCollection. Nested GeometryCollection is not supported","items":{"$circularRef":"af0a78cf-bce7-4c92-8c65-4dbe1df102bf"},"uniqueKey":"filter.oneOf.13.geojsonWithin.geometry.geometries","typeLabel":"array"}},"example":{"type":"Point","coordinates":[10.74609,59.91273]},"isRequired":true,"uniqueKey":"filter.oneOf.13.geojsonWithin.geometry","typeLabel":"object"}},"isRequired":true,"uniqueKey":"filter.oneOf.13.geojsonWithin","typeLabel":"object"}},"uniqueKey":"filter.oneOf.13","typeLabel":"geojsonWithin · object"},{"type":"object","title":"inAssetSubtree","description":"Leaf filter","required":["inAssetSubtree"],"properties":{"inAssetSubtree":{"required":["property","values"],"description":"Matches items where the property contains one or more assets in a subtree rooted at any of the given values","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string","uniqueKey":"filter.oneOf.14.inAssetSubtree.property.items.[INDEX]","typeLabel":"string"},"example":["sourceFile","name"],"isRequired":true,"uniqueKey":"filter.oneOf.14.inAssetSubtree.property","typeLabel":"string[]"},"values":{"description":"One or more values you wish to find in the provided property.","type":"array","minItems":1,"maxItems":100,"items":{"oneOf":[{"type":"string","description":"Value you wish to find in the provided property.","uniqueKey":"filter.oneOf.14.inAssetSubtree.values.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","description":"Value you wish to find in the provided property.","uniqueKey":"filter.oneOf.14.inAssetSubtree.values.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Value you wish to find in the provided property.","uniqueKey":"filter.oneOf.14.inAssetSubtree.values.items.[INDEX].oneOf.2","typeLabel":"boolean"},{"type":"object","title":"Label","description":"Value you wish to find in the provided property.","required":["externalId"],"properties":{"externalId":{"type":"string","description":"An external ID to a predefined label definition.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"filter.oneOf.14.inAssetSubtree.values.items.[INDEX].oneOf.3.externalId","typeLabel":"string"}},"uniqueKey":"filter.oneOf.14.inAssetSubtree.values.items.[INDEX].oneOf.3","typeLabel":"Label · object"},{"type":"object","description":"Value you wish to find in the provided property.","required":["space","externalId"],"properties":{"space":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$","minLength":1,"maxLength":43,"isRequired":true,"uniqueKey":"filter.oneOf.14.inAssetSubtree.values.items.[INDEX].oneOf.4.space","typeLabel":"string"},"externalId":{"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"filter.oneOf.14.inAssetSubtree.values.items.[INDEX].oneOf.4.externalId","typeLabel":"string"}},"uniqueKey":"filter.oneOf.14.inAssetSubtree.values.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"filter.oneOf.14.inAssetSubtree.values.items.[INDEX]","typeLabel":"string | number | boolean | Label · object | object"},"isRequired":true,"uniqueKey":"filter.oneOf.14.inAssetSubtree.values","typeLabel":"(string | number | boolean | Label · object | object)[]"}},"example":{"property":["assetIds"],"values":[51276,94287]},"isRequired":true,"uniqueKey":"filter.oneOf.14.inAssetSubtree","typeLabel":"object"}},"uniqueKey":"filter.oneOf.14","typeLabel":"inAssetSubtree · object"}],"uniqueKey":"filter","typeLabel":"and · object | or · object | not · object | equals · object | in · object | containsAny · object | containsAll · object | range · object | prefix · object | search · object | exists · object | geojsonIntersects · object | geojsonDisjoint · object | geojsonWithin · object | inAssetSubtree · object"},"sort":{"type":"array","description":"List of properties to sort by. Currently only supports 1 property.","minItems":1,"maxItems":1,"items":{"type":"object","required":["property"],"properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string","uniqueKey":"sort.items.[INDEX].property.items.[INDEX]","typeLabel":"string"},"example":["sourceFile","name"],"isRequired":true,"uniqueKey":"sort.items.[INDEX].property","typeLabel":"string[]"},"order":{"type":"string","enum":["asc","desc"],"default":"asc","uniqueKey":"sort.items.[INDEX].order","typeLabel":"enum\u003cstring>"}},"uniqueKey":"sort.items.[INDEX]","typeLabel":"object"},"uniqueKey":"sort","typeLabel":"object[]"},"limit":{"description":"Maximum number of items. When using highlights the maximum value is reduced to 20.","type":"integer","format":"int32","minimum":0,"maximum":1000,"default":100,"uniqueKey":"limit","typeLabel":"integer\u003cint32>"},"cursor":{"type":"string","description":"Cursor for paging through results.","uniqueKey":"cursor","typeLabel":"string"},"highlight":{"description":"Whether or not matches in search results should be highlighted.","type":"boolean","uniqueKey":"highlight","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"filter":{"and":[{"prefix":{"property":["name"],"value":"Report"}},{"equals":{"property":["type"],"value":"PDF"}}]},"sort":[{"property":["sourceFile","name"],"order":"asc"}],"limit":100,"cursor":"\u003cstring>","highlight":true}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"5ed7a589-461a-43cc-8524-2d2d19fa5b48":{"description":"The results of a search.","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["item"],"properties":{"item":{"type":"object","required":["id","createdTime","sourceFile"],"description":"A document","properties":{"id":{"type":"integer","description":"The unique identifier for the document. This is automatically generated by CDF, and will be the same as the corresponding value in the Files API.","format":"int64","maximum":9007199254740991,"minimum":1,"example":2384,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].item.id","typeLabel":"integer\u003cint64>"},"createdTime":{"type":"integer","description":"When the document was created, measured in milliseconds since 00:00:00 Thursday, 1 January 1970. We do a best effort to determine the created time for the document, and it will be derived from either the document metadata, the user-specified created time provided when uploading the file or as a last resort the creation timestamp of the underlying file resource.","format":"int64","minimum":0,"example":1519862400000,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].item.createdTime","typeLabel":"integer\u003cint64>"},"sourceFile":{"type":"object","description":"The source file that this document is derived from.","required":["name"],"properties":{"name":{"type":"string","description":"Name of the file.","example":"hamlet.txt","isRequired":true,"uniqueKey":"\\items.items.[INDEX].item.sourceFile.name","typeLabel":"string"},"directory":{"type":"string","description":"The directory the file can be found in","example":"plays/shakespeare","uniqueKey":"\\items.items.[INDEX].item.sourceFile.directory","typeLabel":"string"},"source":{"type":"string","description":"The source of the file","example":"SubsurfaceConnectors","uniqueKey":"\\items.items.[INDEX].item.sourceFile.source","typeLabel":"string"},"mimeType":{"type":"string","description":"The mime type of the file","example":"application/octet-stream","uniqueKey":"\\items.items.[INDEX].item.sourceFile.mimeType","typeLabel":"string"},"size":{"type":"number","format":"int64","description":"The size of the source file in bytes","example":1000,"uniqueKey":"\\items.items.[INDEX].item.sourceFile.size","typeLabel":"number\u003cint64>"},"hash":{"type":"string","description":"The hash of the source file. This is a SHA256 hash of the original file. The hash only covers the file content, and not other CDF metadata.","example":"23203f9264161714cdb8d2f474b9b641e6a735f8cea4098c40a3cab8743bd749","uniqueKey":"\\items.items.[INDEX].item.sourceFile.hash","typeLabel":"string"},"assetIds":{"type":"array","description":"The ids of the assets related to this file","example":[],"items":{"description":"A server-generated ID for the object.","type":"integer","minimum":1,"maximum":9007199254740991,"format":"int64","uniqueKey":"\\items.items.[INDEX].item.sourceFile.assetIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"uniqueKey":"\\items.items.[INDEX].item.sourceFile.assetIds","typeLabel":"integer\u003cint64>[]"},"labels":{"type":"array","items":{"type":"object","title":"Label","required":["externalId"],"description":"A label assigned to a resource.","properties":{"externalId":{"type":"string","description":"An external ID to a predefined label definition.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].item.sourceFile.labels.items.[INDEX].externalId","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].item.sourceFile.labels.items.[INDEX]","typeLabel":"Label · object"},"description":"A list of the labels associated with this resource item.","maxItems":10,"minItems":0,"uniqueItems":true,"example":[{"externalId":"play"},{"externalId":"tragedy"}],"uniqueKey":"\\items.items.[INDEX].item.sourceFile.labels","typeLabel":"Label · object[]"},"geoLocation":{"description":"GeoJSON Geometry.","type":"object","required":["type"],"properties":{"type":{"description":"Type of the GeoJSON Geometry. When filtering there is a limit of specifying up to 100 positions in the data.","type":"string","example":"Point","isRequired":true,"uniqueKey":"\\items.items.[INDEX].item.sourceFile.geoLocation.type","typeLabel":"string"},"coordinates":{"oneOf":[{"type":"array","items":{"type":"number","format":"float","uniqueKey":"\\items.items.[INDEX].item.sourceFile.geoLocation.coordinates.oneOf.0.items.[INDEX]","typeLabel":"number\u003cfloat>"},"description":"Coordinates of the geometry.","example":[10.74609,59.91273],"uniqueKey":"\\items.items.[INDEX].item.sourceFile.geoLocation.coordinates.oneOf.0","typeLabel":"number\u003cfloat>[]"},{"type":"array","items":{"type":"array","items":{"type":"number","format":"float","uniqueKey":"\\items.items.[INDEX].item.sourceFile.geoLocation.coordinates.oneOf.1.items.[INDEX].items.[INDEX]","typeLabel":"number\u003cfloat>"},"uniqueKey":"\\items.items.[INDEX].item.sourceFile.geoLocation.coordinates.oneOf.1.items.[INDEX]","typeLabel":"number\u003cfloat>[]"},"description":"Coordinates of the geometry.","uniqueKey":"\\items.items.[INDEX].item.sourceFile.geoLocation.coordinates.oneOf.1","typeLabel":"number\u003cfloat>[][]"},{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number","format":"float","uniqueKey":"\\items.items.[INDEX].item.sourceFile.geoLocation.coordinates.oneOf.2.items.[INDEX].items.[INDEX].items.[INDEX]","typeLabel":"number\u003cfloat>"},"uniqueKey":"\\items.items.[INDEX].item.sourceFile.geoLocation.coordinates.oneOf.2.items.[INDEX].items.[INDEX]","typeLabel":"number\u003cfloat>[]"},"uniqueKey":"\\items.items.[INDEX].item.sourceFile.geoLocation.coordinates.oneOf.2.items.[INDEX]","typeLabel":"number\u003cfloat>[][]"},"description":"Coordinates of the geometry.","uniqueKey":"\\items.items.[INDEX].item.sourceFile.geoLocation.coordinates.oneOf.2","typeLabel":"number\u003cfloat>[][][]"}],"uniqueKey":"\\items.items.[INDEX].item.sourceFile.geoLocation.coordinates","typeLabel":"number\u003cfloat>[] | number\u003cfloat>[][] | number\u003cfloat>[][][]"},"geometries":{"type":"array","description":"List of geometries for a GeometryCollection. Nested GeometryCollection is not supported","items":{"$circularRef":"af0a78cf-bce7-4c92-8c65-4dbe1df102bf"},"uniqueKey":"\\items.items.[INDEX].item.sourceFile.geoLocation.geometries","typeLabel":"array"}},"example":{"type":"Point","coordinates":[10.74609,59.91273]},"uniqueKey":"\\items.items.[INDEX].item.sourceFile.geoLocation","typeLabel":"object"},"datasetId":{"type":"integer","description":"The id if the dataset this file belongs to, if any","format":"int64","maximum":9007199254740991,"minimum":1,"uniqueKey":"\\items.items.[INDEX].item.sourceFile.datasetId","typeLabel":"integer\u003cint64>"},"securityCategories":{"type":"array","description":"The security category IDs required to access this file","example":[],"items":{"type":"number","format":"int64","uniqueKey":"\\items.items.[INDEX].item.sourceFile.securityCategories.items.[INDEX]","typeLabel":"number\u003cint64>"},"uniqueKey":"\\items.items.[INDEX].item.sourceFile.securityCategories","typeLabel":"number\u003cint64>[]"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"\\items.items.[INDEX].item.sourceFile.metadata.additionalProperties","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].item.sourceFile.metadata","typeLabel":"object"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].item.sourceFile","typeLabel":"object"},"externalId":{"type":"string","description":"The external ID for the document. This field will be the same as the value set in the Files API.","maxLength":255,"example":"haml001","uniqueKey":"\\items.items.[INDEX].item.externalId","typeLabel":"string"},"instanceId":{"type":"object","description":"The instance ID for documents created through Data Modeling. This field will be the same as the value set in the Files API.","required":["space","externalId"],"properties":{"space":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$","minLength":1,"maxLength":43,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].item.instanceId.space","typeLabel":"string"},"externalId":{"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].item.instanceId.externalId","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].item.instanceId","typeLabel":"object"},"title":{"description":"The title of the document","type":"string","example":"Hamlet","uniqueKey":"\\items.items.[INDEX].item.title","typeLabel":"string"},"author":{"description":"The author of the document","type":"string","example":"William Shakespeare","uniqueKey":"\\items.items.[INDEX].item.author","typeLabel":"string"},"producer":{"description":"The producer of the document. Many document types contain metadata indicating what software or system was used to create the document.","type":"string","uniqueKey":"\\items.items.[INDEX].item.producer","typeLabel":"string"},"modifiedTime":{"type":"integer","description":"When the document was last modified, measured in milliseconds since 00:00:00 Thursday, 1 January 1970. This holdes the user-specified modified time provided for the underlying file resource, but might in the future also be derived from document metadata.","format":"int64","minimum":0,"example":1519958703000,"uniqueKey":"\\items.items.[INDEX].item.modifiedTime","typeLabel":"integer\u003cint64>"},"lastIndexedTime":{"type":"integer","description":"When the document was last indexed in the documents search engine, measured in milliseconds since 00:00:00 Thursday, 1 January 1970.","format":"int64","minimum":0,"example":1521062805000,"uniqueKey":"\\items.items.[INDEX].item.lastIndexedTime","typeLabel":"integer\u003cint64>"},"mimeType":{"description":"Detected mime type for the document","type":"string","example":"text/plain","uniqueKey":"\\items.items.[INDEX].item.mimeType","typeLabel":"string"},"extension":{"type":"string","description":"Extension of the file (always in lowercase)","example":"pdf","uniqueKey":"\\items.items.[INDEX].item.extension","typeLabel":"string"},"pageCount":{"description":"Number of pages for multi-page documents","type":"integer","format":"int32","example":2,"uniqueKey":"\\items.items.[INDEX].item.pageCount","typeLabel":"integer\u003cint32>"},"type":{"description":"Detected type of document","type":"string","example":"Document","uniqueKey":"\\items.items.[INDEX].item.type","typeLabel":"string"},"language":{"description":"The detected language used in the document","type":"string","example":"en","uniqueKey":"\\items.items.[INDEX].item.language","typeLabel":"string"},"truncatedContent":{"description":"The textual content of the document. Truncated to 155 characters but subject to change","type":"string","example":"ACT I\nSCENE I. Elsinore. A platform before the castle.\n FRANCISCO at his post. Enter to him BERNARDO\nBERNARDO\n Who's there?\n","uniqueKey":"\\items.items.[INDEX].item.truncatedContent","typeLabel":"string"},"assetIds":{"deprecated":true,"description":"The ids of any assets referred to in the document","type":"array","example":[42,101],"items":{"description":"A server-generated ID for the object.","type":"integer","minimum":1,"maximum":9007199254740991,"format":"int64","uniqueKey":"\\items.items.[INDEX].item.assetIds.items.[INDEX]","typeLabel":"integer\u003cint64>"},"uniqueKey":"\\items.items.[INDEX].item.assetIds","typeLabel":"integer\u003cint64>[]"},"labels":{"type":"array","items":{"type":"object","title":"Label","required":["externalId"],"description":"A label assigned to a resource.","properties":{"externalId":{"type":"string","description":"An external ID to a predefined label definition.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].item.labels.items.[INDEX].externalId","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].item.labels.items.[INDEX]","typeLabel":"Label · object"},"description":"A list of the labels associated with this resource item.","maxItems":10,"minItems":0,"uniqueItems":true,"deprecated":true,"uniqueKey":"\\items.items.[INDEX].item.labels","typeLabel":"Label · object[]"},"geoLocation":{"type":"object","description":"Geolocation derived for this document. Represented using a GeoJSON Geometry.\n\nThe derived geolocation also includes geolocation information from a matched\nasset (see assetIds property). For matched assets without geolocation information\nthe parent chain is followed until it finds an asset with geolocation information.\n","required":["type"],"deprecated":true,"example":{"type":"Point","coordinates":[10.74609,59.91273]},"properties":{"type":{"description":"Type of the GeoJSON Geometry. When filtering there is a limit of specifying up to 100 positions in the data.","type":"string","example":"Point","isRequired":true,"uniqueKey":"\\items.items.[INDEX].item.geoLocation.type","typeLabel":"string"},"coordinates":{"oneOf":[{"type":"array","items":{"type":"number","format":"float","uniqueKey":"\\items.items.[INDEX].item.geoLocation.coordinates.oneOf.0.items.[INDEX]","typeLabel":"number\u003cfloat>"},"description":"Coordinates of the geometry.","example":[10.74609,59.91273],"uniqueKey":"\\items.items.[INDEX].item.geoLocation.coordinates.oneOf.0","typeLabel":"number\u003cfloat>[]"},{"type":"array","items":{"type":"array","items":{"type":"number","format":"float","uniqueKey":"\\items.items.[INDEX].item.geoLocation.coordinates.oneOf.1.items.[INDEX].items.[INDEX]","typeLabel":"number\u003cfloat>"},"uniqueKey":"\\items.items.[INDEX].item.geoLocation.coordinates.oneOf.1.items.[INDEX]","typeLabel":"number\u003cfloat>[]"},"description":"Coordinates of the geometry.","uniqueKey":"\\items.items.[INDEX].item.geoLocation.coordinates.oneOf.1","typeLabel":"number\u003cfloat>[][]"},{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number","format":"float","uniqueKey":"\\items.items.[INDEX].item.geoLocation.coordinates.oneOf.2.items.[INDEX].items.[INDEX].items.[INDEX]","typeLabel":"number\u003cfloat>"},"uniqueKey":"\\items.items.[INDEX].item.geoLocation.coordinates.oneOf.2.items.[INDEX].items.[INDEX]","typeLabel":"number\u003cfloat>[]"},"uniqueKey":"\\items.items.[INDEX].item.geoLocation.coordinates.oneOf.2.items.[INDEX]","typeLabel":"number\u003cfloat>[][]"},"description":"Coordinates of the geometry.","uniqueKey":"\\items.items.[INDEX].item.geoLocation.coordinates.oneOf.2","typeLabel":"number\u003cfloat>[][][]"}],"uniqueKey":"\\items.items.[INDEX].item.geoLocation.coordinates","typeLabel":"number\u003cfloat>[] | number\u003cfloat>[][] | number\u003cfloat>[][][]"},"geometries":{"type":"array","description":"List of geometries for a GeometryCollection. Nested GeometryCollection is not supported","items":{"$circularRef":"af0a78cf-bce7-4c92-8c65-4dbe1df102bf"},"uniqueKey":"\\items.items.[INDEX].item.geoLocation.geometries","typeLabel":"array"}},"uniqueKey":"\\items.items.[INDEX].item.geoLocation","typeLabel":"object"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].item","typeLabel":"object"},"highlight":{"type":"object","description":"Highlighted snippets from name and content fields which show where the query matches are. The matched terms will be placed inside \u003cem> tags","required":["name","content"],"properties":{"name":{"type":"array","description":"Matches in name.","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].highlight.name.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].highlight.name","typeLabel":"string[]"},"content":{"type":"array","description":"Matches in content.","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].highlight.content.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].highlight.content","typeLabel":"string[]"}},"example":{"name":["amet elit \u003cem>non diam\u003c/em> aliquam suscipit"],"content":["Nunc \u003cem>vulputate erat\u003c/em> ipsum, at aliquet ligula vestibulum at","\u003cem>Quisque\u003c/em> lectus ex, fringilla aliquet \u003cem>eleifend\u003c/em> nec, laoreet a velit.\n\nPhasellus \u003cem>faucibus\u003c/em> risus arcu"]},"uniqueKey":"\\items.items.[INDEX].highlight","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"},"nextCursor":{"type":"string","description":"The cursor to get the next page of results (if available). The search endpoint only gives a limited number of results. A missing nextCursor does not imply there are no more results for the provided search.","uniqueKey":"nextCursor","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"items":[{"item":{"id":2384,"createdTime":1519862400000,"sourceFile":{"name":"hamlet.txt","directory":"plays/shakespeare","source":"SubsurfaceConnectors","mimeType":"application/octet-stream","size":1000,"hash":"23203f9264161714cdb8d2f474b9b641e6a735f8cea4098c40a3cab8743bd749","assetIds":[],"labels":[{"externalId":"play"},{"externalId":"tragedy"}],"geoLocation":{"type":"Point","coordinates":[10.74609,59.91273]},"datasetId":4503599627370496,"securityCategories":[],"metadata":{}},"externalId":"haml001","instanceId":{"space":"\u003cstring>","externalId":"\u003cstring>"},"title":"Hamlet","author":"William Shakespeare","producer":"\u003cstring>","modifiedTime":1519958703000,"lastIndexedTime":1521062805000,"mimeType":"text/plain","extension":"pdf","pageCount":2,"type":"Document","language":"en","truncatedContent":"ACT I\nSCENE I. Elsinore. A platform before the castle.\n FRANCISCO at his post. Enter to him BERNARDO\nBERNARDO\n Who's there?\n","assetIds":[42,101],"labels":[{"externalId":"my.known.id"}],"geoLocation":{"type":"Point","coordinates":[10.74609,59.91273]}},"highlight":{"name":["amet elit \u003cem>non diam\u003c/em> aliquam suscipit"],"content":["Nunc \u003cem>vulputate erat\u003c/em> ipsum, at aliquet ligula vestibulum at","\u003cem>Quisque\u003c/em> lectus ex, fringilla aliquet \u003cem>eleifend\u003c/em> nec, laoreet a velit.\n\nPhasellus \u003cem>faucibus\u003c/em> risus arcu"]}}],"nextCursor":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"ca562fb7-dca9-4bf0-b167-4082782f2d0a":{"description":"The response for a failed request.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"description":"Cognite API error.","properties":{"code":{"type":"integer","description":"HTTP status code.","format":"int32","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer\u003cint32>"},"message":{"type":"string","description":"Error message.","example":"Could not authenticate.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"missing":{"type":"array","description":"List of lookup objects that do not match any results.","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.missing.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.missing","typeLabel":"object[]"},"duplicated":{"type":"array","description":"List of objects that are not unique.","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.duplicated.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.duplicated","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":401,"message":"Could not authenticate.","missing":[{}],"duplicated":[{}]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5ed9a804-cdc8-4acd-990a-35c16030ddf0":{"oidc-token":{"type":"http","scheme":"bearer","bearerFormat":"OpenID Connect or OAuth2 token","description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","scopes":["https://{cluster}.cognitedata.com/.default"],"schemeName":"oidc-token"}},"4bb1f079-a3bf-49ad-99ce-c8631276ee89":{"oauth2-client-credentials":{"type":"oauth2","description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","flows":{"clientCredentials":{"tokenUrl":"https://your-idps.token.url/","scopes":{"default":"https://{cluster}.cognitedata.com/.default"}}},"scopes":["https://{cluster}.cognitedata.com/.default"],"schemeName":"oauth2-client-credentials"}},"fa14b4f0-38c1-441b-b444-8693e76e9d56":{"oauth2-open-industrial-data":{"type":"oauth2","description":"Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.","flows":{"clientCredentials":{"tokenUrl":"https://login.microsoftonline.com/48d5043c-cf70-4c49-881c-c638f5796997/oauth2/v2.0/token","scopes":{"default":"https://api.cognitedata.com/.default"}}},"scopes":["https://api.cognitedata.com/.default"],"schemeName":"oauth2-open-industrial-data"}},"4a8349a8-55c0-487f-86ec-cd6ecb3f0725":{"oauth2-auth-code":{"type":"oauth2","description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","flows":{"authorizationCode":{"authorizationUrl":"https://your-idps.authorization.url/","tokenUrl":"https://your-idps.token.url/","scopes":{"default":"https://{cluster}.cognitedata.com/.default"}}},"scopes":["https://{cluster}.cognitedata.com/.default"],"schemeName":"oauth2-auth-code"}}},"servers":{"f24fe7dc-1cd1-47fd-aa89-e7ae89a58c10":{"url":"https://{cluster}.cognitedata.com/api/v1/projects/{project}","description":"The URL for the CDF cluster to connect to","variables":{"cluster":{"enum":["api","az-tyo-gp-001","az-eastus-1","az-power-no-northeurope","westeurope-1","asia-northeast1-1","gc-dsm-gp-001"],"default":"api","description":"The CDF cluster to connect to"},"project":{"default":"publicdata","description":"The CDF project name."}}}},"schemas":{"1464b7c1-f7ca-4a95-b5e5-37c2c2373530":{"oneOf":[{"type":"object","title":"and","description":"A query that matches items matching boolean combinations of other queries.\nIt is built using one or more boolean clauses, which can be of types: `and`, `or` or `not`\n","required":["and"],"properties":{"and":{"description":"All of the sub-clauses in the query must appear in matching items.","type":"array","minItems":1,"items":{"$circularRef":"1464b7c1-f7ca-4a95-b5e5-37c2c2373530"},"example":[{"prefix":{"property":["name"],"value":"Report"}},{"equals":{"property":["type"],"value":"PDF"}}],"isRequired":true}}},{"type":"object","title":"or","description":"A query that matches items matching boolean combinations of other queries.\nIt is built using one or more boolean clauses, which can be of types: `and`, `or` or `not`\n","required":["or"],"properties":{"or":{"description":"At least one of the sub-clauses in the query must appear in matching items.","type":"array","minItems":1,"items":{"$circularRef":"1464b7c1-f7ca-4a95-b5e5-37c2c2373530"},"example":[{"prefix":{"property":["name"],"value":"Report"}},{"prefix":{"property":["name"],"value":"Summary"}}],"isRequired":true}}},{"type":"object","title":"not","description":"A query that matches items matching boolean combinations of other queries.\nIt is built using one or more boolean clauses, which can be of types: `and`, `or` or `not`\n","required":["not"],"properties":{"not":{"type":"object","title":"Filter","description":"Sub-clauses in the query must not appear in matching items.","example":[{"equals":{"property":["type"],"value":"PDF"}}],"isRequired":true}}},{"type":"object","title":"equals","description":"Leaf filter","required":["equals"],"properties":{"equals":{"required":["property","value"],"description":"Matches items that contain the exact value in the provided property.","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string"},"example":["sourceFile","name"],"isRequired":true},"value":{"oneOf":[{"type":"string","description":"Value you wish to find in the provided property.","isRequired":true},{"type":"number","description":"Value you wish to find in the provided property.","isRequired":true},{"type":"boolean","description":"Value you wish to find in the provided property.","isRequired":true},{"type":"object","title":"Label","description":"Value you wish to find in the provided property.","required":["externalId"],"properties":{"externalId":{"type":"string","description":"An external ID to a predefined label definition.","maxLength":255,"example":"my.known.id","isRequired":true}},"isRequired":true},{"type":"object","description":"Value you wish to find in the provided property.","required":["space","externalId"],"properties":{"space":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$","minLength":1,"maxLength":43,"isRequired":true},"externalId":{"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$","minLength":1,"maxLength":255,"isRequired":true}},"isRequired":true}],"isRequired":true}},"example":{"property":["type"],"value":"PDF"},"isRequired":true}}},{"type":"object","title":"in","description":"Leaf filter","required":["in"],"properties":{"in":{"required":["property","values"],"description":"Matches items where the property matches one of the given values","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string"},"example":["sourceFile","name"],"isRequired":true},"values":{"description":"One or more values you wish to find in the provided property.","type":"array","minItems":1,"maxItems":100,"items":{"oneOf":[{"type":"string","description":"Value you wish to find in the provided property."},{"type":"number","description":"Value you wish to find in the provided property."},{"type":"boolean","description":"Value you wish to find in the provided property."},{"type":"object","title":"Label","description":"Value you wish to find in the provided property.","required":["externalId"],"properties":{"externalId":{"type":"string","description":"An external ID to a predefined label definition.","maxLength":255,"example":"my.known.id","isRequired":true}}},{"type":"object","description":"Value you wish to find in the provided property.","required":["space","externalId"],"properties":{"space":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$","minLength":1,"maxLength":43,"isRequired":true},"externalId":{"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$","minLength":1,"maxLength":255,"isRequired":true}}}]},"isRequired":true}},"example":{"property":["author"],"values":["Etiam Eget","Praesent Vestibulum"]},"isRequired":true}}},{"type":"object","title":"containsAny","description":"Leaf filter","required":["containsAny"],"properties":{"containsAny":{"required":["property","values"],"description":"Matches items where the property contains one or more of the given values","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string"},"example":["sourceFile","name"],"isRequired":true},"values":{"description":"One or more values you wish to find in the provided property.","type":"array","minItems":1,"maxItems":100,"items":{"oneOf":[{"type":"string","description":"Value you wish to find in the provided property."},{"type":"number","description":"Value you wish to find in the provided property."},{"type":"boolean","description":"Value you wish to find in the provided property."},{"type":"object","title":"Label","description":"Value you wish to find in the provided property.","required":["externalId"],"properties":{"externalId":{"type":"string","description":"An external ID to a predefined label definition.","maxLength":255,"example":"my.known.id","isRequired":true}}},{"type":"object","description":"Value you wish to find in the provided property.","required":["space","externalId"],"properties":{"space":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$","minLength":1,"maxLength":43,"isRequired":true},"externalId":{"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$","minLength":1,"maxLength":255,"isRequired":true}}}]},"isRequired":true}},"example":{"property":["assetIds"],"values":[51276,94287]},"isRequired":true}}},{"type":"object","title":"containsAll","description":"Leaf filter","required":["containsAll"],"properties":{"containsAll":{"required":["property","values"],"description":"Matches items where the property contains all the given values","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string"},"example":["sourceFile","name"],"isRequired":true},"values":{"description":"One or more values you wish to find in the provided property.","type":"array","minItems":1,"maxItems":100,"items":{"oneOf":[{"type":"string","description":"Value you wish to find in the provided property."},{"type":"number","description":"Value you wish to find in the provided property."},{"type":"boolean","description":"Value you wish to find in the provided property."},{"type":"object","title":"Label","description":"Value you wish to find in the provided property.","required":["externalId"],"properties":{"externalId":{"type":"string","description":"An external ID to a predefined label definition.","maxLength":255,"example":"my.known.id","isRequired":true}}},{"type":"object","description":"Value you wish to find in the provided property.","required":["space","externalId"],"properties":{"space":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$","minLength":1,"maxLength":43,"isRequired":true},"externalId":{"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$","minLength":1,"maxLength":255,"isRequired":true}}}]},"isRequired":true}},"example":{"property":["assetIds"],"values":[51276,94287]},"isRequired":true}}},{"type":"object","title":"range","description":"Leaf filter","required":["range"],"properties":{"range":{"required":["property"],"description":"Matches items that contain terms within the provided range.\nRange must include both an upper and a lower bound. It is not allowed to specify both inclusive and exclusive\nbounds (like `gte`, `gt`) together.\n`gte`: Greater than or equal to.\n`gt`: Greater than.\n`lte`: Less than or equal to.\n`lt`: Less than.\n","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string"},"example":["sourceFile","name"],"isRequired":true},"gte":{"description":"Value you wish to find in the provided property using a range clause.","type":"number"},"gt":{"description":"Value you wish to find in the provided property using a range clause.","type":"number"},"lte":{"description":"Value you wish to find in the provided property using a range clause.","type":"number"},"lt":{"description":"Value you wish to find in the provided property using a range clause.","type":"number"}},"example":{"property":["createdTime"],"gte":1609459200000,"lt":1640995200000},"isRequired":true}}},{"type":"object","title":"prefix","description":"Leaf filter","required":["prefix"],"properties":{"prefix":{"required":["property","value"],"description":"Matches items that contain a specific prefix in the provided property.","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string"},"example":["sourceFile","name"],"isRequired":true},"value":{"oneOf":[{"type":"string","description":"Value you wish to find in the provided property.","isRequired":true},{"type":"number","description":"Value you wish to find in the provided property.","isRequired":true},{"type":"boolean","description":"Value you wish to find in the provided property.","isRequired":true},{"type":"object","title":"Label","description":"Value you wish to find in the provided property.","required":["externalId"],"properties":{"externalId":{"type":"string","description":"An external ID to a predefined label definition.","maxLength":255,"example":"my.known.id","isRequired":true}},"isRequired":true},{"type":"object","description":"Value you wish to find in the provided property.","required":["space","externalId"],"properties":{"space":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$","minLength":1,"maxLength":43,"isRequired":true},"externalId":{"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$","minLength":1,"maxLength":255,"isRequired":true}},"isRequired":true}],"isRequired":true}},"example":{"property":["name"],"value":"Report"},"isRequired":true}}},{"type":"object","title":"search","description":"Leaf filter","required":["search"],"properties":{"search":{"required":["property","value"],"description":"Matches items that contains the search query.","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string"},"example":["sourceFile","name"],"isRequired":true},"value":{"type":"string","isRequired":true}},"example":{"property":["content"],"value":"Report"},"isRequired":true}}},{"type":"object","title":"exists","description":"Leaf filter","required":["exists"],"properties":{"exists":{"required":["property"],"description":"Matches items that contain a value for the provided property.","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string"},"example":["sourceFile","name"],"isRequired":true}},"example":{"property":["language"]},"isRequired":true}}},{"type":"object","title":"geojsonIntersects","description":"Leaf filter","required":["geojsonIntersects"],"properties":{"geojsonIntersects":{"required":["property","geometry"],"description":"Matches items with geolocations that intersect the provided geometry","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string"},"example":["sourceFile","name"],"isRequired":true},"geometry":{"description":"GeoJSON Geometry.","type":"object","required":["type"],"properties":{"type":{"description":"Type of the GeoJSON Geometry. When filtering there is a limit of specifying up to 100 positions in the data.","type":"string","example":"Point","isRequired":true},"coordinates":{"oneOf":[{"type":"array","items":{"type":"number","format":"float"},"description":"Coordinates of the geometry.","example":[10.74609,59.91273]},{"type":"array","items":{"type":"array","items":{"type":"number","format":"float"}},"description":"Coordinates of the geometry."},{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number","format":"float"}}},"description":"Coordinates of the geometry."}]},"geometries":{"type":"array","description":"List of geometries for a GeometryCollection. Nested GeometryCollection is not supported","items":{"$circularRef":"af0a78cf-bce7-4c92-8c65-4dbe1df102bf"}}},"example":{"type":"Point","coordinates":[10.74609,59.91273]},"isRequired":true}},"isRequired":true}}},{"type":"object","title":"geojsonDisjoint","description":"Leaf filter","required":["geojsonDisjoint"],"properties":{"geojsonDisjoint":{"required":["property","geometry"],"description":"Matches items with geolocations that are disjoint from the provided geometry","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string"},"example":["sourceFile","name"],"isRequired":true},"geometry":{"description":"GeoJSON Geometry.","type":"object","required":["type"],"properties":{"type":{"description":"Type of the GeoJSON Geometry. When filtering there is a limit of specifying up to 100 positions in the data.","type":"string","example":"Point","isRequired":true},"coordinates":{"oneOf":[{"type":"array","items":{"type":"number","format":"float"},"description":"Coordinates of the geometry.","example":[10.74609,59.91273]},{"type":"array","items":{"type":"array","items":{"type":"number","format":"float"}},"description":"Coordinates of the geometry."},{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number","format":"float"}}},"description":"Coordinates of the geometry."}]},"geometries":{"type":"array","description":"List of geometries for a GeometryCollection. Nested GeometryCollection is not supported","items":{"$circularRef":"af0a78cf-bce7-4c92-8c65-4dbe1df102bf"}}},"example":{"type":"Point","coordinates":[10.74609,59.91273]},"isRequired":true}},"isRequired":true}}},{"type":"object","title":"geojsonWithin","description":"Leaf filter","required":["geojsonWithin"],"properties":{"geojsonWithin":{"required":["property","geometry"],"description":"Matches items with geolocations that are within the provided geometry","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string"},"example":["sourceFile","name"],"isRequired":true},"geometry":{"description":"GeoJSON Geometry.","type":"object","required":["type"],"properties":{"type":{"description":"Type of the GeoJSON Geometry. When filtering there is a limit of specifying up to 100 positions in the data.","type":"string","example":"Point","isRequired":true},"coordinates":{"oneOf":[{"type":"array","items":{"type":"number","format":"float"},"description":"Coordinates of the geometry.","example":[10.74609,59.91273]},{"type":"array","items":{"type":"array","items":{"type":"number","format":"float"}},"description":"Coordinates of the geometry."},{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number","format":"float"}}},"description":"Coordinates of the geometry."}]},"geometries":{"type":"array","description":"List of geometries for a GeometryCollection. Nested GeometryCollection is not supported","items":{"$circularRef":"af0a78cf-bce7-4c92-8c65-4dbe1df102bf"}}},"example":{"type":"Point","coordinates":[10.74609,59.91273]},"isRequired":true}},"isRequired":true}}},{"type":"object","title":"inAssetSubtree","description":"Leaf filter","required":["inAssetSubtree"],"properties":{"inAssetSubtree":{"required":["property","values"],"description":"Matches items where the property contains one or more assets in a subtree rooted at any of the given values","type":"object","properties":{"property":{"description":"Property you wish to filter. It's a list of strings to allow specifying nested properties.\nFor example, If you have the object `{\"foo\": {\"../bar\": \"baz\"}, \"bar\": 123}`, you can refer to the nested property as `[\"foo\", \"../bar\"]` and the un-nested one as `[\"bar\"]`.\n","type":"array","minItems":1,"maxItems":3,"items":{"type":"string"},"example":["sourceFile","name"],"isRequired":true},"values":{"description":"One or more values you wish to find in the provided property.","type":"array","minItems":1,"maxItems":100,"items":{"oneOf":[{"type":"string","description":"Value you wish to find in the provided property."},{"type":"number","description":"Value you wish to find in the provided property."},{"type":"boolean","description":"Value you wish to find in the provided property."},{"type":"object","title":"Label","description":"Value you wish to find in the provided property.","required":["externalId"],"properties":{"externalId":{"type":"string","description":"An external ID to a predefined label definition.","maxLength":255,"example":"my.known.id","isRequired":true}}},{"type":"object","description":"Value you wish to find in the provided property.","required":["space","externalId"],"properties":{"space":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$","minLength":1,"maxLength":43,"isRequired":true},"externalId":{"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$","minLength":1,"maxLength":255,"isRequired":true}}}]},"isRequired":true}},"example":{"property":["assetIds"],"values":[51276,94287]},"isRequired":true}}}]},"af0a78cf-bce7-4c92-8c65-4dbe1df102bf":{"description":"GeoJSON Geometry.","type":"object","required":["type"],"properties":{"type":{"description":"Type of the GeoJSON Geometry. When filtering there is a limit of specifying up to 100 positions in the data.","type":"string","example":"Point","isRequired":true},"coordinates":{"oneOf":[{"type":"array","items":{"type":"number","format":"float"},"description":"Coordinates of the geometry.","example":[10.74609,59.91273]},{"type":"array","items":{"type":"array","items":{"type":"number","format":"float"}},"description":"Coordinates of the geometry."},{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number","format":"float"}}},"description":"Coordinates of the geometry."}]},"geometries":{"type":"array","description":"List of geometries for a GeometryCollection. Nested GeometryCollection is not supported","items":{"$circularRef":"af0a78cf-bce7-4c92-8c65-4dbe1df102bf"}}},"example":{"type":"Point","coordinates":[10.74609,59.91273]}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"OpenID Connect or OAuth2 token","description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","scopes":["https://{cluster}.cognitedata.com/.default"],"schemeName":"oidc-token"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oidc-token","name":"Authorization"}],"title":"oidc-token"},{"schemes":[{"scheme":{"type":"oauth2","description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","flows":{"clientCredentials":{"tokenUrl":"https://your-idps.token.url/","scopes":{"default":"https://{cluster}.cognitedata.com/.default"}}},"scopes":["https://{cluster}.cognitedata.com/.default"],"schemeName":"oauth2-client-credentials"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2-client-credentials","name":"Authorization"}],"title":"oauth2-client-credentials"},{"schemes":[{"scheme":{"type":"oauth2","description":"Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.","flows":{"clientCredentials":{"tokenUrl":"https://login.microsoftonline.com/48d5043c-cf70-4c49-881c-c638f5796997/oauth2/v2.0/token","scopes":{"default":"https://api.cognitedata.com/.default"}}},"scopes":["https://api.cognitedata.com/.default"],"schemeName":"oauth2-open-industrial-data"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2-open-industrial-data","name":"Authorization"}],"title":"oauth2-open-industrial-data"},{"schemes":[{"scheme":{"type":"oauth2","description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","flows":{"authorizationCode":{"authorizationUrl":"https://your-idps.authorization.url/","tokenUrl":"https://your-idps.token.url/","scopes":{"default":"https://{cluster}.cognitedata.com/.default"}}},"scopes":["https://{cluster}.cognitedata.com/.default"],"schemeName":"oauth2-auth-code"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2-auth-code","name":"Authorization"}],"title":"oauth2-auth-code"}]},"originalFileLocation":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json"},"subdomain":"cognite","siteName":"Cognite Docs","title":"Search for documents - Cognite Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/20230101/documents/search-for-documents","matchLevel":0},"de":{"href":"/de","matchLevel":4},"es":{"href":"/es","matchLevel":4},"fr":{"href":"/fr","matchLevel":4},"ko":{"href":"/ko","matchLevel":4},"it":{"href":"/it","matchLevel":4},"lv":{"href":"/lv","matchLevel":4},"nl":{"href":"/nl","matchLevel":4},"ja":{"href":"/ja","matchLevel":4},"no":{"href":"/no","matchLevel":4},"pt":{"href":"/pt","matchLevel":4},"ro":{"href":"/ro","matchLevel":4},"sv":{"href":"/sv","matchLevel":4},"zh":{"href":"/zh","matchLevel":4}}},"originalFileLocation":"20230101/documents/search-for-documents.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Searches document text and properties. Requires filesAcl:READ. See Document search.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cognite Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Search for documents - Cognite Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Searches document text and properties. Requires filesAcl:READ. See Document search.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cognite Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cognite.com/20230101/documents/search-for-documents\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cognite.mintlify.site/_mintlify/api/og/v2?division=Documents\u0026amp;title=Search+for+documents\u0026amp;description=Searches+document+text+and+properties.+Requires+%60filesAcl%3AREAD%60.+See+%5BDocument+search%5D%28%2Fapi-reference%2Fconcepts%2F20230101%2Fsearch%29.\u0026amp;theme=9da546f85ddd355458e0d0e4\u0026amp;signature=4be63212f7a39ec9428a1f08c2600541978b1a1cabf06892029a31607c5530f0\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Search for documents - Cognite Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Searches document text and properties. Requires filesAcl:READ. See Document search.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cognite.mintlify.site/_mintlify/api/og/v2?division=Documents\u0026amp;title=Search+for+documents\u0026amp;description=Searches+document+text+and+properties.+Requires+%60filesAcl%3AREAD%60.+See+%5BDocument+search%5D%28%2Fapi-reference%2Fconcepts%2F20230101%2Fsearch%29.\u0026amp;theme=9da546f85ddd355458e0d0e4\u0026amp;signature=4be63212f7a39ec9428a1f08c2600541978b1a1cabf06892029a31607c5530f0\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cognite Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3C5FFB\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"kX2vFxX0NcdV88MV5ooALR09TbeSd8xDN-rVd6fiTG4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cognite.com/20230101/documents/search-for-documents\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/20230101/documents/search-for-documents.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cognite.com/#organization\",\"name\":\"Cognite Docs\",\"url\":\"https://docs.cognite.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cognite/dkctM57aym6D8Toa/_images/logo/cognite-docs-black.svg?fit=max\u0026auto=format\u0026n=dkctM57aym6D8Toa\u0026q=85\u0026s=38c50e5be94d9baf1ff1c794ae17d6ea\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cognite.com#website\",\"name\":\"Cognite Docs\",\"url\":\"https://docs.cognite.com\",\"publisher\":{\"@id\":\"https://docs.cognite.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cognite.com/20230101/documents/search-for-documents#webpage\",\"url\":\"https://docs.cognite.com/20230101/documents/search-for-documents\",\"name\":\"Search for documents\",\"description\":\"Searches document text and properties. Requires filesAcl:READ. See Document search.\",\"isPartOf\":{\"@id\":\"https://docs.cognite.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cognite.com/20230101/documents/search-for-documents#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cognite.com/20230101/documents/search-for-documents#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference (20230101)\",\"item\":\"https://docs.cognite.com/api-reference/concepts/20230101/api-description\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documents\",\"item\":\"https://docs.cognite.com/api-reference/concepts/20230101/documents-overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Documents\",\"item\":\"https://docs.cognite.com/api-reference/concepts/20230101/documents-overview\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Documents\",\"item\":\"https://docs.cognite.com/api-reference/concepts/20230101/documents\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Search for documents\",\"item\":\"https://docs.cognite.com/20230101/documents/search-for-documents\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cognite.com/20230101/documents/search-for-documents#apireference\",\"headline\":\"Search for documents\",\"name\":\"Search for documents\",\"description\":\"Searches document text and properties. Requires filesAcl:READ. See Document search.\",\"url\":\"https://docs.cognite.com/20230101/documents/search-for-documents\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cognite.com/20230101/documents/search-for-documents#webpage\"},\"publisher\":{\"@id\":\"https://docs.cognite.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cognite.com#website\"}}]}\u003c/script>","agentPointerHref":"/20230101/documents/search-for-documents.md","siteName":"Cognite Docs","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":""}]},{"tab":"Flows","pages":[{"title":"Flows","href":"/cdf/flows_workspace"}]},{"tab":"Data engineering","pages":[{"title":"Data engineering","href":"/cdf/data_engineering"}]},{"tab":"Build","pages":[{"title":"Build","href":"/cdf/build"}]},{"tab":"Admin","pages":[{"title":"Admin","href":"/cdf/admin"}]},{"tab":"Deploy","pages":[{"title":"Deploy","href":"/cdf/deploy"}]},{"tab":"Develop","pages":[{"title":"Develop","href":"/dev"}]},{"tab":"API reference","menu":[{"item":"Stable (20230101)","description":"Production version (stable)","groups":[{"group":"API reference (20230101)","pages":[{"group":"Foundation","icon":"building-2","expanded":true,"pages":[{"group":"Introduction","icon":"book","expanded":true,"pages":[{"title":"Cognite API introduction","sidebarTitle":"Introduction","href":"/api-reference/concepts/20230101/api-description"},{"title":"API rate limits","sidebarTitle":"Rate limits","href":"/api-reference/concepts/20230101/rate-limits"},{"title":"Cognite API changelog","sidebarTitle":"Changelog","href":"/api-reference/changelog"}]},{"group":"Organizations and projects","pages":[{"title":"Organizations and projects","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/organizations-and-projects"},{"group":"Organizations","pages":[{"title":"Organizations","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/organizations"},{"title":"Create an organization","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /api/v1/orgs/{org}/orgs","href":"/20230101/organizations/create-an-organization"},{"title":"Delete an organization","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /api/v1/orgs/{org}/delete","href":"/20230101/organizations/delete-an-organization"},{"title":"List child organizations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /api/v1/orgs/{org}/orgs","href":"/20230101/organizations/list-child-organizations"},{"title":"Retrieve an organization","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /api/v1/orgs/{org}","href":"/20230101/organizations/retrieve-an-organization"}]},{"group":"Projects","pages":[{"title":"Projects","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/projects"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /api/v1/orgs/{org}/projects","href":"/20230101/projects/create-a-project"},{"title":"List projects in an organization","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /api/v1/orgs/{org}/projects","href":"/20230101/projects/list-projects-in-an-organization"}]}]},{"group":"Identity and access management","pages":[{"title":"Identity and access management","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/identity-and-access-management"},{"group":"Principals","pages":[{"title":"Principals","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/principals"},{"title":"Get the current caller's information","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /api/v1/principals/me","href":"/20230101/principals/get-the-current-callers-information"},{"title":"List login sessions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /api/v1/orgs/{org}/principals/{principal}/sessions","href":"/20230101/principals/list-login-sessions"},{"title":"List principals","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /api/v1/orgs/{org}/principals","href":"/20230101/principals/list-principals"},{"title":"Retrieve principals by reference","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /api/v1/orgs/{org}/principals/byids","href":"/20230101/principals/retrieve-principals-by-reference"},{"title":"Revoke login sessions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /api/v1/orgs/{org}/principals/{principal}/sessions/revoke","href":"/20230101/principals/revoke-login-sessions"}]},{"group":"Groups","pages":[{"title":"Groups","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/groups"},{"title":"Create groups","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /groups","href":"/20230101/groups/create-groups"},{"title":"Delete groups","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /groups/delete","href":"/20230101/groups/delete-groups"},{"title":"List groups","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /groups","href":"/20230101/groups/list-groups"}]},{"group":"Security categories","pages":[{"title":"Security categories","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/security-categories"},{"title":"Create security categories","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /securitycategories","href":"/20230101/security-categories/create-security-categories"},{"title":"Delete security categories","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /securitycategories/delete","href":"/20230101/security-categories/delete-security-categories"},{"title":"List security categories","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /securitycategories","href":"/20230101/security-categories/list-security-categories"}]},{"group":"Sessions","pages":[{"title":"Sessions","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/sessions"},{"title":"Create sessions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sessions","href":"/20230101/sessions/create-sessions"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /sessions","href":"/20230101/sessions/list-sessions"},{"title":"Retrieve sessions with given IDs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sessions/byids","href":"/20230101/sessions/retrieve-sessions-with-given-ids"},{"title":"Revoke sessions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sessions/revoke","href":"/20230101/sessions/revoke-sessions"}]},{"group":"Token","pages":[{"title":"Tokens","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/tokens"},{"title":"Inspect","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /token/inspect","href":"/20230101/token/inspect"}]},{"group":"User profiles","tag":"deprecated","pages":[{"title":"User profiles","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/user-profiles"},{"title":"(deprecated) Get the user profile of the principal issuing the request","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /profiles/me","href":"/20230101/user-profiles/deprecated-get-the-user-profile-of-the-principal-issuing-the-request"},{"title":"Get the user profile of the principal issuing the request","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /principals/me","href":"/20230101/user-profiles/get-the-user-profile-of-the-principal-issuing-the-request"},{"title":"List all user profiles in the current project","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /profiles","href":"/20230101/user-profiles/list-all-user-profiles-in-the-current-project"},{"title":"Retrieve profiles by ID in the current project","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /profiles/byids","href":"/20230101/user-profiles/retrieve-profiles-by-id-in-the-current-project"},{"title":"Search user profiles in the current project","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /profiles/search","href":"/20230101/user-profiles/search-user-profiles-in-the-current-project"}]}]}]},{"group":"Core data","icon":"database","expanded":true,"pages":[{"group":"Data modeling","pages":[{"title":"Data modeling with the industrial knowledge graph","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/data-modeling"},{"group":"Data models","pages":[{"title":"Data models","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/data-models"},{"title":"Create or update data models","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/datamodels","href":"/20230101/data-models/create-or-update-data-models"},{"title":"Delete data models","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/datamodels/delete","href":"/20230101/data-models/delete-data-models"},{"title":"List data models defined in the project","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /models/datamodels","href":"/20230101/data-models/list-data-models-defined-in-the-project"},{"title":"Retrieve data models by their external ids","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/datamodels/byids","href":"/20230101/data-models/retrieve-data-models-by-their-external-ids"}]},{"group":"Spaces","pages":[{"title":"Spaces","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/spaces"},{"title":"Create or update spaces","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/spaces","href":"/20230101/spaces/create-or-update-spaces"},{"title":"Delete spaces","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/spaces/delete","href":"/20230101/spaces/delete-spaces"},{"title":"List spaces defined in the project","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /models/spaces","href":"/20230101/spaces/list-spaces-defined-in-the-project"},{"title":"Retrieve spaces by their space-ids","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/spaces/byids","href":"/20230101/spaces/retrieve-spaces-by-their-space-ids"}]},{"group":"Views","pages":[{"title":"Views","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/views"},{"title":"Create or update views","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/views","href":"/20230101/views/create-or-update-views"},{"title":"Delete views","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/views/delete","href":"/20230101/views/delete-views"},{"title":"List views defined in the project","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /models/views","href":"/20230101/views/list-views-defined-in-the-project"},{"title":"Retrieve views by their external ids","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/views/byids","href":"/20230101/views/retrieve-views-by-their-external-ids"}]},{"group":"Containers","pages":[{"title":"Containers","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/containers"},{"title":"Create or update containers","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/containers","href":"/20230101/containers/create-or-update-containers"},{"title":"Delete containers","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/containers/delete","href":"/20230101/containers/delete-containers"},{"title":"Delete indexes from containers","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/containers/indexes/delete","href":"/20230101/containers/delete-indexes-from-containers"},{"title":"Delete constraints from containers","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/containers/constraints/delete","href":"/20230101/containers/delete-constraints-from-containers"},{"title":"Inspect containers","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/containers/inspect","href":"/20230101/containers/inspect-containers"},{"title":"List containers defined in the project","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /models/containers","href":"/20230101/containers/list-containers-defined-in-the-project"},{"title":"Retrieve containers by their external ids","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/containers/byids","href":"/20230101/containers/retrieve-containers-by-their-external-ids"},{"title":"Retry failed container constraints","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/containers/constraints/retry","href":"/20230101/containers/retry-failed-container-constraints"},{"title":"Retry failed indexes","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/containers/indexes/retry","href":"/20230101/containers/retry-failed-indexes"},{"title":"Retry failed property constraints","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/containers/properties/retry","href":"/20230101/containers/retry-failed-property-constraints"}]},{"group":"Instances","pages":[{"title":"Instances","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/instances"},{"title":"Aggregate data across nodes/edges","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/instances/aggregate","href":"/20230101/instances/aggregate-data-across-nodesedges"},{"title":"Create or update nodes/edges","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/instances","href":"/20230101/instances/create-or-update-nodesedges"},{"title":"Delete nodes/edges","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/instances/delete","href":"/20230101/instances/delete-nodesedges"},{"title":"Filter nodes/edges","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/instances/list","href":"/20230101/instances/filter-nodesedges"},{"title":"Inspect instances","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/instances/inspect","href":"/20230101/instances/inspect-instances"},{"title":"Query nodes/edges","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/instances/query","href":"/20230101/instances/query-nodesedges"},{"title":"Retrieve nodes/edges by their external ids","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/instances/byids","href":"/20230101/instances/retrieve-nodesedges-by-their-external-ids"},{"title":"Search for nodes/edges","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/instances/search","href":"/20230101/instances/search-for-nodesedges"},{"title":"Sync nodes/edges","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/instances/sync","href":"/20230101/instances/sync-nodesedges"}]},{"group":"Statistics","pages":[{"title":"Statistics","sidebarTitle":"Statistics","href":"/api-reference/concepts/20230101/dm-statistics"},{"title":"Retrieve project-wide statistics and limits","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /models/statistics","href":"/20230101/statistics/retrieve-project-wide-statistics-and-limits"},{"title":"Retrieve statistics by space","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /models/statistics/spaces","href":"/20230101/statistics/retrieve-statistics-by-space"},{"title":"Retrieve statistics by space for specific space-ids","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/statistics/spaces/byids","href":"/20230101/statistics/retrieve-statistics-by-space-for-specific-space-ids"}]},{"group":"Streams","pages":[{"title":"Streams","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/streams"},{"title":"Create stream","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /streams","href":"/20230101/streams/create-stream"},{"title":"Delete stream","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /streams/delete","href":"/20230101/streams/delete-stream"},{"title":"List streams","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /streams","href":"/20230101/streams/list-streams"},{"title":"Retrieve stream","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /streams/{streamId}","href":"/20230101/streams/retrieve-stream"}]},{"group":"Records","pages":[{"title":"Records","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/records"},{"title":"Aggregate records data from a stream","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /streams/{streamId}/records/aggregate","href":"/20230101/records/aggregate-records-data-from-a-stream"},{"title":"Delete records from a stream","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /streams/{streamId}/records/delete","href":"/20230101/records/delete-records-from-a-stream"},{"title":"Ingest records into a stream","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /streams/{streamId}/records","href":"/20230101/records/ingest-records-into-a-stream"},{"title":"Retrieve records from a stream","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /streams/{streamId}/records/filter","href":"/20230101/records/retrieve-records-from-a-stream"},{"title":"Sync records from a stream","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /streams/{streamId}/records/sync","href":"/20230101/records/sync-records-from-a-stream"},{"title":"Upsert (create or update) records into a stream","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /streams/{streamId}/records/upsert","href":"/20230101/records/upsert-create-or-update-records-into-a-stream"}]}]},{"group":"Time series and datapoints","pages":[{"title":"Time series and datapoints","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/time-series-data"},{"group":"Datapoints","pages":[{"title":"Datapoints","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/datapoints"},{"title":"Insert data points","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/data","href":"/20230101/time-series/insert-data-points"},{"title":"Retrieve data points","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/data/list","href":"/20230101/time-series/retrieve-data-points"},{"title":"Retrieve latest data point","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/data/latest","href":"/20230101/time-series/retrieve-latest-data-point"},{"title":"Delete data points","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/data/delete","href":"/20230101/time-series/delete-data-points"}]},{"group":"Synthetic time series","pages":[{"title":"Synthetic time series","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/synthetic-time-series"},{"title":"Synthetic query","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/synthetic/query","href":"/20230101/synthetic-time-series/synthetic-query"}]},{"group":"Data point subscriptions","pages":[{"title":"Data point subscriptions","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/data-point-subscriptions"},{"title":"Create subscriptions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/subscriptions","href":"/20230101/data-point-subscriptions/create-subscriptions"},{"title":"Delete subscriptions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/subscriptions/delete","href":"/20230101/data-point-subscriptions/delete-subscriptions"},{"title":"List subscription data","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/subscriptions/data/list","href":"/20230101/data-point-subscriptions/list-subscription-data"},{"title":"List subscription members","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /timeseries/subscriptions/members","href":"/20230101/data-point-subscriptions/list-subscription-members"},{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /timeseries/subscriptions","href":"/20230101/data-point-subscriptions/list-subscriptions"},{"title":"Retrieve subscriptions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/subscriptions/byids","href":"/20230101/data-point-subscriptions/retrieve-subscriptions"},{"title":"Update subscriptions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/subscriptions/update","href":"/20230101/data-point-subscriptions/update-subscriptions"}]}]},{"group":"File content","pages":[{"title":"File content","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/file-content"},{"title":"Get upload file link","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/uploadlink","href":"/20230101/files/get-upload-file-link"},{"title":"Download files","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/downloadlink","href":"/20230101/files/download-files"},{"title":"Upload multipart file","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/initmultipartupload","href":"/20230101/files/upload-multipart-file"},{"title":"Get multipart file upload link","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/multiuploadlink","href":"/20230101/files/get-multipart-file-upload-link"},{"title":"Complete multipart upload","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/completemultipartupload","href":"/20230101/files/complete-multipart-upload"},{"title":"Get icon","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /files/icon","href":"/20230101/files/get-icon"}]},{"group":"3D","pages":[{"title":"3D","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/3d"},{"group":"3D models","pages":[{"title":"3D Models","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/3d-models"},{"title":"List 3D models","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /3d/models","href":"/20230101/3d-models/list-3d-models"},{"title":"Create 3D models","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/models","href":"/20230101/3d-models/create-3d-models"},{"title":"Update 3D models","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/models/update","href":"/20230101/3d-models/update-3d-models"},{"title":"Delete 3D models","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/models/delete","href":"/20230101/3d-models/delete-3d-models"},{"title":"Retrieve a 3D model","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /3d/models/{modelId}","href":"/20230101/3d-models/retrieve-a-3d-model"}]},{"group":"3D model revisions","pages":[{"title":"3D Model Revisions","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/3d-model-revisions"},{"title":"List 3D revisions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /3d/models/{modelId}/revisions","href":"/20230101/3d-model-revisions/list-3d-revisions"},{"title":"Create 3D revisions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/models/{modelId}/revisions","href":"/20230101/3d-model-revisions/create-3d-revisions"},{"title":"Update 3D revisions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/models/{modelId}/revisions/update","href":"/20230101/3d-model-revisions/update-3d-revisions"},{"title":"Delete 3D revisions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/models/{modelId}/revisions/delete","href":"/20230101/3d-model-revisions/delete-3d-revisions"},{"title":"Retrieve a 3D revision","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /3d/models/{modelId}/revisions/{revisionId}","href":"/20230101/3d-model-revisions/retrieve-a-3d-revision"},{"title":"List 3D revision logs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /3d/models/{modelId}/revisions/{revisionId}/logs","href":"/20230101/3d-model-revisions/list-3d-revision-logs"},{"title":"Update 3D revision thumbnail","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/models/{modelId}/revisions/{revisionId}/thumbnail","href":"/20230101/3d-model-revisions/update-3d-revision-thumbnail"},{"title":"List available outputs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /3d/models/{modelId}/revisions/{revisionId}/outputs","href":"/20230101/3d-model-revisions/list-available-outputs"},{"title":"List 3D nodes","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /3d/models/{modelId}/revisions/{revisionId}/nodes","href":"/20230101/3d-model-revisions/list-3d-nodes"},{"title":"Filter 3D nodes","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/models/{modelId}/revisions/{revisionId}/nodes/list","href":"/20230101/3d-model-revisions/filter-3d-nodes"},{"title":"Get 3D nodes by ID","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/models/{modelId}/revisions/{revisionId}/nodes/byids","href":"/20230101/3d-model-revisions/get-3d-nodes-by-id"},{"title":"List 3D ancestor nodes","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}/ancestors","href":"/20230101/3d-model-revisions/list-3d-ancestor-nodes"}]},{"group":"3D files","pages":[{"title":"3D Files","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/3d-files"},{"title":"Retrieve a single 3D file","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /3d/files/{threedFileId}","href":"/20230101/3d-files/retrieve-a-single-3d-file"},{"title":"Retrieve a 3D directory file","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /3d/files/{threedFileId}/{subPath}","href":"/20230101/3d-files/retrieve-a-3d-directory-file"}]},{"group":"3D asset mapping","pages":[{"title":"3D Asset Mapping","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/3d-asset-mapping"},{"title":"List 3D asset mappings","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /3d/models/{modelId}/revisions/{revisionId}/mappings","href":"/20230101/3d-asset-mapping/list-3d-asset-mappings"},{"title":"Create 3D asset mappings","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/models/{modelId}/revisions/{revisionId}/mappings","href":"/20230101/3d-asset-mapping/create-3d-asset-mappings"},{"title":"Delete 3D asset mappings","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/models/{modelId}/revisions/{revisionId}/mappings/delete","href":"/20230101/3d-asset-mapping/delete-3d-asset-mappings"},{"title":"Filter 3D asset mappings","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/models/{modelId}/revisions/{revisionId}/mappings/list","href":"/20230101/3d-asset-mapping/filter-3d-asset-mappings"},{"title":"Filter which nodes are within a boundingbox for a revision.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/nodes/list","href":"/20230101/3d-asset-mapping/filter-which-nodes-are-within-a-boundingbox-for-a-revision"},{"title":"List mappings for one assetID across all 3D models","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /3d/mappings/{assetId}/modelnodes","href":"/20230101/3d-asset-mapping/list-mappings-for-one-assetid-across-all-3d-models"}]},{"group":"3D jobs","pages":[{"title":"3D Jobs","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/3d-jobs"},{"title":"Create a job using 3D source data","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/jobs","href":"/20230101/3d-jobs/create-a-job-using-3d-source-data"},{"title":"List jobs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/jobs/list","href":"/20230101/3d-jobs/list-jobs"},{"title":"Delete jobs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/jobs/delete","href":"/20230101/3d-jobs/delete-jobs"},{"title":"List Job Results","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/job/results/list","href":"/20230101/3d-jobs/list-job-results"},{"title":"Update Job Result Rejections","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/job/result/rejections","href":"/20230101/3d-jobs/update-job-result-rejections"},{"title":"List Job Result Rejections","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /3d/job/result/rejections/list","href":"/20230101/3d-jobs/list-job-result-rejections"}]}]}]},{"group":"Cognite AI","icon":"bot","expanded":true,"pages":[{"title":"Cognite AI","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/cognite-ai"},{"group":"Document AI","pages":[{"title":"Document AI","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/document-ai"},{"title":"Ask questions about one or more documents.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /ai/tools/documents/ask","href":"/20230101/document-ai/ask-questions-about-one-or-more-documents"},{"title":"Summarize documents.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /ai/tools/documents/summarize","href":"/20230101/document-ai/summarize-documents"}]}]},{"group":"Compute and automation","icon":"cpu","expanded":true,"pages":[{"group":"Functions","pages":[{"title":"Functions","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/functions-overview"},{"group":"Functions","pages":[{"title":"Functions","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/functions"},{"title":"Activate Functions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/status","href":"/20230101/functions/activate-functions"},{"title":"Get activation status","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /functions/status","href":"/20230101/functions/get-activation-status"},{"title":"Create functions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions","href":"/20230101/functions/create-functions"},{"title":"Delete functions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/delete","href":"/20230101/functions/delete-functions"},{"title":"Filter functions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/list","href":"/20230101/functions/filter-functions"},{"title":"Functions limits","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /functions/limits","href":"/20230101/functions/functions-limits"},{"title":"List functions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /functions","href":"/20230101/functions/list-functions"},{"title":"Retrieve a function by its id","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /functions/{functionId}","href":"/20230101/functions/retrieve-a-function-by-its-id"},{"title":"Retrieve functions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/byids","href":"/20230101/functions/retrieve-functions"}]},{"group":"Function calls","pages":[{"title":"Function calls","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/function-calls"},{"title":"Call a function asynchronously","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/{functionId}/call","href":"/20230101/function-calls/call-a-function-asynchronously"},{"title":"Filter function calls","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/{functionId}/calls/list","href":"/20230101/function-calls/filter-function-calls"},{"title":"List function calls","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /functions/{functionId}/calls","href":"/20230101/function-calls/list-function-calls"},{"title":"Retrieve calls","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/{functionId}/calls/byids","href":"/20230101/function-calls/retrieve-calls"},{"title":"Retrieve a function call by its id","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /functions/{functionId}/calls/{callId}","href":"/20230101/function-calls/retrieve-a-function-call-by-its-id"},{"title":"Retrieve logs for function call","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /functions/{functionId}/calls/{callId}/logs","href":"/20230101/function-calls/retrieve-logs-for-function-call"},{"title":"Retrieve response for function call","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /functions/{functionId}/calls/{callId}/response","href":"/20230101/function-calls/retrieve-response-for-function-call"}]},{"group":"Function schedules","pages":[{"title":"Function schedules","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/function-schedules"},{"title":"Create schedules","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/schedules","href":"/20230101/function-schedules/create-schedules"},{"title":"Delete schedules","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/schedules/delete","href":"/20230101/function-schedules/delete-schedules"},{"title":"Filter function schedules","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/schedules/list","href":"/20230101/function-schedules/filter-function-schedules"},{"title":"List schedules","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /functions/schedules","href":"/20230101/function-schedules/list-schedules"},{"title":"Retrieve a function schedule by its id","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /functions/schedules/{scheduleId}","href":"/20230101/function-schedules/retrieve-a-function-schedule-by-its-id"},{"title":"Retrieve schedules","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/schedules/byids","href":"/20230101/function-schedules/retrieve-schedules"},{"title":"Retrieve function input data","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /functions/schedules/{scheduleId}/input_data","href":"/20230101/function-schedules/retrieve-function-input-data"}]}]}]},{"group":"Connectors","icon":"plug","expanded":true,"pages":[{"group":"PostgreSQL gateway","pages":[{"title":"PostgreSQL gateway","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/postgresql-gateway"},{"group":"Postgres gateway users","pages":[{"title":"Postgres Gateway Users","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/postgres-gateway-users"},{"title":"Create users","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /postgresgateway","href":"/20230101/postgres-gateway-users/create-users"},{"title":"Filter users","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /postgresgateway/list","href":"/20230101/postgres-gateway-users/filter-users"},{"title":"Retrieve users","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /postgresgateway/byids","href":"/20230101/postgres-gateway-users/retrieve-users"},{"title":"Update users","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /postgresgateway/update","href":"/20230101/postgres-gateway-users/update-users"},{"title":"Delete users","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /postgresgateway/delete","href":"/20230101/postgres-gateway-users/delete-users"},{"title":"List users","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /postgresgateway","href":"/20230101/postgres-gateway-users/list-users"}]},{"group":"Postgres gateway tables","pages":[{"title":"Postgres Gateway Tables","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/postgres-gateway-tables"},{"title":"Create tables","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /postgresgateway/tables/{username}","href":"/20230101/postgres-gateway-tables/create-tables"},{"title":"List tables","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /postgresgateway/tables/{username}","href":"/20230101/postgres-gateway-tables/list-tables"},{"title":"Retrieve tables","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /postgresgateway/tables/{username}/byids","href":"/20230101/postgres-gateway-tables/retrieve-tables"},{"title":"Delete tables","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /postgresgateway/tables/{username}/delete","href":"/20230101/postgres-gateway-tables/delete-tables"}]}]},{"group":"SAP writeback","pages":[{"title":"SAP writeback","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/sap-writeback"},{"group":"SAP instances","pages":[{"title":"SAP Instances","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/sap-instances"},{"title":"Create SAP Instances","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /writeback/sap/instances","href":"/20230101/sap-instances/create-sap-instances"},{"title":"Retrieve SAP Instances","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /writeback/sap/instances/byids","href":"/20230101/sap-instances/retrieve-sap-instances"},{"title":"Delete SAP Instances","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /writeback/sap/instances/delete","href":"/20230101/sap-instances/delete-sap-instances"}]},{"group":"SAP endpoints","pages":[{"title":"SAP Endpoints","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/sap-endpoints"},{"title":"Create SAP Endpoints","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /writeback/sap/endpoints","href":"/20230101/sap-endpoints/create-sap-endpoints"},{"title":"Retrieve SAP Endpoints","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /writeback/sap/endpoints/byids","href":"/20230101/sap-endpoints/retrieve-sap-endpoints"},{"title":"Delete SAP Endpoints","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /writeback/sap/endpoints/delete","href":"/20230101/sap-endpoints/delete-sap-endpoints"},{"title":"Verify SAP Endpoint","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /writeback/sap/endpoints/verify","href":"/20230101/sap-endpoints/verify-sap-endpoint"}]},{"group":"Schema mappings","pages":[{"title":"Schema Mappings","sidebarTitle":"Schema Mappings","href":"/api-reference/concepts/20230101/sap-schema-mappings"},{"title":"Create Mappings","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /writeback/sap/mappings","href":"/20230101/schema-mappings/create-mappings"},{"title":"Retrieve Mappings","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /writeback/sap/mappings/byids","href":"/20230101/schema-mappings/retrieve-mappings"},{"title":"Delete Mappings","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /writeback/sap/mappings/delete","href":"/20230101/schema-mappings/delete-mappings"}]},{"group":"Writeback requests","pages":[{"title":"Writeback Requests","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/writeback-requests"},{"title":"Create Writeback Requests","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /writeback/sap/requests","href":"/20230101/writeback-requests/create-writeback-requests"},{"title":"Retrieve Writeback Requests","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /writeback/sap/requests/byids","href":"/20230101/writeback-requests/retrieve-writeback-requests"}]}]}]},{"group":"Contextualization","icon":"puzzle","expanded":true,"pages":[{"title":"Contextualization","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/contextualization"},{"group":"Entity matching","pages":[{"title":"Entity matching","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/entity-matching"},{"title":"Create entity matcher model","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /context/entitymatching","href":"/20230101/entity-matching/create-entity-matcher-model"},{"title":"Delete entity matcher model","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /context/entitymatching/delete","href":"/20230101/entity-matching/delete-entity-matcher-model"},{"title":"Filter models","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /context/entitymatching/list","href":"/20230101/entity-matching/filter-models"},{"title":"List entity matching models","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /context/entitymatching","href":"/20230101/entity-matching/list-entity-matching-models"},{"title":"Retrieve an entity matching model by the ID of the model","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /context/entitymatching/{id}","href":"/20230101/entity-matching/retrieve-an-entity-matching-model-by-the-id-of-the-model"},{"title":"Predict matches","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /context/entitymatching/predict","href":"/20230101/entity-matching/predict-matches"},{"title":"Re-fit entity matcher model","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /context/entitymatching/refit","href":"/20230101/entity-matching/re-fit-entity-matcher-model"},{"title":"Retrieve entity matcher predict results","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /context/entitymatching/jobs/{jobId}","href":"/20230101/entity-matching/retrieve-entity-matcher-predict-results"},{"title":"Retrieve entity matching models","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /context/entitymatching/byids","href":"/20230101/entity-matching/retrieve-entity-matching-models"},{"title":"Update entity matching models","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /context/entitymatching/update","href":"/20230101/entity-matching/update-entity-matching-models"}]},{"group":"Engineering diagrams","pages":[{"title":"Engineering diagrams","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/engineering-diagrams"},{"title":"Convert a diagram to image format","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /context/diagram/convert","href":"/20230101/engineering-diagrams/convert-a-diagram-to-image-format"},{"title":"Detect annotations in engineering diagrams","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /context/diagram/detect","href":"/20230101/engineering-diagrams/detect-annotations-in-engineering-diagrams"},{"title":"Get the results for converting an engineering diagram to an image","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /context/diagram/convert/{jobId}","href":"/20230101/engineering-diagrams/get-the-results-for-converting-an-engineering-diagram-to-an-image"},{"title":"Retrieve engineering diagram detect results","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /context/diagram/detect/{jobId}","href":"/20230101/engineering-diagrams/retrieve-engineering-diagram-detect-results"}]},{"group":"Vision","pages":[{"title":"Vision","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/vision"},{"title":"Extract features from images","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /context/vision/extract","href":"/20230101/vision/extract-features-from-images"},{"title":"Retrieve results from a feature extraction job on images","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /context/vision/extract/{jobId}","href":"/20230101/vision/retrieve-results-from-a-feature-extraction-job-on-images"}]}]},{"group":"Data lifecycle","icon":"git-branch","expanded":true,"pages":[{"group":"Data ingestion","pages":[{"title":"Data ingestion","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/data-ingestion"},{"group":"Raw","pages":[{"title":"Raw","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/raw"},{"title":"Create databases","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /raw/dbs","href":"/20230101/raw/create-databases"},{"title":"Delete databases","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /raw/dbs/delete","href":"/20230101/raw/delete-databases"},{"title":"Create tables in a database","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /raw/dbs/{dbName}/tables","href":"/20230101/raw/create-tables-in-a-database"},{"title":"Delete tables in a database","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /raw/dbs/{dbName}/tables/delete","href":"/20230101/raw/delete-tables-in-a-database"},{"title":"Insert rows into a table","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /raw/dbs/{dbName}/tables/{tableName}/rows","href":"/20230101/raw/insert-rows-into-a-table"},{"title":"Delete rows in a table","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /raw/dbs/{dbName}/tables/{tableName}/rows/delete","href":"/20230101/raw/delete-rows-in-a-table"},{"title":"List databases","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /raw/dbs","href":"/20230101/raw/list-databases"},{"title":"List tables in a database","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /raw/dbs/{dbName}/tables","href":"/20230101/raw/list-tables-in-a-database"},{"title":"Retrieve cursors for parallel reads","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /raw/dbs/{dbName}/tables/{tableName}/cursors","href":"/20230101/raw/retrieve-cursors-for-parallel-reads"},{"title":"Retrieve rows from a table","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /raw/dbs/{dbName}/tables/{tableName}/rows","href":"/20230101/raw/retrieve-rows-from-a-table"},{"title":"Retrieve row by key","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /raw/dbs/{dbName}/tables/{tableName}/rows/{rowKey}","href":"/20230101/raw/retrieve-row-by-key"}]},{"group":"Extraction pipelines","pages":[{"title":"Extraction Pipelines","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/extraction-pipelines"},{"title":"Create extraction pipelines","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extpipes","href":"/20230101/extraction-pipelines/create-extraction-pipelines"},{"title":"Delete extraction pipelines","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extpipes/delete","href":"/20230101/extraction-pipelines/delete-extraction-pipelines"},{"title":"Filter extraction pipelines","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extpipes/list","href":"/20230101/extraction-pipelines/filter-extraction-pipelines"},{"title":"Retrieve an extraction pipeline by its ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /extpipes/{id}","href":"/20230101/extraction-pipelines/retrieve-an-extraction-pipeline-by-its-id"},{"title":"Retrieve extraction pipelines","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extpipes/byids","href":"/20230101/extraction-pipelines/retrieve-extraction-pipelines"},{"title":"Update extraction pipelines","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extpipes/update","href":"/20230101/extraction-pipelines/update-extraction-pipelines"}]},{"group":"Extraction pipelines runs","pages":[{"title":"Extraction Pipelines Runs","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/extraction-pipelines-runs"},{"title":"Create extraction pipeline runs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extpipes/runs","href":"/20230101/extraction-pipelines-runs/create-extraction-pipeline-runs"},{"title":"Filter extraction pipeline runs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extpipes/runs/list","href":"/20230101/extraction-pipelines-runs/filter-extraction-pipeline-runs"}]},{"group":"Extraction pipelines config","pages":[{"title":"Extraction Pipelines Config","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/extraction-pipelines-config"},{"title":"Create extraction configuration revision","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extpipes/config","href":"/20230101/extraction-pipelines-config/create-extraction-configuration-revision"},{"title":"Get a single configuration revision","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /extpipes/config","href":"/20230101/extraction-pipelines-config/get-a-single-configuration-revision"},{"title":"List configuration revisions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /extpipes/config/revisions","href":"/20230101/extraction-pipelines-config/list-configuration-revisions"},{"title":"Revert configuration revision","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extpipes/config/revert","href":"/20230101/extraction-pipelines-config/revert-configuration-revision"}]},{"group":"Extractors","pages":[{"title":"Extractors","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/extractors"},{"title":"List Extractors","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /extractors","href":"/20230101/extractors/list-extractors"},{"title":"Retrieve Extractors","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extractors/byids","href":"/20230101/extractors/retrieve-extractors"},{"title":"List releases","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /extractors/releases","href":"/20230101/extractors/list-releases"},{"title":"Retrieve Releases","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extractors/releases/byids","href":"/20230101/extractors/retrieve-releases"},{"title":"List Source Systems","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /extractors/sources","href":"/20230101/extractors/list-source-systems"},{"title":"Retrieve Source Systems","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extractors/sources/byids","href":"/20230101/extractors/retrieve-source-systems"},{"title":"List Solutions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /extractors/solutions","href":"/20230101/extractors/list-solutions"},{"title":"Retrieve Solutions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extractors/solutions/byids","href":"/20230101/extractors/retrieve-solutions"},{"title":"Get Config Schema","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /extractors/schemas/{extractor}/{version}","href":"/20230101/extractors/get-config-schema"}]},{"group":"Hosted extractors","pages":[{"title":"Hosted extractors","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/hosted-extractors"},{"group":"Sources","pages":[{"title":"Sources","sidebarTitle":"Sources","href":"/api-reference/concepts/20230101/hosted-extractors-sources"},{"title":"Create Sources","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/sources","href":"/20230101/sources/create-sources"},{"title":"Delete Sources","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/sources/delete","href":"/20230101/sources/delete-sources"},{"title":"List Sources","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /hostedextractors/sources","href":"/20230101/sources/list-sources"},{"title":"Retrieve Sources","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/sources/byIds","href":"/20230101/sources/retrieve-sources"},{"title":"Update Sources","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/sources/update","href":"/20230101/sources/update-sources"}]},{"group":"Jobs","pages":[{"title":"Jobs","sidebarTitle":"Jobs","href":"/api-reference/concepts/20230101/hosted-extractors-jobs"},{"title":"Create Jobs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/jobs","href":"/20230101/jobs/create-jobs"},{"title":"Delete Jobs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/jobs/delete","href":"/20230101/jobs/delete-jobs"},{"title":"Get Job Logs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /hostedextractors/jobs/logs","href":"/20230101/jobs/get-job-logs"},{"title":"Get Job DLQ Messages","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /hostedextractors/jobs/dlq","href":"/20230101/jobs/get-job-dlq-messages"},{"title":"Get Job Metrics","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /hostedextractors/jobs/metrics","href":"/20230101/jobs/get-job-metrics"},{"title":"Retrieve Jobs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/jobs/byIds","href":"/20230101/jobs/retrieve-jobs"},{"title":"Update Jobs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/jobs/update","href":"/20230101/jobs/update-jobs"}]},{"group":"Destinations","pages":[{"title":"Destinations","sidebarTitle":"Destinations","href":"/api-reference/concepts/20230101/hosted-extractors-destinations"},{"title":"Create Destinations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/destinations","href":"/20230101/destinations/create-destinations"},{"title":"Delete Destinations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/destinations/delete","href":"/20230101/destinations/delete-destinations"},{"title":"Retrieve Destinations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/destinations/byIds","href":"/20230101/destinations/retrieve-destinations"},{"title":"Update Destinations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/destinations/update","href":"/20230101/destinations/update-destinations"}]},{"group":"Mappings","pages":[{"title":"Mappings","sidebarTitle":"Mappings","href":"/api-reference/concepts/20230101/hosted-extractors-mappings"},{"title":"Create Mappings","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/mappings","href":"/20230101/mappings/create-mappings"},{"title":"Delete Mappings","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/mappings/delete","href":"/20230101/mappings/delete-mappings"},{"title":"Retrieve Mappings","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/mappings/byIds","href":"/20230101/mappings/retrieve-mappings"},{"title":"Update Mappings","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/mappings/update","href":"/20230101/mappings/update-mappings"}]}]}]},{"group":"Data organization","pages":[{"title":"Data organization","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/data-organization"},{"group":"Data products","pages":[{"title":"Data products","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/data-products"},{"title":"Create a data product","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /dataproducts","href":"/20230101/data-products/create-a-data-product"},{"title":"List data products","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /dataproducts","href":"/20230101/data-products/list-data-products"},{"title":"Get a data product","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /dataproducts/{externalId}","href":"/20230101/data-products/get-a-data-product"},{"title":"Delete a data product","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /dataproducts/delete","href":"/20230101/data-products/delete-a-data-product"},{"title":"Update a data product","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /dataproducts/update","href":"/20230101/data-products/update-a-data-product"},{"title":"Get data products","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /dataproducts/byids","href":"/20230101/data-products/get-data-products"},{"title":"Create a data product version","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /dataproducts/{externalId}/versions","href":"/20230101/data-products/create-a-data-product-version"},{"title":"List data product versions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /dataproducts/{externalId}/versions","href":"/20230101/data-products/list-data-product-versions"},{"title":"Get a data product version","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /dataproducts/{externalId}/versions/{version}","href":"/20230101/data-products/get-a-data-product-version"},{"title":"Delete data product versions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /dataproducts/{externalId}/versions/delete","href":"/20230101/data-products/delete-data-product-versions"},{"title":"Update data product version","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /dataproducts/{externalId}/versions/update","href":"/20230101/data-products/update-data-product-version"}]}]},{"group":"Transformations","pages":[{"title":"Transformations","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/transformations-overview"},{"group":"Transformations","pages":[{"title":"Transformations","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/transformations"},{"title":"Create transformations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations","href":"/20230101/transformations/create-transformations"},{"title":"Cancel a transformation","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/cancel","href":"/20230101/transformations/cancel-a-transformation"},{"title":"Delete transformations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/delete","href":"/20230101/transformations/delete-transformations"},{"title":"Filter transformations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/filter","href":"/20230101/transformations/filter-transformations"},{"title":"Retrieve transformations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/byids","href":"/20230101/transformations/retrieve-transformations"},{"title":"Run a transformation","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/run","href":"/20230101/transformations/run-a-transformation"},{"title":"Update transformations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/update","href":"/20230101/transformations/update-transformations"}]},{"group":"Transformation jobs","pages":[{"title":"Transformation Jobs","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/transformation-jobs"},{"title":"List jobs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /transformations/jobs","href":"/20230101/transformation-jobs/list-jobs"},{"title":"Retrieve jobs by ids","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/jobs/byids","href":"/20230101/transformation-jobs/retrieve-jobs-by-ids"},{"title":"List job metrics by job id","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /transformations/jobs/{id}/metrics","href":"/20230101/transformation-jobs/list-job-metrics-by-job-id"}]},{"group":"Transformation schedules","pages":[{"title":"Transformation Schedules","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/transformation-schedules"},{"title":"List all schedules","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /transformations/schedules","href":"/20230101/transformation-schedules/list-all-schedules"},{"title":"Schedule transformations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/schedules","href":"/20230101/transformation-schedules/schedule-transformations"},{"title":"Retrieve schedules","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/schedules/byids","href":"/20230101/transformation-schedules/retrieve-schedules"},{"title":"Unschedule transformations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/schedules/delete","href":"/20230101/transformation-schedules/unschedule-transformations"},{"title":"Update schedules","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/schedules/update","href":"/20230101/transformation-schedules/update-schedules"}]},{"group":"Transformation notifications","pages":[{"title":"Transformation Notifications","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/transformation-notifications"},{"title":"Subscribe for notifications","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/notifications","href":"/20230101/transformation-notifications/subscribe-for-notifications"},{"title":"Delete notification subscriptions by notification ID","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/notifications/delete","href":"/20230101/transformation-notifications/delete-notification-subscriptions-by-notification-id"}]},{"group":"Query","pages":[{"title":"Query","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/transformation-query"},{"title":"Run query","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/query/run","href":"/20230101/query/run-query"}]},{"group":"Schema","pages":[{"title":"Schema","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/transformation-schema"},{"title":"Get Instance schema.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /transformations/schema/instances","href":"/20230101/schema/get-instance-schema"},{"title":"Get the schema of a sequence","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /transformations/schema/sequence_rows","href":"/20230101/schema/get-the-schema-of-a-sequence"},{"title":"Get the schema of resource type","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /transformations/schema/{schemaType}","href":"/20230101/schema/get-the-schema-of-resource-type"}]}]}]},{"group":"Documents","icon":"file-text","expanded":true,"pages":[{"group":"Documents","pages":[{"title":"Documents","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/documents-overview"},{"group":"Documents","pages":[{"title":"Documents","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/documents"},{"title":"Aggregate","href":"/api-reference/concepts/20230101/aggregate"},{"title":"Search","href":"/api-reference/concepts/20230101/search"},{"title":"Passages search","href":"/api-reference/concepts/20230101/passages-search"},{"title":"Aggregate documents","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /documents/aggregate","href":"/20230101/documents/aggregate-documents"},{"title":"List documents","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /documents/list","href":"/20230101/documents/list-documents"},{"title":"Retrieve document content","description":"Returns the full extracted text of a document. Set `Accept` to `text/plain`. Requires `filesAcl:READ`. See [List and content](/api-reference/concepts/20230101/documents#list-and-content).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /documents/content","href":"/20230101/documents/retrieve-document-content"},{"title":"Search for documents","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /documents/search","href":"/20230101/documents/search-for-documents"},{"title":"Semantic search for passages","description":"Searches passages inside documents. Requires `filesAcl:READ`. See [Passages search](/api-reference/concepts/20230101/passages-search).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /documents/passages/search","href":"/20230101/documents/semantic-search-for-passages"}]},{"group":"Document preview","pages":[{"title":"Document preview","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/document-preview"},{"title":"Retrieve a image preview of a page from a document","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /documents/{documentId}/preview/image/pages/{pageNumber}","href":"/20230101/document-preview/retrieve-a-image-preview-of-a-page-from-a-document"},{"title":"Retrieve a PDF preview of a document","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /documents/{documentId}/preview/pdf","href":"/20230101/document-preview/retrieve-a-pdf-preview-of-a-document"},{"title":"Retrieve a temporary link to a PDF preview of a document","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /documents/{documentId}/preview/pdf/temporarylink","href":"/20230101/document-preview/retrieve-a-temporary-link-to-a-pdf-preview-of-a-document"}]}]}]},{"group":"Workflows","icon":"workflow","pages":[{"title":"Workflows API overview","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/workflows-overview"},{"group":"Workflows","pages":[{"title":"Workflows API","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/workflows"},{"title":"Create or update a workflow","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /workflows","href":"/20230101/workflows/create-or-update-a-workflow"},{"title":"Delete workflows","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /workflows/delete","href":"/20230101/workflows/delete-workflows"},{"title":"Retrieve a workflow","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /workflows/{workflowExternalId}","href":"/20230101/workflows/retrieve-a-workflow"}]},{"group":"Workflow versions","pages":[{"title":"Workflow versions","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/workflow-versions"},{"title":"Create or update a workflow version","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /workflows/versions","href":"/20230101/workflow-versions/create-or-update-a-workflow-version"},{"title":"Filter workflow versions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /workflows/versions/list","href":"/20230101/workflow-versions/filter-workflow-versions"},{"title":"Retrieve a workflow version","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /workflows/{workflowExternalId}/versions/{version}","href":"/20230101/workflow-versions/retrieve-a-workflow-version"},{"title":"Delete workflow versions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /workflows/versions/delete","href":"/20230101/workflow-versions/delete-workflow-versions"}]},{"group":"Workflow executions","pages":[{"title":"Workflow executions","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/workflow-executions"},{"title":"Run a workflow","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /workflows/{workflowExternalId}/versions/{version}/run","href":"/20230101/workflow-executions/run-a-workflow"},{"title":"Filter workflow executions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /workflows/executions/list","href":"/20230101/workflow-executions/filter-workflow-executions"},{"title":"Retrieve workflow execution details","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /workflows/executions/{executionId}","href":"/20230101/workflow-executions/retrieve-workflow-execution-details"},{"title":"Cancel a workflow execution","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /workflows/executions/{executionId}/cancel","href":"/20230101/workflow-executions/cancel-a-workflow-execution"},{"title":"Retry workflow execution","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /workflows/executions/{executionId}/retry","href":"/20230101/workflow-executions/retry-workflow-execution"}]},{"group":"Workflow triggers","pages":[{"title":"Workflow triggers","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/workflow-triggers"},{"title":"Create or update triggers","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /workflows/triggers","href":"/20230101/workflow-triggers/create-or-update-triggers"},{"title":"Delete triggers","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /workflows/triggers/delete","href":"/20230101/workflow-triggers/delete-triggers"},{"title":"Get the run history of a trigger","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /workflows/triggers/{triggerExternalId}/history","href":"/20230101/workflow-triggers/get-the-run-history-of-a-trigger"},{"title":"Pause a trigger","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /workflows/triggers/{triggerExternalId}/pause","href":"/20230101/workflow-triggers/pause-a-trigger"},{"title":"Resume a trigger","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /workflows/triggers/{triggerExternalId}/resume","href":"/20230101/workflow-triggers/resume-a-trigger"}]},{"group":"Tasks","pages":[{"title":"Tasks","sidebarTitle":"Tasks","href":"/api-reference/concepts/20230101/workflow-tasks"},{"title":"Update task status","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /workflows/tasks/{taskId}/update","href":"/20230101/tasks/update-task-status"}]}]},{"group":"Specialized","icon":"sparkles","expanded":true,"pages":[{"group":"Simulators","pages":[{"title":"Simulators","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/simulators-overview"},{"group":"Simulators","pages":[{"title":"Simulators","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/simulators"},{"title":"Filter Simulators","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/list","href":"/20230101/simulators/filter-simulators"}]},{"group":"Simulator integrations","pages":[{"title":"Simulator Integrations","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/simulator-integrations"},{"title":"Delete Simulator Integrations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/integrations/delete","href":"/20230101/simulator-integrations/delete-simulator-integrations"},{"title":"Filter Simulator Integrations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/integrations/list","href":"/20230101/simulator-integrations/filter-simulator-integrations"}]},{"group":"Simulator models","pages":[{"title":"Simulator Models","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/simulator-models"},{"title":"Create Simulator Model","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/models","href":"/20230101/simulator-models/create-simulator-model"},{"title":"Filter Simulator Models","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/models/list","href":"/20230101/simulator-models/filter-simulator-models"},{"title":"Aggregate Simulator Models","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/models/aggregate","href":"/20230101/simulator-models/aggregate-simulator-models"},{"title":"Delete Simulator Model","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/models/delete","href":"/20230101/simulator-models/delete-simulator-model"},{"title":"Update Simulator Model","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/models/update","href":"/20230101/simulator-models/update-simulator-model"},{"title":"Retrieve Simulator Model","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/models/byids","href":"/20230101/simulator-models/retrieve-simulator-model"},{"title":"Create Simulator Model Revision","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/models/revisions","href":"/20230101/simulator-models/create-simulator-model-revision"},{"title":"Filter Simulator Model Revisions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/models/revisions/list","href":"/20230101/simulator-models/filter-simulator-model-revisions"},{"title":"Retrieve Simulator Model Revisions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/models/revisions/byids","href":"/20230101/simulator-models/retrieve-simulator-model-revisions"}]},{"group":"Simulator routines","pages":[{"title":"Simulator Routines","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/simulator-routines"},{"title":"Create Simulator Routine","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/routines","href":"/20230101/simulator-routines/create-simulator-routine"},{"title":"Filter Simulator Routines","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/routines/list","href":"/20230101/simulator-routines/filter-simulator-routines"},{"title":"Delete Simulator Routine","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/routines/delete","href":"/20230101/simulator-routines/delete-simulator-routine"},{"title":"Aggregate Simulator Routines","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/routines/aggregate","href":"/20230101/simulator-routines/aggregate-simulator-routines"},{"title":"Create Simulator Routine Revision","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/routines/revisions","href":"/20230101/simulator-routines/create-simulator-routine-revision"},{"title":"Filter Simulator Routine Revisions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/routines/revisions/list","href":"/20230101/simulator-routines/filter-simulator-routine-revisions"},{"title":"Retrieve Simulator Routine Revisions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/routines/revisions/byids","href":"/20230101/simulator-routines/retrieve-simulator-routine-revisions"}]},{"group":"Simulation runs","pages":[{"title":"Simulation Runs","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/simulation-runs"},{"title":"Run Simulation","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/run","href":"/20230101/simulation-runs/run-simulation"},{"title":"Filter Simulation Runs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/runs/list","href":"/20230101/simulation-runs/filter-simulation-runs"},{"title":"Retrieve Simulation","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/runs/byids","href":"/20230101/simulation-runs/retrieve-simulation"},{"title":"Retrieve Simulation Data","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/runs/data/list","href":"/20230101/simulation-runs/retrieve-simulation-data"}]},{"group":"Simulator logs","pages":[{"title":"Simulator Logs","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/simulator-logs"},{"title":"Retrieve Simulator Logs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/logs/byids","href":"/20230101/simulator-logs/retrieve-simulator-logs"}]}]},{"group":"Units","pages":[{"title":"Units","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/units-overview"},{"group":"Units","pages":[{"title":"Units","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/units"},{"title":"List all units","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /units","href":"/20230101/units/list-all-units"},{"title":"Retrieve unit by external ID","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /units/{externalId}","href":"/20230101/units/retrieve-unit-by-external-id"},{"title":"Retrieve units by external IDs","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /units/byids","href":"/20230101/units/retrieve-units-by-external-ids"}]},{"group":"Unit systems","pages":[{"title":"Unit Systems","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/unit-systems"},{"title":"List all unit systems","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /units/systems","href":"/20230101/unit-systems/list-all-unit-systems"}]}]}]},{"group":"Legacy","icon":"archive","expanded":true,"pages":[{"group":"Legacy data modeling","pages":[{"title":"Asset-centric data modeling (legacy)","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/asset-centric"},{"group":"Assets","pages":[{"title":"Assets","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/assets"},{"title":"Aggregate assets","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /assets/aggregate","href":"/20230101/assets/aggregate-assets"},{"title":"Create assets","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /assets","href":"/20230101/assets/create-assets"},{"title":"Delete assets","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /assets/delete","href":"/20230101/assets/delete-assets"},{"title":"Filter assets","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /assets/list","href":"/20230101/assets/filter-assets"},{"title":"List assets","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /assets","href":"/20230101/assets/list-assets"},{"title":"Retrieve an asset by its ID","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /assets/{id}","href":"/20230101/assets/retrieve-an-asset-by-its-id"},{"title":"Retrieve assets","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /assets/byids","href":"/20230101/assets/retrieve-assets"},{"title":"Search assets","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /assets/search","href":"/20230101/assets/search-assets"},{"title":"Update assets","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /assets/update","href":"/20230101/assets/update-assets"}]},{"group":"Time series metadata","pages":[{"title":"Time series","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/time-series"},{"title":"Aggregate time series","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/aggregate","href":"/20230101/time-series/aggregate-time-series"},{"title":"Create time series","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries","href":"/20230101/time-series/create-time-series"},{"title":"Delete time series","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/delete","href":"/20230101/time-series/delete-time-series"},{"title":"Filter time series","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/list","href":"/20230101/time-series/filter-time-series"},{"title":"List time series","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /timeseries","href":"/20230101/time-series/list-time-series"},{"title":"Retrieve time series","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/byids","href":"/20230101/time-series/retrieve-time-series"},{"title":"Search time series","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/search","href":"/20230101/time-series/search-time-series"},{"title":"Update time series","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /timeseries/update","href":"/20230101/time-series/update-time-series"}]},{"group":"Events","pages":[{"title":"Events","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/events"},{"title":"Aggregate events","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /events/aggregate","href":"/20230101/events/aggregate-events"},{"title":"Create events","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /events","href":"/20230101/events/create-events"},{"title":"Delete events","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /events/delete","href":"/20230101/events/delete-events"},{"title":"Filter events","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /events/list","href":"/20230101/events/filter-events"},{"title":"List events","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /events","href":"/20230101/events/list-events"},{"title":"Receive an event by its ID","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /events/{id}","href":"/20230101/events/receive-an-event-by-its-id"},{"title":"Retrieve events","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /events/byids","href":"/20230101/events/retrieve-events"},{"title":"Search events","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /events/search","href":"/20230101/events/search-events"},{"title":"Update events","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /events/update","href":"/20230101/events/update-events"}]},{"group":"File metadata","pages":[{"title":"Files","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/files"},{"title":"Aggregate files","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/aggregate","href":"/20230101/files/aggregate-files"},{"title":"Upload file","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files","href":"/20230101/files/upload-file"},{"title":"Delete files","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/delete","href":"/20230101/files/delete-files"},{"title":"Filter files","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/list","href":"/20230101/files/filter-files"},{"title":"List files","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /files","href":"/20230101/files/list-files"},{"title":"Retrieve a file by its ID","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /files/{id}","href":"/20230101/files/retrieve-a-file-by-its-id"},{"title":"Retrieve files","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/byids","href":"/20230101/files/retrieve-files"},{"title":"Search files","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/search","href":"/20230101/files/search-files"},{"title":"Update files","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/update","href":"/20230101/files/update-files"}]},{"group":"Sequences","pages":[{"title":"Sequences","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/sequences"},{"title":"Aggregate sequences","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/aggregate","href":"/20230101/sequences/aggregate-sequences"},{"title":"Create sequences","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences","href":"/20230101/sequences/create-sequences"},{"title":"Delete rows","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/data/delete","href":"/20230101/sequences/delete-rows"},{"title":"Delete sequences","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/delete","href":"/20230101/sequences/delete-sequences"},{"title":"Filter sequences","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/list","href":"/20230101/sequences/filter-sequences"},{"title":"Insert rows","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/data","href":"/20230101/sequences/insert-rows"},{"title":"List sequences","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /sequences","href":"/20230101/sequences/list-sequences"},{"title":"Retrieve last row","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/data/latest","href":"/20230101/sequences/retrieve-last-row"},{"title":"Retrieve rows","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/data/list","href":"/20230101/sequences/retrieve-rows"},{"title":"Retrieve sequences","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/byids","href":"/20230101/sequences/retrieve-sequences"},{"title":"Search sequences","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/search","href":"/20230101/sequences/search-sequences"},{"title":"Update sequences","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/update","href":"/20230101/sequences/update-sequences"}]},{"group":"Data sets","pages":[{"title":"Data sets","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/data-sets"},{"title":"Create data sets","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /datasets","href":"/20230101/data-sets/create-data-sets"},{"title":"Aggregate data sets","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /datasets/aggregate","href":"/20230101/data-sets/aggregate-data-sets"},{"title":"Filter data sets","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /datasets/list","href":"/20230101/data-sets/filter-data-sets"},{"title":"Retrieve data sets","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /datasets/byids","href":"/20230101/data-sets/retrieve-data-sets"},{"title":"Update data sets.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /datasets/update","href":"/20230101/data-sets/update-data-sets"}]},{"group":"Labels","pages":[{"title":"Labels","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/labels"},{"title":"Create label definitions.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /labels","href":"/20230101/labels/create-label-definitions"},{"title":"Filter labels","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /labels/list","href":"/20230101/labels/filter-labels"},{"title":"Retrieve labels","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /labels/byids","href":"/20230101/labels/retrieve-labels"},{"title":"Delete label definitions.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /labels/delete","href":"/20230101/labels/delete-label-definitions"}]},{"group":"Relationships","pages":[{"title":"Relationships","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/relationships"},{"title":"Create relationships","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /relationships","href":"/20230101/relationships/create-relationships"},{"title":"Delete relationships","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /relationships/delete","href":"/20230101/relationships/delete-relationships"},{"title":"Filter relationships","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /relationships/list","href":"/20230101/relationships/filter-relationships"},{"title":"List relationships","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /relationships","href":"/20230101/relationships/list-relationships"},{"title":"Retrieve relationships","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /relationships/byids","href":"/20230101/relationships/retrieve-relationships"},{"title":"Update relationships","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /relationships/update","href":"/20230101/relationships/update-relationships"}]},{"group":"Annotations","pages":[{"title":"Annotations","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/annotations"},{"title":"Create annotations","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /annotations","href":"/20230101/annotations/create-annotations"},{"title":"Suggest annotations","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /annotations/suggest","href":"/20230101/annotations/suggest-annotations"},{"title":"Get an annotation","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /annotations/{annotationId}","href":"/20230101/annotations/get-an-annotation"},{"title":"Filter annotations","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /annotations/list","href":"/20230101/annotations/filter-annotations"},{"title":"Retrieve annotations","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /annotations/byids","href":"/20230101/annotations/retrieve-annotations"},{"title":"Delete annotations","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /annotations/delete","href":"/20230101/annotations/delete-annotations"},{"title":"Update annotations","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /annotations/update","href":"/20230101/annotations/update-annotations"}]},{"group":"Geospatial","pages":[{"title":"Geospatial","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101/geospatial"},{"title":"Aggregate features","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/featuretypes/{featureTypeExternalId}/features/aggregate","href":"/20230101/geospatial/aggregate-features"},{"title":"Compute","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/compute","href":"/20230101/geospatial/compute"},{"title":"Create Coordinate Reference Systems","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/crs","href":"/20230101/geospatial/create-coordinate-reference-systems"},{"title":"Create feature types","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/featuretypes","href":"/20230101/geospatial/create-feature-types"},{"title":"Create features","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/featuretypes/{featureTypeExternalId}/features","href":"/20230101/geospatial/create-features"},{"title":"Delete Coordinate Reference Systems","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/crs/delete","href":"/20230101/geospatial/delete-coordinate-reference-systems"},{"title":"Delete feature types","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/featuretypes/delete","href":"/20230101/geospatial/delete-feature-types"},{"title":"Delete features","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/featuretypes/{featureTypeExternalId}/features/delete","href":"/20230101/geospatial/delete-features"},{"title":"Delete a raster from a feature property","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/featuretypes/{featureTypeExternalId}/features/{featureExternalId}/rasters/{rasterPropertyName}/delete","href":"/20230101/geospatial/delete-a-raster-from-a-feature-property"},{"title":"Get Coordinate Reference Systems","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/crs/byids","href":"/20230101/geospatial/get-coordinate-reference-systems"},{"title":"Get features","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /geospatial/featuretypes/{featureTypeExternalId}/features","href":"/20230101/geospatial/get-features"},{"title":"List feature types","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/featuretypes/list","href":"/20230101/geospatial/list-feature-types"},{"title":"Put a raster into a feature property","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json put /geospatial/featuretypes/{featureTypeExternalId}/features/{featureExternalId}/rasters/{rasterPropertyName}","href":"/20230101/geospatial/put-a-raster-into-a-feature-property"},{"title":"Get a raster from a feature property","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/featuretypes/{featureTypeExternalId}/features/{featureExternalId}/rasters/{rasterPropertyName}","href":"/20230101/geospatial/get-a-raster-from-a-feature-property"},{"title":"Retrieve feature types","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/featuretypes/byids","href":"/20230101/geospatial/retrieve-feature-types"},{"title":"Retrieve features","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/featuretypes/{featureTypeExternalId}/features/byids","href":"/20230101/geospatial/retrieve-features"},{"title":"Search and stream features","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/featuretypes/{featureTypeExternalId}/features/search-streaming","href":"/20230101/geospatial/search-and-stream-features"},{"title":"Search features","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/featuretypes/{featureTypeExternalId}/features/search","href":"/20230101/geospatial/search-features"},{"title":"Update feature types","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/featuretypes/update","href":"/20230101/geospatial/update-feature-types"},{"title":"Update features","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/featuretypes/{featureTypeExternalId}/features/update","href":"/20230101/geospatial/update-features"},{"title":"Filter all features","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/featuretypes/{featureTypeExternalId}/features/list","href":"/20230101/geospatial/filter-all-features"}]}]}]}]}]},{"item":"Beta (20230101-beta)","description":"Preview API operations on top of stable","pages":[{"title":"Beta (20230101-beta)","href":"/api-reference/concepts/20230101-beta/api-description"}]},{"item":"Alpha (20230101-alpha)","description":"Experimental API operations","pages":[{"title":"Alpha (20230101-alpha)","href":"/api-reference/concepts/20230101-alpha/api-description"}]}]},{"tab":"CogDocs","hidden":true,"searchable":false,"pages":[{"title":"CogDocs","href":"/cogdocs/concepts/platform-overview"}]}]},{"language":"de","pages":[{"title":"de","href":"/de"}]},{"language":"es","pages":[{"title":"es","href":"/es"}]},{"language":"fr","pages":[{"title":"fr","href":"/fr"}]},{"language":"ko","pages":[{"title":"ko","href":"/ko"}]},{"language":"it","pages":[{"title":"it","href":"/it"}]},{"language":"lv","pages":[{"title":"lv","href":"/lv"}]},{"language":"nl","pages":[{"title":"nl","href":"/nl"}]},{"language":"ja","pages":[{"title":"ja","href":"/ja"}]},{"language":"no","pages":[{"title":"no","href":"/no"}]},{"language":"pt","pages":[{"title":"pt","href":"/pt"}]},{"language":"ro","pages":[{"title":"ro","href":"/ro"}]},{"language":"sv","pages":[{"title":"sv","href":"/sv"}]},{"language":"zh","pages":[{"title":"zh","href":"/zh"}]}]},"basePath":"","title":"Search for documents - Cognite Docs","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["10e4515597","c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["BannerMarkdown-6DXXLlfN.js","dist-CmKHfscc.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-C3kuh_dz.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-D6S0Yh6q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","AssistantPageLink-U3mI6Ljh.js"]}