{"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":"6aef79c5feeeb29da17da3a7","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"en","tag":"API reference","count":1603},{"language":"en","tag":"Alpha (20230101-alpha)","count":558},{"language":"en","tag":"API reference (20230101-alpha)","count":558},{"language":"en","tag":"Beta (20230101-beta)","count":522},{"language":"en","tag":"API reference (20230101-beta)","count":522},{"language":"en","tag":"Stable (20230101)","count":516},{"language":"en","tag":"API reference (20230101)","count":516},{"language":"en","tag":"Data engineering","count":452},{"language":"en","tag":"Core data","count":317},{"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":"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},{"name":"comment-mode","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":"es/search","slug":"/es/search","pageMetadata":{"title":"Search","hideFooterPagination":true,"robots":"noindex, nofollow","noindex":true},"pageType":"default","subdomain":"cognite","siteName":"Cognite Docs","title":"Search - Cognite Docs","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"],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"fullPageSearch":{"locale":"es"},"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=\"application-name\" content=\"Cognite Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex, nofollow\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/svg+xml\" sizes=\"180x180\" href=\"https://mintcdn.com/cognite/dkctM57aym6D8Toa/_images/CogniteIcon.svg?fit=max\u0026amp;auto=format\u0026amp;n=dkctM57aym6D8Toa\u0026amp;q=85\u0026amp;s=eaf7720816d261929421c888d58b8914\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"32x32\" href=\"https://mintcdn.com/cognite/dkctM57aym6D8Toa/_images/CogniteIcon.svg?fit=max\u0026amp;auto=format\u0026amp;n=dkctM57aym6D8Toa\u0026amp;q=85\u0026amp;s=eaf7720816d261929421c888d58b8914\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"16x16\" href=\"https://mintcdn.com/cognite/dkctM57aym6D8Toa/_images/CogniteIcon.svg?fit=max\u0026amp;auto=format\u0026amp;n=dkctM57aym6D8Toa\u0026amp;q=85\u0026amp;s=eaf7720816d261929421c888d58b8914\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/svg+xml\" href=\"https://mintcdn.com/cognite/dkctM57aym6D8Toa/_images/CogniteIcon.svg?fit=max\u0026amp;auto=format\u0026amp;n=dkctM57aym6D8Toa\u0026amp;q=85\u0026amp;s=eaf7720816d261929421c888d58b8914\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/cognite/_generated/favicon/browserconfig.xml?v=3\">\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=\"hideFooterPagination\" content=\"true\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cognite Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cognite Docs","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Welcome","groups":[{"group":"Welcome","pages":[{"title":"Cognite documentation","description":"Self-service product documentation for developers and technology professionals.","mode":"wide","to-L10N":true,"content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":""}]},{"group":"Getting started","pages":[{"title":"About Cognite Data Fusion (CDF)","description":"Cognite Data Fusion (CDF) is an industrial DataOps platform that streams your industrial data into a structured, flexible, and contextualized knowledge graph.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/cdf/index"},{"title":"Sign in to CDF","description":"To sign in to Cognite Data Fusion, you must provide your organization's name, enter your credentials, and specify which project you're signing in to.","content-type":"procedure","audience":"businessUser","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":true,"href":"/cdf/sign-in"},{"title":"Subscribe to CDF","description":"Subscribe to Cognite Data Fusion (CDF) and connect to and use our cloud-based apps and services.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/cdf/sign-up"}]}]},{"tab":"Flows","groups":[{"group":"Flows","pages":[{"title":"About Flows","sidebarTitle":"Overview","description":"Use the Flows workspace to find and analyze data.","content-type":"reference","mode":"wide","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/flows_workspace"},{"title":"Flows workspace","description":"Navigate the Flows workspace sidebar to switch tools and projects, chat with Cognite Atlas, and manage help and profile settings.","content-type":"reference","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/flows_workspace/flows_workspace"},{"title":"Search","description":"Step-by-step guide to finding industrial data in Cognite Data Fusion (CDF), from filtering and sorting results to previewing an item and downloading lists as CSV.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/explore/search"},{"title":"Browse 3D","description":"Explore physical assets in 3D environments and search for equipment within location models.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/explore/navigate_3d"},{"title":"Canvas","description":"Step-by-step guide to create a canvas, upload files, add time series and diagrams, work with PDFs, build cause maps, organize canvases with labels, and use agents to analyze industrial data.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/explore/canvas"},{"title":"Charts","description":"Analyze time series data, create calculations, set thresholds, monitor alerts, assess data quality, and visualize activities.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/explore/charts"},{"title":"Custom apps","description":"Access custom applications built for your organization's specific workflows.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/explore/custom_apps"},{"title":"Agents","description":"Work with Atlas AI agents trained on your data and customized for your organization's specific use cases.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/explore/agents"}]},{"group":"InField","pages":[{"title":"About Cognite InField","sidebarTitle":"Overview","description":"Help field workers and supervisors efficiently plan and perform their tasks replacing paper-based data-gathering.","content-type":"map","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/infield/index"},{"title":"Create templates and checklists","description":"Create templates, add tasks and schedules, and generate checklists for field workers to perform at regular intervals.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/infield/guides/create_templates"},{"title":"Plan, schedule, and assign activities","description":"View work orders and checklists, assign activities to disciplines or users, create checklists from work orders, and track task progress.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/infield/guides/plan"},{"title":"Perform activities","description":"Work with checklists to complete tasks, add measurement readings, record observations, and work offline on your mobile device.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/infield/guides/perform"},{"title":"Create and view observations","description":"Record equipment issues discovered during work, track their status, and send reports.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/infield/guides/observations"},{"title":"Troubleshooting","description":"Find information to help you troubleshoot common issues.","content-type":"troubleshooting","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"support","article-type":"article","href":"/cdf/infield/guides/troubleshoot"}]},{"group":"Maintain","pages":[{"title":"About Cognite Maintain","sidebarTitle":"Overview","description":"Cognite Maintain helps you plan, review, and improve your field activities for medium to long-term projects.","content-type":"concept","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/maintain/index"},{"title":"Plan activities","description":"Create and manage plans to schedule activities, identify conflicts, and optimize work scope.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/maintain/guides/set_work_scope"},{"title":"Import activities into Maintain","sidebarTitle":"Import activities","description":"Learn how to import activities using the user interface (APM mode), Cognite Toolkit, or Transformations.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/maintain/guides/import_activities"}]},{"group":"External resources","pages":[{"title":"Industrial Data Science Library","url":"https://indsl.docs.cognite.com/","description":null,"href":"/cdf/indsl"}]}]},{"tab":"Data engineering","groups":[{"group":"Data engineering","pages":[{"title":"About data engineering","sidebarTitle":"Overview","audience":"data_engineering","description":"Model, integrate, transform, and consolidate data into structures that are suitable for building analytics solutions.","mode":"wide","content-type":"concept","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/data_engineering"},{"group":"Explore data","pages":[{"title":"Data explorer","description":"Browse and search through resource types to find the data you need, with drill-down into details and connected resources.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/exploration/data_explorer"},{"title":"Data catalog","description":"Search, explore, and manage data sets in a central and secure library of data assets.","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/exploration/data_catalog_concepts"},{"group":"Image and video data","pages":[{"title":"Image and video data","description":"Upload and manage images and videos containing essential metadata and visual information for optimizing operations.","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/exploration/images_videos"},{"title":"Explore image and video data","description":"Upload, enrich, and explore image and video data to gather insights for decision making and task optimization.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/exploration/images_videos_tasks"}]}]},{"group":"Data governance","pages":[{"title":"Data governance overview","sidebarTitle":"Overview","description":"Learn about data governance principles, data sets, and how to ensure data quality and integrity throughout the complete lifecycle of your data in Cognite Data Fusion (CDF).","content-type":"map","audience":"dataEngineer","mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/data_governance/overview_dg"},{"title":"About data governance","description":"Data governance is a set of principles and practices that ensure high quality through the complete lifecycle of your data and is a must for scalable digitalization in all industries.","audience":"dataEngineer","content-type":"concept","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/data_governance/index"},{"group":"Data sets","pages":[{"title":"About data sets","description":"Data sets let you document and track data lineage, ensure data integrity, and allow 3\u003csup>rd\u003c/sup> parties to write their insights to your Cognite Data Fusion (CDF) project securely.","audience":"dataEngineer","content-type":"concept","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/data_governance/concepts/datasets/index"},{"title":"Create data sets and add data","description":"Learn how to create data sets in Cognite Data Fusion, configure access control, and add data objects to track data lineage and ensure data integrity.","audience":"dataEngineer","content-type":"procedure","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/data_governance/guides/datasets/create_data_sets"},{"title":"Edit and explore data sets","description":"Learn how to edit data set information, explore data lineage, and manage data sets in Cognite Data Fusion to ensure data quality and governance.","audience":"dataEngineer","content-type":"procedure","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/data_governance/guides/datasets/edit_explore_data_sets"}]}]},{"group":"Data modeling","pages":[{"title":"About data modeling","sidebarTitle":"Overview","description":"Build expressive and scalable data models in Cognite Data Fusion (CDF) to create a structured knowledge graph of your industrial data, including assets, hierarchies, and equipment.","keywords":"asset, assets, asset hierarchy, CogniteAsset, data model, knowledge graph","content-type":"map","audience":"developer","experience-level":100,"mode":"wide","lifecycle":"use","article-type":"map","href":"/cdf/dm/index"},{"group":"Cognite data models","pages":[{"title":"Cognite data models","sidebarTitle":"Overview","description":"Learn about Cognite's out-of-the-box data models, including the core data model and process industry data model.","content-type":"concept","audience":"developer","experience-level":100,"unlisted":true,"mode":"wide","lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_reference/cognite_data_models"},{"title":"Core data model","description":"Explore Cognite's core data model with standardized building blocks for industrial data, including CogniteAsset, core features, and core concepts.","keywords":"asset, CogniteAsset, asset hierarchy, core data model","content-type":"reference","audience":"developer","experience-level":100,"toc_max_heading_level":4,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_reference/dm_core_data_model"},{"title":"Process industries data model","description":"Explore Cognite's process industries data model that extends the core data model for process industry requirements.","content-type":"reference","audience":"developer","experience-level":100,"toc_max_heading_level":4,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_reference/dm_process_industry_data_model"}]},{"group":"Data modeling concepts and features","pages":[{"title":"Data modeling concepts","sidebarTitle":"Overview","description":"Learn about the core concepts and features of the Data Modeling Service (DMS) including spaces, instances, containers, views, and property graphs.","content-type":"map","audience":"developer","experience-level":100,"mode":"wide","lifecycle":"use","article-type":"map","href":"/cdf/dm/dm_concepts/index"},{"title":"Property graph","description":"Understand how property graphs in CDF use nodes, edges, and properties to model complex industrial systems.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_concepts/dm_property_graph"},{"title":"Spaces, instances, direct relations","description":"Learn how to construct an industrial knowledge graph using spaces, instances, nodes, edges, and direct relations in CDF.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_concepts/dm_spaces_instances"},{"title":"Containers, views, polymorphism, data models","description":"Learn how to define schemas using containers, views, and data models to bring your own properties into the knowledge graph.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_concepts/dm_containers_views_datamodels"},{"title":"System schemas","description":"Learn about globally available system schemas prefixed with cdf_ that provide out-of-the-box containers, views, and data models.","content-type":"reference","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_concepts/dm_system_schemas"},{"title":"Ingestion features","description":"Learn how to ingest and remove instances in your graph using apply, patch, replace, and delete operations.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_concepts/dm_ingestion"},{"title":"Query features","description":"Learn how to query your industrial knowledge graph using filters, parameters, recursive edge traversal, and subscriptions to changes.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_concepts/dm_querying"},{"title":"Search features","description":"Learn how to search for text and property values in your knowledge graph using full-text queries, filters, and relevance ranking.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_concepts/dm_search"},{"title":"About smarter search results","sidebarTitle":"Smarter search results","description":"Learn about the smarter search results feature, which improves search for tag-like naming structures through advanced tokenization rules.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_concepts/dm_smarter_search_results"},{"title":"Aggregation features","description":"Learn how to summarize and analyze data using aggregation functions, grouping, and filters in the Data Modeling Service.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_concepts/dm_aggregate"},{"title":"Access control features","description":"Learn how to control access to graphs using spaces and access control lists (ACLs) in the Data Modeling Service.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_concepts/dm_access_control"},{"title":"Data modeling status for CDF projects","sidebarTitle":"Data modeling project status","description":"Learn about the DATA_MODELING_ONLY and HYBRID project statuses and how they affect capabilities and application behavior in Cognite Data Fusion (CDF).","content-type":"concept","audience":["administrator","dataEngineer"],"experience-level":200,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/dm/dm_concepts/dm_data_modeling_status"},{"title":"Schema and instance inspection","description":"Learn how to inspect schemas and instances to understand their structure and relationships in your data model.","content-type":"concept","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_concepts/dm_inspect"}]},{"group":"Records and streams","pages":[{"title":"About records and streams","sidebarTitle":"Overview","description":"Understand records, streams, and record views for high-performance storage of bulk structured data in the industrial knowledge graph, including when to use them and how record views separate storage from consumption.","content-type":"concept","audience":"dataEngineer","experience-level":200,"lifecycle":"investigate","article-type":"article","href":"/cdf/dm/records/concepts/records_and_streams"},{"title":"About choosing and sizing streams","sidebarTitle":"Choosing and sizing streams","description":"Decide whether records fit your workload, understand how stream limits shape sizing, pick a default template, and request additional capacity in records, storage, and retention in the industrial knowledge graph.","content-type":"concept","audience":"dataEngineer","experience-level":200,"lifecycle":"investigate","article-type":"article","href":"/cdf/dm/records/guides/choose_and_size_streams"},{"title":"Get started with Records","sidebarTitle":"Get started","description":"Learn Records core concepts and patterns through a hands-on tutorial. Follow along with a SCADA alarm management example that demonstrates schemas, streams, ingestion, querying, and stream-to-stream pipelines.","content-type":"tutorial","audience":"dataEngineer","experience-level":200,"lifecycle":"setup","article-type":"article","href":"/cdf/dm/records/guides/records_getting_started"},{"title":"Records aggregation reference","sidebarTitle":"Records aggregation","description":"Use aggregations to compute statistics, group data into buckets, and analyze trends across your records without retrieving individual items.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/records/guides/records_aggregations"}]},{"group":"The schema service (GraphQL)","pages":[{"title":"Using GraphQL with data modeling","sidebarTitle":"Overview","description":"Learn how to use GraphQL to query, mutate, and define data models in Cognite Data Fusion.","content-type":"map","audience":"developer","experience-level":100,"mode":"wide","lifecycle":"use","article-type":"map","href":"/cdf/dm/dm_graphql/index"},{"title":"Autogenerated GraphQL types","description":"Learn how CDF automatically generates GraphQL types for data models and how to use them for queries and mutations.","content-type":"reference","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_graphql/dm_graphql_types"},{"title":"GraphQL queries","description":"Learn how to query instances using GraphQL including list, get, search, and aggregate operations.","content-type":"reference","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_graphql/dm_graphql_querying"},{"title":"GraphQL mutations","description":"Learn how to create and update instances using GraphQL mutations including upsert and delete operations.","content-type":"reference","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_graphql/dm_graphql_mutations"},{"title":"Data modeling language extension for GraphQL","description":"Learn about the Data modeling language extension for GraphQL (DML) for managing data models and views.","content-type":"reference","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_graphql/dm_data_modeling_language"}]},{"group":"Examples and best practices","pages":[{"title":"Data modeling examples and best practices","sidebarTitle":"Overview","description":"Explore examples and best practices for working with data modeling in Cognite Data Fusion, from building hierarchies to optimizing performance.","content-type":"map","audience":"developer","experience-level":100,"mode":"wide","lifecycle":"use","article-type":"map","href":"/cdf/dm/dm_guides/index"},{"title":"Designing scalable data models","description":"Learn best practices for designing scalable data models in CDF, including layered architecture, design principles, performance optimization, security, and deployment.","content-type":"concept","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_guides/dm_designing_scalable_models"},{"title":"Building an asset hierarchy","description":"Learn how to build an asset hierarchy with the Cognite core data model and populate it using transformations.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_guides/dm_cdm_build_asset_hierarchy"},{"title":"Performance considerations","description":"Learn about key data modeling factors that impact performance when ingesting and querying data.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_guides/dm_performance_considerations"},{"title":"Debugging query performance","description":"Learn how to use debug notices to understand query execution and identify optimization opportunities for your data model queries.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_guides/dm_debug_query_performance"},{"title":"Handling latency variability in query APIs","description":"Learn why data modeling query APIs can have outlier response times and how to design SDKs and applications that remain reliable when occasional slow queries occur.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_guides/latency_variability"},{"title":"Optimizing data models for AI","description":"Learn how to model data to support natural language queries and enable Atlas AI agents to be reused across domains and workflows.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_guides/dm_best_practices_ai_search"},{"title":"Time series in data modeling","description":"Learn how to integrate time series with data modeling using CogniteTimeSeries and the Time Series API.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_guides/dm_integrate_with_time_series"},{"title":"Files in data modeling","description":"Learn how to use files with the core data model and integrate them with assets in Cognite Data Fusion.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_guides/dm_integrate_files"},{"title":"Extending the core data model via GraphQL","description":"Learn how to create custom data models that extend the Cognite core data model using the Data modeling language extension for GraphQL.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_guides/dm_extending_core_data_model"},{"title":"Delete nodes without associated container data","description":"Use a Python script to delete nodes without associated container data in your data model.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_guides/dm_clean_up_nodes_without_data"}]},{"title":"Limits and restrictions","sidebarTitle":"Limits and restrictions","description":"Complete reference for data modeling, records, and streams resource limits in your CDF project.","content-type":"reference","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dm/dm_reference/dm_limits_and_restrictions"}]},{"group":"Data workflows","pages":[{"title":"Data workflows overview","sidebarTitle":"Overview","description":"Explore guides and references for orchestrating interdependent processes and tasks in Cognite Data Fusion (CDF) with built-in automation, retry logic, and error handling.","content-type":"map","audience":"dataEngineer","mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","keywords":"workflow, workflows, data workflows, orchestration, process orchestration","href":"/cdf/data_workflows/overview"},{"title":"About Data workflows","description":"Orchestrate interdependent processes and tasks in Cognite Data Fusion (CDF) with built-in retry logic, error handling, and failure recovery.","content-type":"conceptual","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","keywords":"workflow, workflows, data workflows, orchestration, process orchestration","href":"/cdf/data_workflows/index"},{"title":"Tasks in data workflows","description":"Define and configure tasks that trigger transformations, simulations, functions, API requests, JSON mapping, and more in data workflows.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/data_workflows/task_types"},{"title":"Triggers for data workflows","description":"Automate workflow execution with schedule-based, data modeling, or records triggers.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/data_workflows/triggers"},{"title":"Use data workflows","description":"Create, run, and monitor data workflows using Cognite API or Cognite Python SDK. Use Data workflows in the CDF user interface to automate and manage workflow tasks and process runs.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/data_workflows/workflow_user_guide"},{"title":"Limits and restrictions","description":"Technical specifications and limits for data workflows service in CDF.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/data_workflows/limits_and_restrictions_workflows"}]},{"group":"Data integrations","pages":[{"title":"Data integration overview","sidebarTitle":"Overview","description":"Connect your industrial data sources to Cognite Data Fusion with extractors, connectors, and transformation tools to build efficient data pipelines.","content-type":"concept","audience":"dataEngineer","mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/integration/index"},{"title":"About data integrations","description":"Learn about the three main components of data pipelines in CDF: data integration, data transformation, and data contextualization.","content-type":"concept","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/concepts/about_data_pipelines"},{"title":"Set up on-premises data integration","description":"Best practices for setting up secure on-premises data integration services for Cognite Data Fusion (CDF), including user configuration, secrets management, and network security.","audience":"dataEngineer","content-type":"procedure","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/security"},{"title":"Setup and administration for Microsoft Entra ID","description":"Register and configure apps in Microsoft Entra ID for use with data integration services such as extractors and connectors.","audience":"dataEngineer","content-type":"procedure","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/admin_oidc"},{"group":"Connect data","pages":[{"title":"Cognite connectors overview","sidebarTitle":"Overview","description":"Explore prebuilt and custom connector solutions to integrate data between source systems and Cognite Data Fusion (CDF) with bidirectional synchronization capabilities.","content-type":"map","audience":"data_engineering","mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/integration/concepts/connections/get_started"},{"title":"About data integration with connectors","description":"Learn how connectors enable bidirectional data integration between source systems and Cognite Data Fusion (CDF) with prebuilt Cognite connectors or custom solutions.","content-type":"conceptual","pagination_next":null,"pagination_prev":null,"audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/concepts/connections/about_data_integration_with_ connectors"},{"group":"Integrate simulators","pages":[{"title":"About simulator integrations","description":"Set up simulator integrations to connect first-principle simulation tools and CDF for real-time optimization, predictive maintenance, and digital twin development.","content-type":"conceptual","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/integration/guides/simulators/index"},{"title":"Simulators API","description":"Learn about the Simulators API resources for managing simulation operations, from model definition to results analysis in Cognite Data Fusion (CDF).","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/simulators/simulator_api"},{"title":"Configure simulator connectors","description":"Learn how to set up and configure Windows-based simulator connectors to enable communication between simulation tools and Cognite Data Fusion (CDF).","content-type":"procedure","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/integration/guides/simulators/connectors/index"},{"title":"Configure simulation routines","description":"Learn how to configure simulation routines with scheduling, data preprocessing, input/output mapping, and execution steps for running simulations.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/simulators/simulator_routines"},{"title":"Run simulations","description":"Learn how to trigger simulation runs manually, programmatically via API, or through scheduled execution in the simulation routine configuration.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/simulators/simulator_trigger"},{"title":"Data sampling and validation for time series input","description":"Learn how data sampling and validation ensure simulation runs with reliable input data through time concepts, validation methods, and best practices.","content-type":"conceptual","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/simulators/about_data_sampling"},{"title":"Troubleshooting","description":"Find solutions to common simulator integration issues including scheduling, data validation, performance, and API rate limiting.","content-type":"troubleshooting","audience":"dataEngineer","experience-level":100,"lifecycle":"support","article-type":"article","href":"/cdf/integration/guides/simulators/troubleshooting"},{"group":"Connectors","pages":[{"group":"PROSPER","pages":[{"title":"Setup","description":"Learn how to set up and configure the PROSPER connector Windows service and connect to the PROSPER simulator.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/simulators/connectors/prosper/prosper_setup"},{"title":"System requirements","description":"Review hardware, software, and network requirements for installing the PROSPER simulator connector on physical or virtual machines.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/simulators/connectors/prosper/prosper_server_requirements"},{"title":"Configuration settings","description":"Learn how to configure the PROSPER connector with YAML parameters for automation and OpenServer connection settings.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/simulators/connectors/prosper/prosper_configuration"},{"title":"Troubleshooting","description":"Find solutions to common PROSPER connector issues including authentication errors, license problems, and file read failures.","content-type":"troubleshooting","audience":"dataEngineer","experience-level":200,"lifecycle":"support","article-type":"article","href":"/cdf/integration/guides/simulators/connectors/prosper/prosper_troubleshooting"},{"title":"Unit conversion","description":"Learn how the PROSPER connector handles unit conversion with supported quantities, units, and conversion factors.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/simulators/connectors/prosper/prosper_units"}]},{"group":"GAP","pages":[{"title":"Setup","description":"Learn how to set up and configure the GAP connector Windows service, including connection modes and model management.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/simulators/connectors/gap/gap_setup"},{"title":"System requirements","description":"Review hardware, software, and network requirements for installing the GAP simulator connector on physical or virtual machines.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/simulators/connectors/gap/gap_server_requirements"},{"title":"Configuration settings","description":"Learn how to configure the GAP connector with YAML parameters for automation and OpenServer connection settings.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/simulators/connectors/gap/gap_configuration"},{"title":"Parse GAP model revisions","description":"Learn how the GAP connector extracts information models from simulator model revisions including flowsheet hierarchy, equipment properties, and connections.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/simulators/connectors/gap/gap_model_parsing"},{"title":"Troubleshooting","description":"Find solutions to common GAP connector issues including authentication errors, license problems, and file read failures.","content-type":"troubleshooting","audience":"dataEngineer","experience-level":200,"lifecycle":"support","article-type":"article","href":"/cdf/integration/guides/simulators/connectors/gap/gap_troubleshooting"},{"title":"Unit conversion","description":"Learn how the GAP connector handles unit conversion with supported quantities, units, and conversion factors.","content-type":"reference","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/simulators/connectors/gap/gap_units"}]}]}]},{"group":"PostgreSQL gateway","pages":[{"title":"About the PostgreSQL gateway","description":"Learn about the PostgreSQL gateway and how to ingest data into Cognite Data Fusion (CDF) from ETL tools.","content-type":"concept","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/interfaces/postgres_gateway/postgres_gateway_basics"},{"title":"Setup and administration for PostgreSQL gateway 2.0","description":"Set up the Cognite PostgreSQL gateway to ingest data into CDF from ETL tools using Microsoft Entra ID authentication.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/interfaces/postgres_gateway"},{"title":"Use Azure Data Factory with PostgreSQL gateway","description":"Create data pipelines in Azure Data Factory to ingest data into Cognite Data Fusion (CDF) through the PostgreSQL gateway.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/interfaces/postgres_gateway/setup_data_factory"},{"title":"Ingest data into CDF RAW","description":"Use the PostgreSQL gateway to ingest data from ETL tools into CDF RAW tables.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/interfaces/postgres_gateway/ingest_into_raw"}]},{"group":"SAP writeback","pages":[{"title":"SAP writeback service","description":"Learn about the SAP writeback service, including CogniteFile attachment references for data modeling projects.","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/interfaces/sap_writeback"},{"title":"Set up the SAP writeback service","description":"Step-by-step guide to set up the SAP writeback service and send notification and attachment requests to SAP S/4HANA from Cognite Data Fusion (CDF).","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/interfaces/sap_writeback_setup"}]}]},{"group":"Extract data","pages":[{"title":"Cognite extractors overview","sidebarTitle":"Overview","description":"Explore prebuilt extractors to stream and batch extract data from industrial and enterprise systems into Cognite Data Fusion (CDF).","content-type":"map","audience":"data_engineering","mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/integration/concepts/extraction/get_started"},{"title":"About data extraction","description":"Understand how extractors connect to source systems and push data in its **original format** to Cognite Data Fusion using prebuilt extractors or custom solutions with Python and .NET utilities.","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/integration/concepts/extraction/index"},{"title":"Set up extraction pipelines with remote configuration files","description":"Configure extractors remotely using cloud-stored configuration files with GitHub Actions or the Cognite API.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/interfaces/configure_integrations"},{"title":"Configure SSL certificates and proxy settings for extractors","description":"Step-by-step guide to configure self-signed certificates, mTLS, and corporate proxy TLS interception for .NET and Python extractors.","content-type":"procedure","audience":["dataEngineer","administrator"],"experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/ssl_certificates_and_proxies"},{"group":"Integrations","pages":[{"title":"About Integrations","description":"Learn about Integrations in Cognite Data Fusion (CDF) for setting up and monitoring on-premises extractors.","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/interfaces/about_unified_integrations"},{"title":"Set up on-premises integrations","description":"Create on-premises integrations in Cognite Data Fusion (CDF), install the extractor, and complete the connection.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"setup","article-type":"article","href":"/cdf/integration/guides/interfaces/set_up_on_premises_integration"},{"title":"Configuration settings","description":"Complete reference for the connection and application configuration extractors use to report to Integrations in Cognite Data Fusion (CDF).","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/interfaces/configuration_settings"},{"title":"Monitor integrations","description":"Monitor on-premises integrations in Cognite Data Fusion (CDF) using tasks, Task log, Task run details, and notifications.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/interfaces/monitor_unified_integrations"}]},{"group":"Extraction pipelines","pages":[{"title":"About extraction pipelines","description":"Monitor data flow in Cognite Data Fusion (CDF) with extraction pipelines to catch failures and ensure reliable data integration.","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/interfaces/about_integrations"},{"title":"Set up extraction pipelines","description":"Create and configure extraction pipelines to monitor data integration into Cognite Data Fusion (CDF).","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/interfaces/add_integrations"},{"title":"Monitor extraction pipelines","description":"Monitor extraction pipelines to ensure reliable data integration and quickly identify and troubleshoot failures.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/interfaces/monitor_integrations"}]},{"group":"Hosted extractors","pages":[{"title":"Hosted extractors overview","description":"Learn about hosted extractors in Cognite Data Fusion (CDF) for live low latency data streams, including sources, jobs, destinations, mappings, and API-based email alerts when job status changes.","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/hosted_extractors"},{"title":"Message formats","description":"Complete reference for built-in and custom message payload formats supported by Cognite hosted extractors, including simple values, Cognite JSON, Sparkplug B, and Rockwell FactoryTalk.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/hosted_extractors/hosted_extractors_mappings"},{"title":"Custom message formats","description":"Learn how to define custom message formats as mappings from source data to Cognite Data Fusion (CDF) data types, with examples for data points, events, and nested structures.","content-type":"tutorial","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/hosted_extractors/hosted_extractors_custom_mappings"},{"title":"Mapping concepts","description":"Learn about the hosted extractor mapping language for transforming JSON structures with functional expressions similar to JavaScript.","content-type":"concept","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/hosted_extractors/kuiper_concepts"},{"title":"Functions","description":"Complete reference of all built-in functions in Kuiper, the hosted extractor mapping language, for data transformation and manipulation.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/hosted_extractors/built_in_functions"},{"title":"Event Hub extractor","description":"Learn how to use the Cognite Event Hub extractor to connect to Azure Event Hub and extract data using the AMQP protocol.Cognite hosts the Event Hub extractor, so you don't have to download or install anything.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/eventhub"},{"title":"Kafka extractor","description":"Learn how to use the Cognite Kafka extractor to extract data from Apache Kafka brokers and topics. Cognite hosts the Kafka extractor, so you don't have to download or install anything.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/kafka"},{"title":"MQTT extractor","description":"Learn how to use the Cognite MQTT extractor to bring MQTT data into Cognite Data Fusion (CDF), including Quality of Service (QoS), broker persistence, and verifying delivery with hosted extractor job metrics.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/mqtt"},{"title":"REST extractor","description":"Learn how to use the Cognite REST extractor to read data from REST APIs on a fixed schedule with custom mappings and pagination.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/rest"},{"title":"MQTT broker","description":"Learn how to publish data directly to a Cognite-managed MQTT broker and ingest it into Cognite Data Fusion (CDF).","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/mqtt_broker"}]},{"group":"On-premises extractors","pages":[{"group":"DB extractor","pages":[{"title":"About the Cognite DB extractor","description":"Connect to databases and load data into Cognite Data Fusion (CDF) with the general-purpose DB extractor.","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/db"},{"title":"Server requirements","description":"Hardware, software, and network requirements for running the Cognite DB extractor.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/db/db_server_requirements"},{"title":"Set up the DB extractor","description":"Install and configure the Cognite DB extractor to connect to databases and load data into Cognite Data Fusion (CDF).","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/db/db_setup"},{"title":"Ingest data from Snowflake with OAuth","description":"Configure the DB extractor to ingest data from Snowflake using OAuth 2.0 authentication with Microsoft Entra ID.","content-type":"procedure","audience":"dataEngineer","experience-level":300,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/db/db_snowflake_oauth_setup"},{"title":"Configuration settings","description":"Complete reference for configuring the Cognite DB extractor, including authentication, queries, and destination settings.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/configuration/db"},{"title":"Metrics","description":"Performance metrics available from the DB extractor for remote monitoring and debugging.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/db/db_metrics"},{"title":"Troubleshooting","description":"Common issues and solutions for the Cognite DB extractor.","content-type":"troubleshooting","audience":"dataEngineer","experience-level":200,"lifecycle":"support","article-type":"article","href":"/cdf/integration/guides/extraction/db/db_troubleshooting"}]},{"group":"EDM extractor","pages":[{"title":"About the Cognite EDM extractor","description":"Extract data from Landmark Engineers Data Model (EDM) server to the Cognite Data Fusion (CDF) staging area through OData protocol from DecisionSpace Integration Server (DSIS).","content-type":"conceptual","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/edm"},{"title":"Server requirements","description":"Hardware, software, and network requirements for running the Cognite EDM extractor on physical servers, virtual machines, or cloud environments.","content-type":"reference","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/edm/edm_server_requirements"},{"title":"Set up the EDM extractor","description":"Install and configure the Cognite EDM extractor as a Java .jar file or Docker container to extract data from Landmark EDM to CDF.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/edm/edm_setup"},{"title":"Configuration settings","description":"Configure the EDM extractor with YAML file settings for Cognite, logging, EDM connection, and entity extraction parameters.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/edm/edm_configuration"},{"title":"EDM data entities","description":"Comprehensive reference of supported EDM entities for the Cognite EDM extractor, including incremental and non-incremental entity types with their extraction specifications.","content-type":"reference","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/edm/edm_entities"}]},{"group":"File extractor","pages":[{"title":"About the Cognite File extractor","description":"Learn about the Cognite File extractor and how to connect it to local file systems, cloud storage, and network sharing protocols to upload files into Cognite Data Fusion (CDF).","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/file"},{"title":"Server requirements","description":"Hardware, software, and network requirements for running the Cognite File extractor.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/file/file_requirements"},{"title":"Set up the Cognite File extractor","description":"Install and configure the Cognite File extractor on Windows and Linux systems.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/file/file_setup"},{"title":"Configuration settings","description":"Configuration reference for the Cognite File extractor with all available parameters and options.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/configuration/file-extractor"},{"title":"Connect to SharePoint Online","description":"Configure the Cognite File extractor to connect to SharePoint Online sources.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/file/file_sharepoint_setup"}]},{"group":"OPC classic extractor","pages":[{"title":"About the Cognite OPC Classic extractor","description":"Read time series and asset information via OPC DA and HDA protocols and stream datapoints to Cognite Data Fusion (CDF).","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/opc_classic"},{"title":"Hardware and server requirements","description":"Hardware and server requirements for the OPC Classic extractor.","content-type":"reference","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/opc_classic/opc_classic_requirements"},{"title":"Set up the OPC Classic extractor","description":"Install and configure the OPC Classic extractor on Windows with support for DCOM connections.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/opc_classic/opc_classic_setup"},{"title":"Command-line arguments","description":"Available command-line arguments for the OPC Classic extractor.","content-type":"reference","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/opc_classic/opc_classic_cli"},{"title":"Configuration settings","description":"Configure the OPC Classic extractor using YAML format with settings for source, subscriptions, and CDF connection.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/opc_classic/opc_classic_configuration"}]},{"group":"OPC UA extractor","pages":[{"title":"About the Cognite OPC UA extractor","description":"Learn about the Cognite OPC UA extractor that reads time series, events, and asset information via the OPC UA protocol and streams data and events to time series in Cognite Data Fusion (CDF).","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/opc_ua"},{"title":"Hardware requirements","description":"Memory, CPU, and storage requirements for running the OPC UA extractor based on server size and configuration.","content-type":"reference","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/opc_ua/opc_ua_hw_requirements"},{"title":"Server requirements","description":"Server requirements for running the OPC UA extractor with different features, including session management, variables, history, arrays, events, and auditing.","content-type":"reference","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/opc_ua/opc_ua_server_requirements"},{"title":"Set up the OPC UA extractor","description":"Instructions for installing and configuring the Cognite OPC UA extractor as a Windows executable, Windows service, Linux service, or Docker container.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/opc_ua/opc_ua_setup"},{"title":"Extracting state time series with the OPC UA extractor","description":"Enable opt-in state time series ingestion from OPC UA multi-state and enumeration variables in data modeling projects.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"setup","article-type":"article","href":"/cdf/integration/guides/extraction/opc_ua/opc_ua_state_timeseries"},{"title":"Command-line arguments","description":"Reference guide for all available command-line arguments when running the OPC UA extractor, including options for configuration, authentication, and tool mode.","content-type":"reference","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/opc_ua/opc_ua_cli"},{"title":"Configuration settings","description":"Complete reference for configuring the Cognite OPC UA extractor version 2.40.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/opc_ua/opcua"},{"group":"Other versions","boost":0.25,"expanded":false,"pages":[{"title":"Configuration settings","sidebarTitle":"3.0","description":"OPC UA extractor configuration reference for version 3.0.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"deprecated","article-type":"article","canonical":"https://docs.cognite.com/cdf/integration/guides/extraction/opc_ua/opcua","href":"/cdf/integration/guides/extraction/opc_ua/3-0"},{"title":"Configuration settings","sidebarTitle":"2.39","description":"OPC UA extractor configuration reference for version 2.39.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"deprecated","article-type":"article","canonical":"https://docs.cognite.com/cdf/integration/guides/extraction/opc_ua/opcua","href":"/cdf/integration/guides/extraction/opc_ua/2-39"},{"title":"Configuration settings","sidebarTitle":"2.38","description":"OPC UA extractor configuration reference for version 2.38.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"deprecated","article-type":"article","canonical":"https://docs.cognite.com/cdf/integration/guides/extraction/opc_ua/opcua","href":"/cdf/integration/guides/extraction/opc_ua/2-38"},{"title":"Configuration settings","sidebarTitle":"2.37","description":"OPC UA extractor configuration reference for version 2.37.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"deprecated","article-type":"article","canonical":"https://docs.cognite.com/cdf/integration/guides/extraction/opc_ua/opcua","href":"/cdf/integration/guides/extraction/opc_ua/2-37"},{"title":"Configuration settings","sidebarTitle":"2.36","description":"OPC UA extractor configuration reference for version 2.36.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"deprecated","article-type":"article","canonical":"https://docs.cognite.com/cdf/integration/guides/extraction/opc_ua/opcua","href":"/cdf/integration/guides/extraction/opc_ua/2-36"},{"title":"Configuration settings","sidebarTitle":"2.35","description":"OPC UA extractor configuration reference for version 2.35.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"deprecated","article-type":"article","canonical":"https://docs.cognite.com/cdf/integration/guides/extraction/opc_ua/opcua","href":"/cdf/integration/guides/extraction/opc_ua/2-35"},{"title":"Configuration settings","sidebarTitle":"2.34","description":"OPC UA extractor configuration reference for version 2.34.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"deprecated","article-type":"article","canonical":"https://docs.cognite.com/cdf/integration/guides/extraction/opc_ua/opcua","href":"/cdf/integration/guides/extraction/opc_ua/2-34"},{"title":"Configuration settings","sidebarTitle":"2.33","description":"OPC UA extractor configuration reference for version 2.33.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"deprecated","article-type":"article","canonical":"https://docs.cognite.com/cdf/integration/guides/extraction/opc_ua/opcua","href":"/cdf/integration/guides/extraction/opc_ua/2-33"},{"title":"Configuration settings","sidebarTitle":"2.32","description":"OPC UA extractor configuration reference for version 2.32.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"deprecated","article-type":"article","canonical":"https://docs.cognite.com/cdf/integration/guides/extraction/opc_ua/opcua","href":"/cdf/integration/guides/extraction/opc_ua/2-32"}]},{"title":"Metrics","description":"Complete reference of available Prometheus metrics from the OPC UA extractor, including source system metrics, extractor metrics, CDF metrics, InfluxDB metrics, MQTT metrics, history metrics, and native Prometheus metrics.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/opc_ua/opc_ua_metrics"},{"title":"Troubleshoot the OPC UA extractor","sidebarTitle":"Troubleshooting","description":"Solutions and instructions for troubleshooting common problems when setting up the OPC UA extractor to push data to Cognite Data Fusion (CDF).","content-type":"troubleshooting","audience":"dataEngineer","experience-level":100,"lifecycle":"support","article-type":"article","href":"/cdf/integration/guides/extraction/opc_ua/opc_ua_troubleshooting"}]},{"group":"OSDU extractor","pages":[{"title":"About the Cognite OSDU extractor","description":"Connect to the OSDU Data Platform and ingest data into Cognite Data Fusion (CDF).","content-type":"conceptual","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/osdu"},{"title":"Server requirements","description":"Hardware and software requirements for running the OSDU extractor.","content-type":"reference","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/osdu/osdu_requirements"},{"title":"Set up the OSDU extractor","description":"Install and configure the OSDU extractor as a Windows executable, Windows service, or Docker container.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/osdu/osdu_setup"},{"title":"Configuration settings","description":"Configuration settings and parameters for the OSDU extractor YAML file.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/osdu/osdu_configuration"}]},{"group":"PI extractor","pages":[{"title":"About the Cognite PI extractor","description":"Connect to OSISoft PI Data Archive and stream time series data to Cognite Data Fusion (CDF) in real-time with historical backfill support","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/pi"},{"title":"Server requirements","description":"Hardware, software, and network requirements for installing and running the Cognite PI extractor.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/pi/pi_server_requirements"},{"title":"Set up the PI extractor","description":"Install and configure the Cognite PI extractor on Windows to stream time series data from OSISoft PI to Cognite Data Fusion (CDF).","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/pi/pi_setup"},{"title":"Configuration settings","description":"Complete reference for configuring the Cognite PI extractor version 4.23.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/pi/pi"},{"group":"Other versions","boost":0.25,"expanded":false,"pages":[{"title":"Configuration settings","sidebarTitle":"4.22","description":"PI extractor configuration reference for version 4.22.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"deprecated","article-type":"article","canonical":"https://docs.cognite.com/cdf/integration/guides/extraction/pi/pi","href":"/cdf/integration/guides/extraction/pi/4-22"},{"title":"Configuration settings","sidebarTitle":"4.21","description":"PI extractor configuration reference for version 4.21.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"deprecated","article-type":"article","canonical":"https://docs.cognite.com/cdf/integration/guides/extraction/pi/pi","href":"/cdf/integration/guides/extraction/pi/4-21"},{"title":"Configuration settings","sidebarTitle":"4.20","description":"PI extractor configuration reference for version 4.20.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"deprecated","article-type":"article","canonical":"https://docs.cognite.com/cdf/integration/guides/extraction/pi/pi","href":"/cdf/integration/guides/extraction/pi/4-20"}]},{"title":"Extractor metrics","description":"Monitor and debug the Cognite PI extractor using Prometheus metrics for performance, connection status, and data processing.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/pi/pi_metrics"},{"title":"Troubleshooting","description":"Troubleshoot common issues with the Cognite PI extractor including authentication errors, connection problems, and data loss incidents.","content-type":"troubleshooting","audience":"dataEngineer","experience-level":200,"lifecycle":"support","article-type":"article","href":"/cdf/integration/guides/extraction/pi/pi_troubleshooting"}]},{"group":"PI AF extractor","pages":[{"title":"About the Cognite PI AF extractor","description":"Learn about the Cognite PI Asset Framework extractor and how it connects to OSIsoft PI AF to extract elements and their attributes and unit-of-measure classes into the CDF staging area (RAW).","content-type":"conceptual","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/pi_af"},{"title":"Server requirements","description":"Hardware, software, and network requirements for installing and running the Cognite PI AF extractor.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/pi_af/pi_af_server_requirements"},{"title":"Set up the PI AF extractor","description":"Install, configure, run, upgrade, and uninstall the Cognite PI AF extractor on Windows.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/pi_af/pi_af_setup"},{"title":"Configuration settings","description":"Complete reference for configuring the PI AF extractor including connection settings, extraction options, and destination configuration.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/configuration/piaf"}]},{"group":"PI replace utility","pages":[{"title":"About the Cognite PI replace utility","description":"Re-ingest time series data to CDF when data points are invalid, incorrect, or missing, and recover from data loss and reconnection incidents.","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/pi_replace"},{"title":"Set up the PI replace utility","description":"Learn how to install and configure the Cognite PI replace utility to correct data loss and reconnection incidents in Cognite Data Fusion (CDF).","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/pi_replace/pi_replace_setup"},{"title":"Configuration settings","description":"Complete reference for configuring the PI replace utility including YAML settings for replace operations, data quality checks, events, and state storage.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/pi_replace/pi_replace_configuration"},{"title":"Integrate with the Cognite PI extractor","description":"Configure the PI extractor and PI replace utility to automatically detect and correct data loss and reconnection incidents using Cognite Data Fusion (CDF) events.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/pi_replace/pi_replace_integration"},{"title":"Extractor logs, reports and metrics","description":"Monitor PI replace utility performance with logger output, CSV reports, Prometheus metrics, and data quality checks for Cognite Data Fusion (CDF) data points.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/pi_replace/pi_replace_metrics"}]},{"group":"SAP extractor","pages":[{"title":"About the Cognite SAP extractor","description":"Learn how the Cognite SAP extractor connects to SAP systems and ingests data into Cognite Data Fusion (CDF).","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/sap"},{"title":"Server requirements","description":"Hardware and software requirements for installing the SAP extractor. You can install the extractor on a physical server, on a virtual machine on-premises, or in the cloud.","content-type":"reference","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/sap/sap_server_requirements"},{"title":"Set up the SAP extractor","description":"Learn how to set up and configure the SAP extractor to connect to SAP endpoints and extract data to CDF.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/sap/sap_setup"},{"title":"Extractor metrics","description":"Available Prometheus metrics for monitoring and debugging the SAP extractor.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/sap/sap_metrics"},{"title":"Configuration settings","description":"Configure the SAP extractor with YAML files to connect to SAP instances and extract data to CDF.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/configuration/sap"},{"title":"Troubleshooting","description":"Find steps to troubleshoot common issues while running the SAP extractor.","content-type":"troubleshooting","audience":"dataEngineer","experience-level":200,"lifecycle":"support","article-type":"article","href":"/cdf/integration/guides/extraction/sap/sap_troubleshooting"}]},{"group":"Studio for Petrel extractor","pages":[{"title":"About Cognite Studio for Petrel extractor","description":"Learn about the Cognite Studio for Petrel extractor that streams Petrel object data to Cognite Data Fusion (CDF) as protobuf objects.","content-type":"conceptual","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/petrel_studio"},{"title":"Server requirements","description":"Hardware, software, and network requirements for installing the Studio for Petrel extractor.","content-type":"reference","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/petrel_studio/petrel_studio_requirements"},{"title":"Set up the Studio for Petrel extractor","description":"Install and configure the Cognite Studio for Petrel extractor as a Windows service.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/petrel_studio/petrel_studio_setup"},{"title":"Configuration settings","description":"Configuration file settings for the Studio for Petrel extractor including authentication, caching, logging, and extraction parameters.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/petrel_studio/petrel_studio_configuration"},{"title":"Troubleshooting","description":"Resolve errors and unexpected behavior with the Cognite Studio for Petrel extractor.","content-type":"troubleshooting","audience":"dataEngineer","experience-level":100,"lifecycle":"support","article-type":"article","href":"/cdf/integration/guides/extraction/petrel_studio/petrel_studio_troubleshooting"}]},{"group":"WITSML extractor","pages":[{"title":"About Cognite WITSML extractor","description":"Overview of the Cognite WITSML extractor that ingests wellsite data using SOAP and ETP protocols into CDF.","content-type":"conceptual","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/witsml"},{"title":"Server requirements","description":"Hardware, software, and network requirements for installing the WITSML extractor.","content-type":"reference","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/witsml/witsml_requirements"},{"title":"Set up the WITSML extractor","description":"Learn how to install, configure, and deploy the Cognite WITSML extractor as a Docker container.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/witsml/witsml_setup"},{"title":"Extractor metrics","description":"Performance metrics available from the WITSML extractor for remote monitoring and debugging.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/witsml/witsml_metrics"},{"title":"Configuration settings","description":"Configuration parameters and settings for the WITSML extractor to connect to WITSML servers and ingest data into Cognite Data Fusion (CDF).","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/witsml/witsml_configuration"},{"title":"WITSML data objects","description":"Overview of WITSML server 1.4.1.1 data objects and their corresponding CDF resource types.","content-type":"reference","audience":"data_engineering","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/witsml/witsml_guide"}]}]}]},{"group":"3D","pages":[{"title":"About 3D models in CDF","sidebarTitle":"Overview","description":"Learn how to upload and contextualize 3D models and create scenes in Cognite Data Fusion.","content-type":"map","audience":"dataEngineer","mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/3d/index"},{"title":"About 3D models","description":"Upload and optimize large 3D models in Cognite Data Fusion (CDF) to better visualize and contextualize data.","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/3d/guides/3dmodels_intro"},{"group":"Upload","pages":[{"title":"Upload 3D models in the browser","description":"Learn to upload 3D models and revisions to Cognite Data Fusion (CDF) using the web interface.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/3d/guides/3dmodels_upload"},{"title":"Upload 3D models with file extractor","description":"From **Upload 3D models** in Cognite Data Fusion (CDF), you can upload 3D models and revisions to CDF without writing any code.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/3d/guides/3d_file_extractor_guide"},{"title":"Upload 360° images","description":"You can upload 360° images to Cognite Data Fusion (CDF) and display them in various applications with the Reveal 3D viewer.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/3d/guides/360images_upload"}]},{"group":"Configure","pages":[{"title":"Edit 3D models and revisions","description":"In Cognite Data Fusion (CDF), you can delete 3D models, and publish, unpublish, and delete revisions.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/3d/guides/3dmodels_edit"},{"title":"Configure a scene","description":"Create and configure 3D scenes to view all related 3D data for a physical location in a unified view.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/3d/guides/scene"},{"title":"Set thresholds","description":"Create rule-based color overlays in 3D models to visualize threshold conditions for assets and time series data.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/3d/guides/rule_based_coloring"},{"title":"Configure CDF 3D Visual in Power BI","description":"Display and interact with 3D CAD models from Cognite Data Fusion (CDF) directly in Power BI reports.","content-type":"procedure","audience":"business_user","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/3d/guides/3dmodels_PowerBI"}]},{"group":"Contextualize","pages":[{"title":"Contextualize CAD models","description":"With the manual contextualization of CAD models, you can map assets to 3D objects, improving the assets discoverability when using search.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/3d/guides/3dmodels_contextualize"},{"title":"Contextualize point clouds","description":"Contextualize point clouds manually or using automated segmentation and object detection in CDF.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/3d/guides/pointcloud_contextualize"},{"title":"Contextualize 360° images","description":"Manually contextualize 360° images by using a single 360° image file or leveraging the 360° image contextualization within a scene.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/3d/guides/360images_contextualize"}]},{"title":"CDF color table for Aveva RVM files","description":"Reference tables for standard and custom color indices used when importing RVM files to CDF.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/3d/rvm-colors"}]}]},{"group":"Staging","pages":[{"title":"Staging","description":"Stream or batch-extract data into the Cognite Data Fusion (CDF) staging area (RAW) and use the RAW explorer to profile and view data quality.","audience":"dataEngineer","content-type":"concept","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/extraction/raw_explorer"}]},{"group":"Transform data","pages":[{"title":"Transformation overview","sidebarTitle":"Overview","description":"Transform, reshape, enrich, and analyze data quality using built-in transformation tools to move data from source systems into Cognite Data Fusion (CDF) data models.","content-type":"map","audience":"dataEngineer","mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/integration/concepts/transformation/overview"},{"title":"About transformations","description":"Learn about data transformation in Cognite Data Fusion (CDF) and how to use built-in transformation tools to reshape, enrich, contextualize, and analyze data quality in your data integration workflow.","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/integration/concepts/transformation/index"},{"title":"Setup and administration","description":"Configure OpenID Connect and Microsoft Entra ID to manage access to CDF Transformations using your organization's identity provider.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/transformation/admin_oidc"},{"title":"Transform data","description":"Move or enrich data from source systems, between data models, or from the staging area into Cognite Data Fusion (CDF) by transforming data into the Cognite Core Data Model or user-defined data models.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/transformation/transformations"},{"group":"Fabric OneLake","pages":[{"title":"About Fabric OneLake in Transformations","description":"Learn how Transformations read Microsoft Fabric OneLake Delta tables without staging a full copy in CDF RAW.","content-type":"concept","audience":["dataEngineer","solutionArchitect"],"experience-level":100,"lifecycle":"investigate","article-type":"article","href":"/cdf/integration/concepts/transformation/about_fabric_onelake_transformations"},{"title":"Set up a Fabric OneLake integration as an external data source","sidebarTitle":"Set up Fabric OneLake source","description":"Register Microsoft Fabric OneLake credentials and location so Transformations can read Delta tables with ext_onelake.","content-type":"procedure","audience":["dataEngineer","administrator"],"experience-level":200,"lifecycle":"setup","article-type":"article","href":"/cdf/integration/guides/transformation/set_up_fabric_onelake_connection"},{"title":"Read Fabric OneLake data in transformations","sidebarTitle":"Read Fabric OneLake data","description":"Query Fabric OneLake Delta tables with ext_onelake in Transformations SQL and write results to CDF destinations.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/transformation/read_fabric_onelake"},{"title":"Monitor Fabric OneLake transformations","sidebarTitle":"Monitor Fabric OneLake","description":"Check OneLake rows and bytes read for Transformations jobs that use ext_onelake.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/transformation/monitor_fabric_onelake"},{"title":"Troubleshoot Fabric OneLake in Transformations","sidebarTitle":"Troubleshoot Fabric OneLake","description":"Resolve registration, SQL, and job errors when Transformations read Fabric OneLake with ext_onelake.","content-type":"troubleshooting","audience":"dataEngineer","experience-level":200,"lifecycle":"support","article-type":"article","href":"/cdf/integration/guides/transformation/troubleshoot_fabric_onelake"}]},{"group":"Examples and best practices","pages":[{"title":"Transformation design patterns","description":"Best practices for designing Cognite Data Fusion (CDF) transformations with orchestration, scope, and data modeling targets.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/transformation/best_practices"},{"title":"Operations and performance","description":"Best practices for operating transformations with incremental processing, RAW usage, and SQL performance.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/transformation/operations_and_performance"},{"title":"SQL patterns and best practices","description":"Patterns for writing efficient transformation SQL with predictable performance.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/transformation/sql_patterns"},{"title":"SQL syntax and functions","description":"Reference for SQL syntax, built-in Spark SQL functions, and Cognite custom functions for transformations.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/transformation/write_sql_queries"}]},{"title":"Troubleshooting transformations","description":"Resolve common transformation execution, performance, and monitoring issues in CDF.","content-type":"troubleshooting","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/transformation/troubleshooting"}]},{"group":"Contextualize data","pages":[{"title":"Contextualization overview","sidebarTitle":"Overview","description":"Route to contextualization foundations, matching and diagram tools in Cognite Data Fusion (CDF), and Cognite Toolkit deployment packs for production pipelines.","content-type":"map","audience":"dataEngineer","mode":"wide","experience-level":100,"lifecycle":"investigate","article-type":"map","href":"/cdf/integration/concepts/contextualization/index"},{"title":"About contextualization","description":"Learn about contextualization in Cognite Data Fusion: assets (functional locations), enterprise-layer prerequisites, and aliases, before matching and annotation can work.","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"investigate","article-type":"article","href":"/cdf/integration/concepts/contextualization/overview"},{"group":"Foundations","pages":[{"title":"Prepare aliases and match fields","description":"Step-by-step guide to populate names and aliases on match targets before entity matching tokenizes strings, applies blocking, or diagram annotation resolves tags.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"setup","article-type":"article","href":"/cdf/integration/guides/contextualization/prepare_aliases"},{"title":"Operate matching and annotation","description":"Step-by-step guide to scope, run incremental reruns, and maintain entity matching and diagram annotation pipelines without losing SME-confirmed links.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/contextualization/operate_pipelines"},{"title":"Understanding contextualization quality","sidebarTitle":"Quality","description":"Understand contextualization quality and how to interpret in-scope coverage, orphans, and confidence when low scores point to missing graph data instead of a weak model.","content-type":"concept","audience":"dataEngineer","experience-level":200,"lifecycle":"transform","article-type":"article","href":"/cdf/integration/concepts/contextualization/quality"}]},{"group":"Diagram parsing","pages":[{"group":"Diagram parsing for data modeling","pages":[{"title":"About diagram parsing for data modeling","description":"Extract information from static engineering diagrams to create interactive diagrams that you can explore in Cognite Data Fusion (CDF).","content-type":"concept","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/contextualization/diagram_parsing"},{"title":"Parse diagrams","description":"Step-by-step guide to extract information from engineering diagrams by detecting and mapping assets and files in Cognite Data Fusion (CDF).","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/contextualization/parse_diagrams"},{"title":"Manage symbol libraries","description":"Create and modify symbol libraries to add new symbols or geometries for diagram parsing in Cognite Data Fusion (CDF).","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/contextualization/manage_libraries"}]},{"group":"Diagram parsing for asset-centric data model","pages":[{"title":"Create interactive diagrams","description":"Extract information from static engineering diagrams to create interactive diagrams that you can explore on any device.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/contextualization/interactive_diagrams"},{"title":"Troubleshooting","description":"Resolve issues and errors related to interactive diagram parsing in Cognite Data Fusion.","content-type":"troubleshooting","audience":"administrator","experience-level":200,"lifecycle":"support","article-type":"article","href":"/cdf/integration/guides/contextualization/troubleshooting"}]}]},{"group":"Document parsing","pages":[{"title":"About document parsing","description":"Learn how the document parser extracts structured data from documents into data model views, and how the confidence score helps you verify the results.","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/contextualization/document_parser"},{"title":"Parsing documents","description":"Step-by-step guide to extract data from documents with key-value representation into data model views in Cognite Data Fusion (CDF).","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/contextualization/parse_documents"}]},{"group":"Entity matching","pages":[{"title":"About entity matching","description":"Learn how entity matching uses machine learning and rules to match entities from different data sources in Cognite Data Fusion.","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/contextualization/matching"},{"title":"Match entities","description":"Match Cognite Data Fusion resources to assets using pipelines, quick match, or 3D model matching.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/integration/guides/contextualization/match_entities"}]}]}]}]},{"tab":"Build","groups":[{"group":"Build","pages":[{"title":"Build solutions","sidebarTitle":"Overview","description":"Learn how to build and deploy your Cognite Data Fusion (CDF) solutions.","audience":"data_engineering, data_science","mode":"wide","content-type":"concept","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/build"},{"group":"Industrial MCP","pages":[{"title":"Using Industrial MCP","sidebarTitle":"Overview","description":"Connect an external AI tool to Cognite Data Fusion (CDF) with Industrial MCP, and find setup and security guidance.","content-type":"map","audience":["developer","aiEngineer","securityEngineer"],"experience-level":100,"lifecycle":"investigate","article-type":"map","mode":"wide","href":"/cdf/build/mcp/index"},{"title":"Adding Industrial MCP to an AI tool","sidebarTitle":"Add to an AI tool","description":"Step-by-step guide to copy the Industrial MCP configuration from Cognite Data Fusion (CDF) and add the server to an AI tool that supports the Model Context Protocol (MCP).","content-type":"procedure","audience":["developer","aiEngineer"],"experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":false,"href":"/cdf/build/mcp/setup"},{"title":"Industrial MCP security reference","sidebarTitle":"Security and governance","description":"Technical specifications for Industrial MCP tools, permissions, authentication, data handling, and audit logging in Cognite Data Fusion (CDF).","content-type":"reference","audience":["securityEngineer","administrator","solutionArchitect"],"experience-level":200,"lifecycle":"verify","article-type":"article","to-L10N":false,"href":"/cdf/build/mcp/security"}]},{"group":"Atlas AI","pages":[{"title":"Building Atlas AI agents","sidebarTitle":"Overview","description":"Create and manage industrial AI agents that query your CDF knowledge graph using language models, skills, and tools.","content-type":"map","audience":"aiEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/atlas_ai/index"},{"title":"About Atlas AI agents","sidebarTitle":"About Atlas AI agents","description":"Learn what makes a good Atlas AI agent use case and how to configure agents that are accurate, trustworthy, and useful in production.","content-type":"concept","audience":"aiEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/atlas_ai/concepts/index"},{"group":"Build and configure agents","pages":[{"title":"Building agents","description":"Step-by-step guide to create Atlas AI agents with the Cognite CLI or the Agent builder in CDF.","content-type":"procedure","audience":"aiEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/guides/atlas_ai_agent_building"},{"group":"Select a language model","pages":[{"title":"About language models","sidebarTitle":"Choosing language models","description":"Select the right language model for your Atlas AI agent based on task complexity, response speed, and cloud availability.","content-type":"concept","audience":"aiEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/concepts/atlas_ai_agent_choosing_lm"}]},{"group":"Manage skills","pages":[{"title":"About Atlas AI agent skills","sidebarTitle":"About skills","description":"Learn how Atlas AI agent skills give agents domain-specific knowledge and how to use them to get accurate, consistent results.","content-type":"concept","audience":"aiEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/concepts/atlas_ai_agent_skills"},{"title":"Configuring skills for agents","sidebarTitle":"Configuring skills","description":"Write and structure Atlas AI agent skills to give agents domain-specific knowledge for accurate, consistent responses.","content-type":"procedure","audience":"aiEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/guides/atlas_ai_agent_configure_skills"}]},{"group":"Configure tools","pages":[{"title":"About Atlas AI agent tools","sidebarTitle":"About tools","description":"Understand how Atlas AI agent tools extend what agents can do and why routing computation to tools produces more accurate results than relying on language model reasoning.","content-type":"concept","audience":"aiEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/concepts/atlas_ai_agent_tools"}]},{"group":"Configure subagents","pages":[{"title":"About Atlas AI agent subagents","sidebarTitle":"About subagents","description":"Understand how subagents let an Atlas AI agent delegate tasks to other agents, and when to use them to build orchestrator-style workflows.","content-type":"concept","audience":"aiEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/concepts/atlas_ai_agent_subagents"}]},{"group":"Manage context and sandbox","pages":[{"title":"About Atlas AI agent sandbox and context management","sidebarTitle":"Sandbox and context management","description":"Understand the to-do list tracking, sandbox execution environment, automatic context compression, and tool result offloading capabilities available in newer Atlas AI agent runtime versions.","content-type":"concept","audience":"aiEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/concepts/atlas_ai_agent_sandbox"}]}]},{"group":"Validate agents","pages":[{"title":"About AI agent evaluations","sidebarTitle":"How evaluations work","description":"Learn about AI agent evaluations and understand how to measure performance and verify behavior.","content-type":"concept","audience":"aiEngineer","experience-level":200,"lifecycle":"verify","article-type":"article","href":"/cdf/atlas_ai/concepts/atlas_ai_agent_evaluation_overview"},{"title":"Running agent evaluations","sidebarTitle":"Running evaluations","description":"Step-by-step guide to test Atlas AI agents with the Cognite CLI or Evaluate agents in Cognite Data Fusion (CDF).","content-type":"procedure","audience":"aiEngineer","experience-level":100,"lifecycle":"verify","article-type":"article","href":"/cdf/atlas_ai/guides/atlas_ai_agent_evaluating"},{"title":"About debugging and tracing agents","sidebarTitle":"Debugging and tracing","description":"Use reasoning traces and tool call logs in Atlas AI to identify why an agent produced an unexpected response and improve its configuration.","content-type":"concept","audience":"aiEngineer","experience-level":300,"lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/concepts/atlas_ai_agent_debugging"}]},{"group":"Use agents","pages":[{"title":"About prompting Atlas AI agents","sidebarTitle":"Writing effective prompts","description":"Learn how to write effective prompts to get accurate and relevant responses from Atlas AI agents for your industrial data questions.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/concepts/atlas_ai_agent_prompting"},{"title":"Using Atlas AI agents via API and SDK","sidebarTitle":"Call agents with API or SDK","description":"Use the Cognite Python SDK or REST API to chat with Atlas AI agents, continue conversations with a cursor, and approve or deny tool confirmations for integration tools.","content-type":"procedure","audience":"developer","experience-level":"200","lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/guides/atlas_ai_agent_api_sdk"}]},{"group":"Reference","pages":[{"title":"Looking up Atlas AI reference information","sidebarTitle":"Overview","description":"Look up language models, agent tools, runtime versions, and project limits for Atlas AI agents.","content-type":"map","audience":"aiEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/atlas_ai/references/index"},{"title":"Language model library","sidebarTitle":"Available models","description":"Detailed reference of available language models in Atlas AI, including stable, legacy, and retired models with release and retirement dates.","content-type":"reference","audience":"aiEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/references/atlas_ai_agent_language_models"},{"group":"Available tools","pages":[{"title":"Agent tools library","sidebarTitle":"Available tools","description":"Complete reference of built-in Atlas AI agent tools including query tools, analysis tools, and integration tools for interacting with data and external systems.","content-type":"reference","audience":"aiEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/references/atlas_ai_agent_tools"},{"title":"Query tool","description":"Configure the Query tool in the Atlas AI agent builder so agents can list, search, aggregate, and retrieve data modeling instances.","content-type":"reference","audience":"aiEngineer","experience-level":"200","lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/references/atlas_ai_query_tool"},{"title":"Run Python code","description":"Reference information for using the Run Python code tool in Atlas AI agents, including supported parameter types, code structure requirements, and best practices","content-type":"reference","audience":"developer","experience-level":"200","lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/references/atlas_ai_agent_python_tool"},{"title":"Call Function","description":"Configure the Call Function tool in the Atlas AI agent builder to call deployed Cognite functions from your agents.","content-type":"reference","audience":"aiEngineer","experience-level":"200","lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/references/atlas_ai_call_function_tool"}]},{"title":"Agent runtime versions","description":"Complete reference for Atlas AI agent runtime versions including stable, preview, and retired versions with feature support and retirement dates.","content-type":"reference","audience":"aiEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/atlas_ai/references/atlas_ai_agent_runtime_versions"}]}]},{"group":"Flows development","pages":[{"title":"Building Flows custom applications","sidebarTitle":"Overview","description":"Build production-ready web applications for industrial applications with AI-native development tools and modern web technologies.","content-type":"map","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"map","to-L10N":false,"href":"/cdf/flows/index"},{"group":"Concepts and features","pages":[{"title":"About Flows custom apps","sidebarTitle":"Overview","description":"Understand the core concepts of Flows custom apps, from built-in features and AI skills to spec-driven development for Cognite Data Fusion (CDF) apps.","content-type":"map","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"map","to-L10N":false,"href":"/cdf/flows/concepts/index"},{"title":"About Flows custom app features","sidebarTitle":"Flows custom app features","description":"Overview of Flows features for building custom apps for Cognite Data Fusion (CDF): scaffolding, authentication, Vite local development, TanStack Query, testing, code quality, TypeScript, and deployment.","content-type":"concept","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":false,"href":"/cdf/flows/concepts/features"},{"title":"Flows custom app architecture patterns reference","sidebarTitle":"Architecture best practices","description":"Complete reference for architectural patterns and pitfalls in Flows custom apps.","content-type":"reference","audience":"developer","experience-level":200,"lifecycle":"setup","article-type":"article","to-L10N":false,"href":"/cdf/flows/concepts/architecture-best-practices"},{"title":"About builder skills","sidebarTitle":"Skills","description":"Learn about builder skills, how they ship with every app, which AI development environments are supported, and how to keep skills up to date.","content-type":"concept","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":false,"href":"/cdf/flows/concepts/skills"},{"title":"About spec-driven development","sidebarTitle":"Spec-driven development","description":"Learn how spec-driven development works in Cognite Flows: a checked-in SPEC.md for each app, or optional spec-kit slash commands for structured per-feature planning before you write code.","content-type":"concept","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":false,"href":"/cdf/flows/concepts/spec-driven-development"},{"title":"About the Flows custom app lifecycle","sidebarTitle":"App lifecycle","description":"Learn about draft and published versions, signing states, how to roll back, and which version Custom apps opens in Cognite Data Fusion (CDF).","content-type":"concept","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","to-L10N":false,"href":"/cdf/flows/concepts/app-lifecycle"}]},{"group":"Guides","pages":[{"title":"Developing and shipping Flows custom apps","sidebarTitle":"Overview","description":"Follow Flows custom app guides from first project creation through local development with Vite to deploying React apps inside Cognite Data Fusion (CDF).","content-type":"map","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"map","to-L10N":false,"href":"/cdf/flows/guides/index"},{"title":"Getting started with Flows custom apps","sidebarTitle":"Getting started","description":"Create a new Flows custom app, install dependencies, open it in Cursor, and run it inside Cognite Data Fusion (CDF).","content-type":"procedure","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":false,"href":"/cdf/flows/guides/getting-started"},{"title":"Plan a dashboard app with spec-kit","sidebarTitle":"Planning with spec-kit","description":"Learn to use spec-kit by running specify, clarify, and plan on a real Production Accounting dashboard — from a short description to a reviewable implementation plan.","content-type":"tutorial","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","to-L10N":false,"href":"/cdf/flows/guides/spec-kit-walkthrough"},{"title":"Integrating AI agents with Flows","sidebarTitle":"Integrating AI agents","description":"Step-by-step guide to integrating Atlas AI agents with Cognite Flows custom apps in Cognite Data Fusion (CDF) using @cognite/app-sdk.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"setup","article-type":"article","to-L10N":false,"href":"/cdf/flows/guides/ai_agent_integration"},{"title":"Persisting app state in URLs","sidebarTitle":"App state in URLs","description":"Use syncInternalState to store your Flows custom app's view state in the URL, so users can share links that open the app exactly where they left off. This guide is for developers building Flows custom apps who want shareable deep links.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","to-L10N":false,"href":"/cdf/flows/guides/shareable-app-state-with-urls"},{"title":"Running Flows custom apps locally","sidebarTitle":"Running locally","description":"Run your Flows custom app in development mode with npm, the Vite dev server, HTTPS, and Cognite Data Fusion (CDF).","content-type":"procedure","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","to-L10N":false,"href":"/cdf/flows/guides/running-locally"},{"title":"Trusting the local HTTPS certificate for Flows custom apps","sidebarTitle":"Trusting local HTTPS","description":"Step-by-step guide to installing a trusted local certificate so your Flows custom app loads without warnings in Cognite Data Fusion (CDF).","content-type":"procedure","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","to-L10N":false,"href":"/cdf/flows/guides/local-https"},{"title":"Signing in with an additional Microsoft Entra ID account","sidebarTitle":"OAuth relay","description":"Step-by-step guide to using the App Hosting OAuth relay for an additional Microsoft Entra ID sign-in from within a Flows custom app.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","to-L10N":false,"href":"/cdf/flows/guides/oauth-relay"},{"title":"Signing Flows custom apps from the CLI","sidebarTitle":"Signing custom apps","description":"Step-by-step guide to generate signing keys, sign Flows custom app bundles, and publish signed deployments with the Cognite CLI.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","to-L10N":false,"href":"/cdf/flows/guides/code-signing"},{"title":"Signing Flows custom apps from CI/CD","sidebarTitle":"Signing apps from CI/CD","description":"Set up a GitHub Actions pipeline that deploys, signs, and activates a Flows custom app with a CI/CD signing key. Only the developer signature is covered, and only on projects with Dev status.","content-type":"procedure","audience":"developer","experience-level":300,"lifecycle":"use","article-type":"article","to-L10N":false,"href":"/cdf/flows/guides/code-signing-cicd"},{"title":"Deploying Flows custom apps","sidebarTitle":"Deploying","description":"Deploy your Flows custom app to Cognite Data Fusion (CDF) with interactive or automated deployment and App Hosting lifecycle commands.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","to-L10N":false,"href":"/cdf/flows/guides/deploying"},{"group":"Certification","pages":[{"title":"Becoming a certified Flows custom apps builder","sidebarTitle":"Builder certification","description":"Learn how to complete builder certification to develop Flows custom apps. Builder certification qualifies you to build; it does not certify any app.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"setup","article-type":"article","to-L10N":false,"href":"/cdf/flows/guides/builder-certification"},{"title":"Certifying a Flows custom app for production","sidebarTitle":"Application certification","description":"Learn how to certify a version of a Flows custom app for production using the four certification skills.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"setup","article-type":"article","to-L10N":false,"href":"/cdf/flows/guides/application-certification"},{"title":"Flows custom apps quality guidelines","sidebarTitle":"Quality guidelines","description":"Comprehensive quality assessment criteria for Flows custom apps, including design evaluation rubric and engineering standards.","content-type":"reference","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","to-L10N":false,"href":"/cdf/flows/guides/quality-guidelines"},{"title":"Requesting Dev status for a CDF project","sidebarTitle":"Dev status","description":"Learn how to request Dev status for a non-production Cognite Data Fusion (CDF) project so you can publish builder-signed Flows custom apps without application certification.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"setup","article-type":"article","to-L10N":false,"href":"/cdf/flows/guides/dev-status"}]}]},{"group":"Reference","pages":[{"group":"API","pages":[{"title":"Using Flows APIs","sidebarTitle":"Overview","description":"Look up authentication helpers, host interaction methods, and the Vite plugin surface for building and shipping Flows custom apps on Cognite Data Fusion (CDF).","content-type":"map","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"map","to-L10N":false,"href":"/cdf/flows/reference/api/index"},{"title":"Flows Auth API","sidebarTitle":"Auth API","description":"Complete reference for connectToHostApp and authenticated Cognite Data Fusion (CDF) access in Flows custom apps.","content-type":"reference","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","to-L10N":false,"href":"/cdf/flows/reference/api/auth"},{"title":"Flows Host App API","sidebarTitle":"Host App API","description":"Complete reference for HostAppAPI interaction methods in Flows custom apps, such as navigation, state, sidebar visibility, fullscreen, and AI agents.","content-type":"reference","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","to-L10N":false,"href":"/cdf/flows/reference/api/host-app-api"},{"title":"Flows Vite plugin API","sidebarTitle":"Vite plugin API","description":"Complete reference for Flows Vite plugins, including fusionOpenPlugin and Cognite Data Fusion (CDF) development URLs.","content-type":"reference","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","to-L10N":false,"href":"/cdf/flows/reference/api/vite"},{"title":"Content Security Policy for Flows custom apps","sidebarTitle":"Content Security Policy","description":"Understand the Content Security Policy (CSP) for Flows custom apps and how to allow trusted network sources in manifest.json.","content-type":"reference","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","to-L10N":false,"href":"/cdf/flows/reference/api/csp"}]}]}]},{"group":"Aura design system","pages":[{"title":"Building with the Aura design system","sidebarTitle":"Overview","description":"Explore Aura foundations, primitives, and developer guidance for building consistent, accessible product UI in Cognite Data Fusion (CDF) and Flows custom apps.","content-type":"map","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"map","href":"/cdf/aura/index"},{"group":"Get started","pages":[{"title":"About Aura","description":"Learn about Aura, Cognite's AI-native design system. It combines a visual language, component library, and usage conventions teams and agents use to build consistent product UI in Cognite Data Fusion (CDF) and Flows custom apps.","content-type":"concept","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"concept","href":"/cdf/aura/what-is-aura"},{"title":"Installing Aura","sidebarTitle":"Installing Aura","description":"Add Aura to a project, including the default setup that ships with Flows custom apps.","content-type":"concept","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"concept","href":"/cdf/aura/guides/installation"}]},{"group":"Foundations","pages":[{"title":"Exploring Aura foundations","sidebarTitle":"Overview","description":"Explore Aura foundations from color tokens to spacing to accessibility to understand how primitives are composed.","content-type":"map","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"map","href":"/cdf/aura/foundations/index"},{"title":"Color","sidebarTitle":"Color","description":"How Aura's two-layer color architecture works — ramps, semantic tokens, light and dark theming, fixed-appearance tokens — plus the complete token and ramp value tables.","toc":{"min-heading-level":2,"max-heading-level":3},"content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"article","href":"/cdf/aura/foundations/color"},{"title":"Typography","sidebarTitle":"Typography","description":"Aura typefaces, type scale, and how typography tokens map to Inter and Source Code Pro.","toc":{"min-heading-level":2,"max-heading-level":3},"content-type":"concept","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"concept","href":"/cdf/aura/foundations/typography"},{"title":"Size","sidebarTitle":"Size","description":"Size covers the spatial rules that give a UI its structure and rhythm — height, spacing, radius, and stroke width","toc":{"min-heading-level":2,"max-heading-level":3},"content-type":"concept","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"concept","href":"/cdf/aura/foundations/size"},{"title":"Effects","sidebarTitle":"Effects","description":"Effects include elevations (shadows) and focus rings for consistent depth, attention, and keyboard focus.","toc":{"min-heading-level":2,"max-heading-level":3},"content-type":"concept","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"concept","href":"/cdf/aura/foundations/effects"},{"title":"Motion","sidebarTitle":"Motion","description":"Motion principles, easing and duration tokens, and Tailwind-oriented guidance for productive and expressive animation in Aura.","toc":{"min-heading-level":2,"max-heading-level":3},"content-type":"concept","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"concept","href":"/cdf/aura/foundations/motion"},{"title":"Interaction states","sidebarTitle":"Interaction states","description":"How affordances and signifiers relate to UI interaction states in Aura Components.","toc":{"min-heading-level":2,"max-heading-level":3},"content-type":"concept","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"concept","href":"/cdf/aura/foundations/interaction-states"},{"title":"Heuristic guidelines","sidebarTitle":"Design heuristics","description":"Practical usability principles for evaluating and improving UI design quality.","toc":{"min-heading-level":2,"max-heading-level":3},"content-type":"concept","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"concept","href":"/cdf/aura/foundations/design-heuristics"},{"title":"Accessibility","sidebarTitle":"Accessibility","description":"How we design and build inclusive interfaces that work for everyone. Covers contrast, focus, semantics, and media.","toc":{"min-heading-level":2,"max-heading-level":3},"content-type":"concept","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"concept","href":"/cdf/aura/foundations/accessibility"}]},{"group":"Primitives","pages":[{"title":"Primitives overview","sidebarTitle":"Overview","description":"Browse Aura primitives by category: actions, data display, feedback, inputs, layout, navigation, overlays, and utilities.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/aura/primitives/index"},{"title":"Accordion","sidebarTitle":"Accordion","description":"An Accordion helps manage content by displaying or hiding sections of information based on user interactions. It is particularly useful where space is limited and large amounts of information must be shown in a compact, organized way.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/accordion"},{"title":"Action toolbar","sidebarTitle":"Action toolbar","description":"An Action toolbar provides users with quick access to key actions relevant to a specific page, section, or data set. It appears at the bottom center of the page as a floating toolbar when items on the page are selected, most often from a Data grid.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/action-toolbar"},{"title":"Alert","sidebarTitle":"Alert","description":"An Alert communicates information about a specific user action on a page. It lives inside the page and appears contextually within a task flow and disappears when the user closes it, resolves the issue, or (if required by feature) navigates away from the page.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/alert"},{"title":"Avatar","sidebarTitle":"Avatar","description":"An Avatar is a graphical representation of a user or concept. It is typically used to personalize user interfaces by displaying profile pictures, initials, or icons and help users quickly recognize individuals in collaborative environments.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/avatar"},{"title":"Badge","sidebarTitle":"Badge","description":"A Badge displays a label and/or icon to indicate metadata, count, status, filter, or notification.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/badge"},{"title":"Banner","sidebarTitle":"Banner","description":"Banners are placed at the top of the UI to show prominent notifications or messages for the product or system, such as promotional features or connectivity issues.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/banner"},{"title":"Breadcrumbs","sidebarTitle":"Breadcrumbs","description":"Breadcrumbs allow users to quickly and dependably gain their bearings within our product. It provides a hierarchical path to help users navigate back to previous pages efficiently.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/breadcrumbs"},{"title":"Button","sidebarTitle":"Button","description":"Use a Button to communicate actions users can take and to allow users to interact with the page. Each page should have only one primary Button, and any remaining calls to action should be represented as lower-emphasis Buttons.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/button"},{"title":"Card","sidebarTitle":"Card","description":"A simple, styled container with optional header and footer content, and a flexible body content slot.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/card"},{"title":"Chart","sidebarTitle":"Chart","description":"Flexible data visualizations with variants for surfacing industrial data patterns, trends, and comparisons — from asset performance to sensor readings to operational status.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/aura/primitives/chart"},{"title":"Checkbox","sidebarTitle":"Checkbox","description":"Checkboxes allow users to select one or multiple options from a list.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/checkbox"},{"title":"Code block","sidebarTitle":"Code block","description":"Formatted display of code snippets with syntax highlighting for documentation and in-product technical content.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/aura/primitives/code-block"},{"title":"Collapsible","sidebarTitle":"Collapsible","description":"A single inline expandable block that shows or hides content when triggered.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/collapsible"},{"title":"Combobox","sidebarTitle":"Combobox","description":"A searchable select input that filters a list of options as the user types. Supports single and multi-select, and optionally allows users to add new items that aren't in the existing list.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/combobox"},{"title":"Command","sidebarTitle":"Command","description":"A keyboard-first search interface for finding and executing actions, navigating to pages, or looking up content across the application. Typically triggered by a keyboard shortcut (⌘K / Ctrl+K) and rendered inside a Dialog or Popover.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/command"},{"title":"Count","sidebarTitle":"Count","description":"Displays a formatted numeric value with optional unit and status styling for KPIs, metrics, and summarized quantities.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/aura/primitives/count"},{"title":"Data grid","sidebarTitle":"Data grid","description":"A Data grid is a table that allows for filtering or manipulating data views.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/data-grid"},{"title":"Date picker","sidebarTitle":"Date picker","description":"Date picker allows the user to select a specific date either from a calendar or via the input.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/aura/primitives/date-picker"},{"title":"Date range picker","sidebarTitle":"Date range picker","description":"Lets users select a start and end date in a single control, with locale-aware formatting and validation.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/aura/primitives/date-range-picker"},{"title":"Date time range picker","sidebarTitle":"Date time range picker","description":"Lets users select a start and end date and time in a single control, with locale-aware formatting and validation.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/aura/primitives/date-time-range-picker"},{"title":"Dialog","sidebarTitle":"Dialog","description":"A Dialog interrupts the main workflow to capture user attention and requires users to interact with it before they can return to the main screen.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/dialog"},{"title":"Dropdown menu","sidebarTitle":"Dropdown menu","description":"A Dropdown menu displays a menu to the user, such as a set of actions or functions, triggered by a Button.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/aura/primitives/dropdown-menu"},{"title":"Empty state","sidebarTitle":"Empty state","description":"Empty states guide users when there is no content to display or when an error prevents data from loading. They serve to inform, assist, and encourage users toward the next steps.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/empty-state"},{"title":"Helper text","sidebarTitle":"Helper text","description":"Supplementary text below a form field that provides guidance, constraints, or feedback. Always tied to a specific field — it's not a general annotation element.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/helper-text"},{"title":"Input","sidebarTitle":"Input","description":"Inputs are used for short text in forms and toolbars, with support for labels, helper text, prefixes, and validation states.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/input"},{"title":"KBD","sidebarTitle":"KBD","description":"KBD displays keyboard shortcut indicators that give users quick access to frequently used actions or commands, improving efficiency and streamlining workflows.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/kbd"},{"title":"Label","sidebarTitle":"Label","description":"A styled text label that identifies an input field, menu group, or UI element.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/label"},{"title":"Page loader","sidebarTitle":"Page loader","description":"Page loaders can be used as full page loaders, covering the entire page while content is loading.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/page-loader"},{"title":"Pagination","sidebarTitle":"Pagination","description":"Pagination helps users navigate large sets of data by dividing them into manageable pages. It allows for faster load times, better user control, and easier data scanning.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/pagination"},{"title":"Popover","sidebarTitle":"Popover","description":"Popovers, which are commonly triggered by Buttons, appear contextually near the trigger element allowing users to interact more efficiently with the UI. They are often used for lightweight interactions or providing contextual information in forms.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/popover"},{"title":"Progress","sidebarTitle":"Progress","description":"Shows how far through a task or process the user is. Use when completion is measurable and expressing it as a percentage or fraction is meaningful to the user.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/progress"},{"title":"Radio","sidebarTitle":"Radio","description":"Radio buttons allow users to select one option from a list of mutually exclusive choices. Once a selection is made, it typically persists until the user selects a different option.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/radio"},{"title":"Scroll area","sidebarTitle":"Scroll area","description":"A custom scrollable viewport for content that exceeds available space, with consistent scrollbars across browsers and platforms.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/aura/primitives/scroll-area"},{"title":"Search","sidebarTitle":"Search","description":"A specialized Input for finding and filtering content. The search icon and clear button are built in — don't add your own.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/search"},{"title":"Segmented control","sidebarTitle":"Segmented control","description":"Segmented controls allow users to switch between different views, categories, or content filters in real time, without leaving the current page or context. They’re typically used for mutually exclusive options, where selecting one option deselects the others.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/segmented-control"},{"title":"Select","sidebarTitle":"Select","description":"Select allows users to choose one or more pre-defined options from a list. It’s typically used in forms or filtering contexts where predefined options are available.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/select"},{"title":"Separator","sidebarTitle":"Separator","description":"A Separator is a one pixel thick UI element used to create visual separation between sections or content. It helps improve readability and organization without overwhelming the layout. They can be horizontal or vertical in their orientation.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/separator"},{"title":"Skeleton","sidebarTitle":"Skeleton","description":"Placeholder shapes that indicate loading content before data is available, reducing layout shift and perceived wait time.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/aura/primitives/skeleton"},{"title":"Slider","sidebarTitle":"Slider","description":"A Slider allows users to select a value (or a range of values) from a predefined scale by moving a handle along a track. It's ideal for adjusting settings or selecting approximate values quickly and visually.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/slider"},{"title":"Sonner","sidebarTitle":"Sonner","description":"Sonner is a toast notification that appears at the bottom of the screen and auto-dismisses after a few seconds.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/sonner"},{"title":"Switch","sidebarTitle":"Switch","description":"A Switch toggles a setting on or off. It represents a binary state and should update immediately when toggled. Switches are typically used for system or feature controls that take effect right away.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/switch"},{"title":"Tabs","sidebarTitle":"Tabs","description":"Tabs help users organize and navigate between sections of related content without leaving the page. They provide an efficient way to display different views or categories of information in the same context.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/tabs"},{"title":"Textarea","sidebarTitle":"Textarea","description":"A Textarea allows users to input and edit multiple lines of text. It is designed for collecting longer or more complex information such as comments, feedback, messages, descriptions, or additional notes.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/textarea"},{"title":"Time picker","sidebarTitle":"Time picker","description":"A visual time selector used inside date time pickers or standalone for time-only input. Handles hour and minute selection — only include seconds when the use case genuinely requires that level of precision.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/aura/primitives/time-picker"},{"title":"Time range picker","sidebarTitle":"Time range picker","description":"Lets users select a start and end time in a single control, with locale-aware formatting and validation.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/aura/primitives/time-range-picker"},{"title":"Toggle group","sidebarTitle":"Toggle group","description":"A set of mutually exclusive options where one or multiple can be selected. Use it for toggling on settings, such as grid lines, rulers, or text formatting options like bold, italics, underline, etc.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/toggle-group"},{"title":"Toolbar","sidebarTitle":"Toolbar","description":"Toolbars give users quick access to common actions, tools, or commands. Think of them like a row of Buttons or icons that let you do things without digging through settings or Menus. They are placed contextually near the element they affect or sometimes only appear when an element is selected.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/toolbar"},{"title":"Tooltip","sidebarTitle":"Tooltip","description":"Tooltips are typically used for explaining icons, Buttons, links, or actions that might not be immediately obvious. Tooltips are presented inside a container that is displayed when a user hovers or focuses on an element.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/tooltip"},{"title":"Topbar","sidebarTitle":"Topbar","description":"The Topbar is the single, persistent navigation bar that sits at the top of every authenticated Cognite Data Fusion (CDF) and Flows custom app. It is the primary chrome layer that orients users — showing where they are, how to get back, and what global actions are available.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","mode":"wide","href":"/cdf/aura/primitives/topbar"}]},{"group":"Developer guide","pages":[{"title":"Token customization","sidebarTitle":"Customization","description":"How to apply customer brand colors to Aura in Figma and code — which token groups to customize, and how to override safely in Flows custom apps.","toc":{"min-heading-level":2,"max-heading-level":4},"content-type":"reference","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/aura/developer-guide/customization"},{"title":"Aura development roadmap","sidebarTitle":"In development","description":"Quarterly reference for Aura's current priorities and planned investments across components, documentation, AI tooling, and developer experience.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/aura/developer-guide/in-development"}]}]},{"group":"Dashboards","pages":[{"title":"About dashboards","sidebarTitle":"Overview","description":"Use out-of-the-box and custom tools to explore, trend, and analyze industrial data stored in Cognite Data Fusion (CDF).","content-type":"overview","audience":"data_analyst","mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/dashboards/index"},{"group":"Grafana","pages":[{"title":"Cognite Data Source for Grafana","sidebarTitle":"Overview","description":"Connect a Cognite Data Fusion (CDF) project as a data source and use Grafana to query, transform, and visualize your data.","content-type":"map","audience":"dataAnalyst","mode":"wide","experience-level":100,"lifecycle":"setup","article-type":"map","href":"/cdf/dashboards/guides/grafana/getting_started"},{"title":"Plot time series from data model views","sidebarTitle":"Data model time series","description":"Create dashboards and select the time series you want to plot using custom queries, filtering, aggregation, and advanced features.","content-type":"guide","audience":"data_analyst","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/guides/grafana/timeseries"},{"title":"Plot time series with legacy features","sidebarTitle":"Legacy time series","description":"Create dashboards and select the time series you want to plot using the time series API and custom queries.","content-type":"guide","audience":"data_analyst","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/guides/grafana/timeseries_legacy"},{"title":"Visualize events","description":"Set up and filter queries on CDF events and annotate the events to graphs on your Grafana dashboard.","content-type":"guide","audience":"data_analyst","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/guides/grafana/annotations"},{"title":"Create templates with global variables","description":"Use variables to create templates in Grafana dashboards.","content-type":"procedure","audience":"data_analyst","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/guides/grafana/variables"},{"title":"Troubleshooting","description":"Find information to help you troubleshoot issues using Cognite Data Fusion (CDF) as a data source in Grafana.","content-type":"troubleshooting","audience":"dataAnalyst","experience-level":100,"lifecycle":"support","article-type":"article","href":"/cdf/dashboards/guides/grafana/troubleshoot"}]},{"group":"Power BI and Excel","pages":[{"title":"Use CDF with Power BI and Excel","sidebarTitle":"Overview","description":"Connect a Cognite Data Fusion (CDF) project as a data source and use Microsoft Power BI and Excel to query, transform, and visualize your data.","content-type":"overview","audience":"data_analyst","mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/dashboards/guides/powerbi/index"},{"group":"Power BI REST API connector","pages":[{"title":"Power BI REST API connector","description":"Use the Power BI REST API connector to fetch data with Cognite's OData services or other Cognite APIs using GET, POST, and GraphQL queries.","content-type":"procedure","audience":"data_analyst","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/guides/powerbi/set_up_rest_connector"},{"title":"Power BI REST API functions","description":"Available Power BI REST API functions to use with the Cognite APIs for fetching and transforming data.","content-type":"reference","audience":"data_analyst","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/references/rest/powerbi_rest_functions"},{"title":"Power Query functions and example queries","description":"Combine functions from the Cognite Data Fusion REST API connector for Power BI with Power Query to fetch and transform data.","content-type":"reference","audience":"data_analyst","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/references/rest/powerbi_rest_examples"},{"title":"Power BI incremental refresh","description":"Configure incremental refresh with the Cognite Data Fusion REST API connector for Power BI to efficiently load large volumes of data.","content-type":"reference","audience":"data_analyst","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/references/rest/powerbi_rest_incremental_refresh"}]},{"title":"Power BI OData connector","description":"Connect a Cognite Data Fusion project as a data source in Power BI using the OData connector.","content-type":"guide","audience":"data_analyst","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/guides/powerbi/set_up_odata_connector"},{"title":"Excel: Retrieve data from CDF","description":"Connect a Cognite Data Fusion project as a data source and use Excel to query, transform, and visualize CDF data.","content-type":"guide","audience":"data_analyst","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/guides/excel/retrieve_data_from_cdf"},{"group":"OData services","pages":[{"title":"Cognite OData services","description":"Fetch data from Cognite Data Fusion using OData clients such as Microsoft Power BI, Microsoft Excel, and TIBCO Spotfire.","content-type":"overview","audience":"data_analyst","experience-level":200,"lifecycle":"use","article-type":"map","href":"/cdf/dashboards/references/odata/index"},{"title":"Asset-centric OData service","description":"Connect Cognite Data Fusion as a data source and use OData clients to query, transform, and visualize data stored in CDF asset-centric resources.","content-type":"reference","audience":"data_analyst","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/references/odata/classic_odata"},{"title":"Data modeling OData service","description":"Connect a Cognite Data Fusion data model as a data source and use OData clients to query, transform, and visualize data stored in CDF data models.","content-type":"reference","audience":"data_analyst","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/references/odata/dm_odata"},{"title":"Custom OData queries","description":"Use custom queries in asset-centric and data-modeling OData services to filter properties and retrieve specific data sets.","content-type":"reference","audience":"data_analyst","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/references/odata/custom_queries"},{"title":"Get aggregated time series data","description":"Query Cognite Data Fusion for pre-calculated aggregates of numerical time series data points with short response times.","content-type":"reference","audience":"data_analyst","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/references/odata/timeseries_aggregates"},{"title":"Best practices and troubleshooting","description":"Get the most out of your OData client with these best practices and troubleshooting tips for optimal performance.","content-type":"reference","audience":"data_analyst","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/references/odata/best_practices"}]}]}]},{"group":"Industrial Data Science Library","pages":[{"title":"Industrial Data Science Library","url":"https://indsl.docs.cognite.com/","description":null,"href":"/cdf/indsl"}]},{"group":"Jupyter Notebook","pages":[{"title":"Jupyter Notebook","description":"Jupyter Notebook is integrated with Cognite Data Fusion (CDF) and you can create interactive notebook documents that can contain live code, equations, visualizations, and media.","content-type":"concept","audience":["dataEngineer","dataScientist"],"experience-level":200,"lifecycle":"use","article-type":"map","href":"/cdf/jupyter/index"}]},{"group":"Streamlit custom apps","pages":[{"title":"Streamlit apps","description":"Create data visualization tools, dashboards, and prototypes using Streamlit.","content-type":"procedure","audience":["dataEngineer","dataScientist"],"experience-level":200,"lifecycle":"use","article-type":"map","href":"/cdf/streamlit/index"}]},{"group":"Data science and machine learning","pages":[{"title":"About data science and machine learning","sidebarTitle":"Overview","description":"Learn about tools, processes, strategies, and methodologies for developing and deploying data science and machine learning solutions with Cognite Data Fusion (CDF).","content-type":"map","audience":"data_scientist","mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/data_science/index"},{"title":"Data science tools","description":"Explore the tools you need to develop data science applications for the data in Cognite Data Fusion (CDF), including both built-in tools and tools made by other companies.","content-type":"concept","audience":"data_scientist","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/data_science/guides/ds_tools"},{"title":"Machine learning operations (MLOps)","description":"Machine learning operations (MLOps) aims to deploy and maintain machine learning models reliably, efficiently, and at scale.","content-type":"concept","audience":"data_scientist","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/data_science/guides/ds_mlops"}]},{"group":"Functions","pages":[{"title":"About Cognite Functions","sidebarTitle":"Overview","description":"Cognite Functions lets you deploy Python code to Cognite Data Fusion (CDF), call the code on-demand, or schedule the code to run at regular intervals.","content-type":"concept","audience":"dataEngineer","mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/functions/index"},{"title":"Setup and administration","description":"Learn how to set up and activate Cognite Functions, configure permissions, and prepare your environment to deploy Python code in CDF.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/functions/admin"},{"title":"Use Functions","description":"Deploy Python code to CDF, call functions on-demand, and schedule them to run at regular intervals. Learn to authenticate, create, and manage functions.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/functions/use_functions"},{"title":"Troubleshooting","description":"Resolve common issues with Cognite Functions, including folder structure errors, failed calls, logging problems, and deployment issues.","content-type":"troubleshooting","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/functions/known_issues"},{"title":"Cloud provider limitations","description":"Technical specifications and limits for Cognite Functions across Google, Azure, and AWS cloud providers, including CPU, RAM, timeouts, and data retention.","content-type":"reference","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/functions/technical"},{"title":"Securing Cognite Functions","description":"Follow best practices for handling secrets, securing dependencies, and deploying Cognite Functions with CI/CD to ensure the security and integrity of your data.","content-type":"concept","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/functions/security"}]}]}]},{"tab":"Admin","groups":[{"group":"Administration","pages":[{"title":"About CDF administration","sidebarTitle":"Overview","description":"Learn how to manage access to CDF, configure apps and solutions, and stay updated on [new](/cdf/whatsnew) and [deprecated](/cdf/deprecated) features to prepare for future CDF releases.","content-type":"map","audience":"administrator","mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/admin"},{"title":"What's new?","description":"Latest updates, new features, and improvements to Cognite Data Fusion.","content-type":"changelog","audience":"administrator","experience-level":100,"lifecycle":"support","article-type":"article","rss":true,"href":"/cdf/whatsnew"},{"title":"Release states","description":"Definitions of Cognite Data Fusion (CDF) release states (production, public preview, private preview, deprecated), SLA coverage for production, and how deprecation notices apply before retirement.","content-type":"reference","audience":"administrator","experience-level":100,"lifecycle":"support","article-type":"article","href":"/cdf/product_feature_status"},{"title":"Deprecated and retired features","description":"Announcements and deprecations for Cognite Data Fusion features to help admins and IT professionals prepare for future releases.","content-type":"reference","audience":"administrator","experience-level":100,"lifecycle":"support","article-type":"article","mode":"wide","href":"/cdf/deprecated"},{"title":"Supported browsers and devices","description":"Browser and device requirements for accessing Cognite Data Fusion and business applications.","content-type":"reference","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/admin/supported_devices_browsers"},{"title":"Improving latency","description":"Bandwidth guidelines and recommendations to optimize performance across CDF applications and features.","content-type":"reference","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/admin/connectivity"},{"title":"Allowlist URLs","description":"To load user interfaces correctly, add these URLs to your firewall allowlist.","content-type":"reference","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/admin/allowlist"},{"title":"Clusters and regions","description":"Learn about available Cognite clusters and regions across different cloud providers.","content-type":"reference","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/admin/clusters_regions"},{"title":"About limits","description":"Learn about Cognite Data Fusion (CDF) limits and how they affect your projects and workloads.","content-type":"concept","audience":"administrator","experience-level":100,"lifecycle":"use","href":"/cdf/admin/limits"},{"group":"Manage organization","pages":[{"title":"Manage your organization","sidebarTitle":"Overview","description":"Manage organization-level settings in the Admin workspace, including organization administrators and applications.","content-type":"map","audience":"administrator","mode":"wide","experience-level":100,"lifecycle":"setup","article-type":"map","href":"/cdf/admin/manage_organization/index"},{"title":"Add an organization administrator","description":"Step-by-step guide for organization administrators to add or remove other administrators in Cognite Data Fusion (CDF).","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"setup","article-type":"article","href":"/cdf/admin/manage_organization/add_organization_admin"},{"title":"Register applications","description":"Step-by-step guide for organization administrators to register trusted applications in Cognite Data Fusion (CDF).","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"setup","article-type":"article","href":"/cdf/admin/manage_organization/register_apps"}]},{"group":"Manage access","pages":[{"title":"About identity and access management","sidebarTitle":"Overview","description":"Manage access to Cognite Data Fusion (CDF)applications and data using your existing identity provider framework with OAuth 2.0 and OpenID Connect.","content-type":"map","audience":"administrator","mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","keywords":"identity and access management, IAM","href":"/cdf/access/index"},{"title":"Access management concepts","description":"Main concepts in securely managing access to the Cognite applications and the data stored in your Cognite Data Fusion (CDF) projects.","content-type":"concept","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","keywords":"access management","href":"/cdf/access/concepts/concepts"},{"title":"Assign capabilities","description":"Control access to data and features in Cognite Data Fusion (CDF) by assigning capabilities to groups.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/guides/capabilities"},{"group":"Cognite Data Fusion","pages":[{"title":"Manage groups and group membership","description":"Create groups in Cognite Data Fusion (CDF) and manage group membership for user and service accounts.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/cdf/guides/create_groups_oidc_cdf"}]},{"group":"Amazon Cognito","pages":[{"title":"Register core Cognite apps","description":"Register the Cognite API and applications in Amazon Cognito for organizational sign-in.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/aws/guides/configure_cdf_cognito"},{"title":"Manage groups and group membership","description":"Create groups in Cognite Data Fusion (CDF) and link them to Amazon Cognito groups to manage group membership.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/aws/guides/create_groups_oidc_cognito"},{"title":"Add a service account to a CDF group","description":"Create a service account in Amazon Cognito and add it as a member to a Cognite Data Fusion (CDF) group.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/aws/guides/add_service_principal_cognito"},{"title":"Register a custom web app in Amazon Cognito","description":"Register a custom web application in Amazon Cognito for user authentication.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/aws/guides/register_custom_webapp_cognito"}]},{"group":"Microsoft Entra ID","pages":[{"title":"Register core Cognite apps","description":"Register the Cognite API and applications in Microsoft Entra ID for organizational sign-in.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/entra/guides/configure_cdf_azure_oidc"},{"title":"Manage groups and group membership","description":"Create groups in Cognite Data Fusion (CDF) and link them to Microsoft Entra ID groups to manage group membership.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/entra/guides/create_groups_oidc"},{"title":"Register and configure applications and components","description":"The table below lists applications and components with links to configuration steps and details about the authentication flows they use.","content-type":"reference","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/entra/guides/configure_apps_oidc"},{"title":"Register a custom web app in Microsoft Entra ID","description":"Register a custom web application in Microsoft Entra ID for user authentication.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/entra/guides/register_custom_webapp"},{"title":"Add a service account to a CDF group","description":"Create a client secret in Microsoft Entra ID and add the service principal to a Cognite Data Fusion (CDF) group.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/entra/guides/add_service_principal"}]},{"group":"Deep dives","pages":[{"title":"Design principles and best practices","description":"Design principles and best practices for managing authentication and authorization in Cognite Data Fusion (CDF).","content-type":"concept","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/concepts/best_practices_oidc"},{"title":"Authentication flows","description":"Understand OAuth 2.0 and OpenID Connect authentication flows for user and service applications in Cognite Data Fusion (CDF).","content-type":"concept","audience":"administrator","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/access/concepts/authentication_flows_oidc"},{"title":"Access token scopes","description":"Understand how OAuth 2.0 scopes expand or restrict access granted by the Cognite Data Fusion (CDF) groups.","content-type":"reference","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/concepts/access_token_scopes"},{"title":"Minimum IdP requirements","description":"Identity provider requirements to access Cognite Data Fusion (CDF).","content-type":"reference","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/concepts/minimum_idp_requirements"},{"title":"Troubleshooting","description":"Resolve common access management issues in Cognite Data Fusion (CDF).","content-type":"troubleshooting","audience":"administrator","experience-level":100,"lifecycle":"support","article-type":"article","href":"/cdf/access/troubleshooting/troubleshoot_oidc"}]}]},{"group":"Configure apps and solutions","pages":[{"title":"Configure apps and solutions","sidebarTitle":"Overview","description":"Configure apps and solutions to work seamlessly with data from Cognite Data Fusion (CDF).","content-type":"map","audience":"administrator","mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/configure/index"},{"group":"Project settings","pages":[{"title":"Manage search categories","description":"Set up the default display of data when users search in the Flows workspace.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/configure/project_settings"},{"group":"Location filters","pages":[{"title":"Manage locations","description":"Define location filters to help users find and select data related to specific physical locations, improving 3D experiences and natural language search results.","content-type":"concept","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/locations/index"},{"title":"Configure location filters","description":"Configure location filters using the CDF interface or Cognite Toolkit to help users find and select data related to specific physical locations in your CDF project. How you set up the location filters depends on how your data is stored and structured in the CDF project.","content-type":"procedure","audience":"administrator","unlisted":false,"experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/locations/guides/index"}]}]},{"title":"Configure InField on CDM","description":"Step-by-step guide to configure Cognite InField on the Core Data Model (CDM), including locations, view mappings, feature toggles, observations, and asset explorer customization.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"setup","article-type":"article","href":"/cdf/infield/guides/config_idm"},{"title":"Configure Maintain","description":"Learn how to configure Cognite Maintain, including data modeling spaces, access control, data ingestion, and feature configurations.","content-type":"procedure","audience":"administrator","experienceLevel":"200","articleType":"article","lifecycle":"setup","href":"/cdf/maintain/guides/config"},{"title":"Set up canvas labels","sidebarTitle":"Canvas labels","description":"Step-by-step guide to set up canvas labels, assign them to canvases, and grant end-user access so users can filter canvases on the overview.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/configure/canvas_settings"},{"title":"Email setup for time series monitoring","description":"Time series monitoring jobs in Charts send emails for any set threshold breach.","content-type":"concept","audience":"business_user","to-L10N":false,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/configure/charts_monitoring"},{"title":"Setup and administration for Grafana","description":"Use the Cognite Data Source for Grafana to connect a CDF project as a data source in Grafana with OpenID Connect authentication.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/guides/grafana/admin_oidc"},{"title":"Microsoft Power Query for Power BI and Excel","description":"Register and grant consent for an organization to use Microsoft Power Query for Excel and Power BI Data Refresh applications to retrieve data from CDF.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/dashboards/guides/powerbi/admin"},{"group":"Private CDF endpoints","pages":[{"title":"About Private Link","description":"Learn how Private Link for Cognite Data Fusion (CDF) restricts project access to requests that arrive over Private Link and blocks stolen tokens replayed from the public internet.","content-type":"concept","audience":["administrator","securityEngineer"],"experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/access/concepts/private_link_overview"},{"title":"Private Link and Local Network Access browser permission","description":"Manage browser permissions for Local Network Access when using Private Link with Cognite Data Fusion (CDF).","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/guides/private_link_local_network_access_browser_permission"},{"group":"Amazon Web Services","pages":[{"title":"Configure AWS PrivateLink and CDF","description":"Set up AWS PrivateLink to access Cognite Data Fusion (CDF) over a private connection.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/guides/configure_private_link_aws"},{"title":"Configure outbound AWS PrivateLink","description":"Set up outbound AWS PrivateLink for Cognite Data Fusion (CDF) to make private connections to your AWS resources.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/guides/configure_outbound_private_link_aws"}]},{"group":"Microsoft Azure","pages":[{"title":"Configure Azure Private Link and CDF","description":"Set up Azure Private Link to access Cognite Data Fusion (CDF) over a private connection.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/guides/configure_private_link_azure"},{"title":"Configure outbound Azure Private Link","description":"Set up outbound Azure Private Link for Cognite Data Fusion (CDF) to make private connections to your Azure resources.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/access/guides/configure_outbound_private_link_azure"}]}]}]},{"group":"Trust and security","pages":[{"title":"Trust and security","description":"Find Cognite corporate trust, compliance, and security resources, and links to CDF-specific security documentation.","content-type":"concept","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/trust/index"},{"title":"Security","description":"Learn about Cognite security principles, shared responsibility model, and identity and access management.","content-type":"concept","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/trust/security/security_intro"},{"title":"Reliability","description":"Learn how CDF ensures high availability, resilient infrastructure, automated backups, and comprehensive disaster recovery capabilities with defined RTOs and RPOs to maintain operational continuity.","content-type":"concept","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/trust/security/reliability_intro"},{"title":"Availability and business continuity","description":"Learn about CDF service availability, maintenance windows, backup procedures, and disaster recovery processes.","content-type":"reference","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/admin/availability_continuity"},{"title":"Vulnerability disclosure policy","description":"Learn how to report security vulnerabilities in Cognite services and software according to our disclosure policy.","content-type":"concept","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/trust/vulnerability-disclosure-policy"}]},{"group":"Audit logs","pages":[{"title":"Audit logs","sidebarTitle":"Overview","description":"Monitor Cognite Data Fusion (CDF) API activity with audit logs. Stream logs to your cloud storage, query them with Athena, Synapse, BigQuery, or any Delta Lake-compatible tool, and review event types for security and compliance.","content-type":"map","audience":"administrator","mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/admin/audit/index"},{"title":"About CDF audit logs","sidebarTitle":"About audit logs","description":"Learn about Cognite Data Fusion (CDF) audit logs, how they are structured, and how to use them to monitor access and activity in your projects.","content-type":"concept","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/admin/audit/about"},{"title":"Setting up audit log streaming","description":"Step-by-step guide to configuring continuous delivery of Cognite Data Fusion (CDF) audit logs to Azure Blob Storage, Amazon S3, or Google Cloud Storage.","content-type":"procedure","audience":"administrator","experience-level":200,"lifecycle":"setup","article-type":"article","href":"/cdf/admin/audit/streaming"},{"title":"Audit log query reference","sidebarTitle":"Query reference","description":"Reference for querying Cognite Data Fusion (CDF) audit logs stored as a Delta Lake table, with Spark query examples, Delta maintenance, and compatibility with Athena, Synapse, and BigQuery.","content-type":"reference","audience":"administrator","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/admin/audit/queries"},{"title":"Audit log event types reference","sidebarTitle":"Event types","description":"Complete reference of all eventType values recorded in Cognite Data Fusion (CDF) audit log entries, grouped by service name.","content-type":"reference","audience":"administrator","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/admin/audit/event-types"}]}]}]},{"tab":"Deploy","groups":[{"group":"Configure and deploy","pages":[{"title":"Deploying CDF","sidebarTitle":"Overview","description":"See who creates what when starting a Cognite Data Fusion (CDF) project, from access management to installing the Cognite Toolkit.","content-type":"map","audience":"administrator","experience-level":100,"mode":"wide","lifecycle":"use","article-type":"map","href":"/cdf/deploy"},{"group":"Scoping your CDF project","pages":[{"title":"Identify business objectives","description":"Before you begin implementing Cognite Data Fusion (CDF), make sure that you have a good understanding of your organization's current IT architecture and how CDF will fit in.","content-type":"conceptual","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_plan/cdf_plan_objectives"},{"title":"Data sources and integration","description":"What data you need to solve your business problems directly influences which data sources you choose to integrate with Cognite Data Fusion (CDF) first.","content-type":"conceptual","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_plan/cdf_plan_integration"},{"title":"Understand security, reliability, and service availability","description":"This article discusses the importance of security in protecting sensitive data and the reliability of Cognite Data Fusion with measures for high availability and disaster recovery.","content-type":"conceptual","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_deploy/cdf_deploy_security_reliability"}]},{"group":"Preparing for CDF deployment","pages":[{"title":"Planning your CDF implementation","sidebarTitle":"Overview","description":"Proper planning is crucial to manage the lifecycle of the applications, data integrations, and other modules implemented with Cognite Data Fusion (CDF).","content-type":"map","audience":"administrator","experience-level":100,"mode":"wide","lifecycle":"use","article-type":"map","href":"/cdf/deploy/cdf_plan/index"},{"title":"Configure access management","description":"Sequence the identity provider and access-group setup you complete as part of onboarding a new Cognite Data Fusion (CDF) project.","content-type":"procedure","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","keywords":"configure access management","href":"/cdf/deploy/cdf_deploy/cdf_deploy_access_management"},{"title":"Preparing for implementation","description":"Complete this upfront checklist with Cognite before your Cognite Data Fusion (CDF) implementation project starts.","content-type":"concept","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_plan/cdf_plan_prepare"},{"title":"Roles in a CDF implementation","description":"Implementing Cognite Data Fusion (CDF) projects often requires the expertise and skills of many individuals across different roles and responsibilities.","content-type":"concept","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_plan/cdf_plan_set_up_team"},{"title":"Resource naming reference","description":"Complete reference for recommended Cognite Data Fusion (CDF) resource naming conventions, including external IDs, display names, token grammars, and validation patterns.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/reference/cdf_resource_naming_conventions"},{"title":"Establish deployment workflows","description":"The main goal of establishing deployment workflows is to promote changes to production frequently, resulting in faster feedback and reduced risk.","content-type":"concept","audience":"administrator","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_deploy/cdf_deploy_devops_dataops"}]},{"group":"Deploying with the Cognite Toolkit","pages":[{"title":"Working with the Cognite Toolkit","sidebarTitle":"Overview","description":"Define the desired state of your Cognite Data Fusion (CDF) environments as files, then build and deploy with the Cognite Toolkit.","content-type":"map","audience":"administrator","experience-level":100,"mode":"wide","lifecycle":"use","article-type":"map","href":"/cdf/deploy/cdf_toolkit/index"},{"title":"Setting up the Cognite Toolkit locally","sidebarTitle":"Set up locally","description":"Install the Cognite Toolkit on your machine and initialize a new Cognite Data Fusion (CDF) project for local development and testing.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"setup","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/setup"},{"group":"Getting started","pages":[{"title":"Getting started with the Cognite Toolkit","sidebarTitle":"Getting started","description":"Learn how the Cognite Toolkit turns YAML files into Cognite Data Fusion configuration, from a new project through build and deploy.","content-type":"map","audience":["dataEngineer","administrator"],"experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/deploy/cdf_toolkit/getting_started/index"},{"title":"Initializing a Cognite Toolkit project","sidebarTitle":"Initialize","description":"Use cdf init to create cdf.toml, sign-in credentials, a modules directory, and CI/CD pipeline files for a new Cognite Toolkit project.","content-type":"procedure","audience":["administrator","dataEngineer"],"experience-level":100,"lifecycle":"setup","article-type":"article","href":"/cdf/deploy/cdf_toolkit/getting_started/init"},{"title":"Authenticating with the Cognite Toolkit","sidebarTitle":"Authenticate","description":"Sign in to the Cognite Toolkit as yourself, check which Cognite Data Fusion (CDF) resources you can change, or configure a service account for CI/CD.","content-type":"procedure","audience":["dataEngineer","administrator"],"experience-level":100,"lifecycle":"setup","article-type":"article","href":"/cdf/deploy/cdf_toolkit/getting_started/auth"},{"title":"Working with modules","sidebarTitle":"Modules","description":"List modules, pull Cognite Data Fusion (CDF) edits back into YAML, add a deployment pack, and upgrade Cognite Toolkit project files.","content-type":"procedure","audience":["dataEngineer","administrator"],"experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/getting_started/modules"},{"title":"Building configurations","sidebarTitle":"Build","description":"Validate Cognite Toolkit modules, substitute variables, and write the build directory that cdf deploy sends to CDF.","content-type":"procedure","audience":["dataEngineer","administrator"],"experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/getting_started/build"},{"title":"Deploying configurations","sidebarTitle":"Deploy","description":"Preview, apply, and delete Cognite Toolkit resources with cdf deploy and cdf clean, using one workflow file as the example.","content-type":"procedure","audience":["dataEngineer","administrator"],"experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/getting_started/deploy"}]},{"title":"Configure, build, and deploy modules","description":"Step-by-step guide to configuring access, selecting modules, building artifacts, and deploying them to a CDF project with the Cognite Toolkit.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/usage"},{"group":"Modules","pages":[{"title":"Modules","sidebarTitle":"Overview","description":"Learn how modules work in the Cognite Toolkit and choose between pre-built deployment packs and custom modules.","content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/modules/index"},{"title":"Customizing modules","description":"This article describes the design of the example modules and provides guidelines to create custom modules or to adjust the existing ones.","content-type":"concept","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/modules/custom"}]},{"group":"Deployment packs","pages":[{"title":"Deployment packs","sidebarTitle":"Overview","description":"Install pre-built deployment packs with the Cognite Toolkit to accelerate CDF project delivery.","content-type":"map","audience":"administrator","experience-level":100,"mode":"wide","lifecycle":"use","article-type":"map","href":"/cdf/deploy/cdf_toolkit/references/packages/index"},{"group":"Data foundation","pages":[{"title":"Foundation reference","sidebarTitle":"Foundation","description":"Deploy a production-ready CDF foundation with persona-based access groups, enterprise data models, extraction pipelines, and contextualization modules.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/references/packages/foundation"},{"title":"Foundation Demo DP reference","sidebarTitle":"Foundation Demo DP","description":"Deploy a complete end-to-end CDF demo environment in one pass — persona-based access groups, synthetic source ingestion, a CFIHOS enterprise data model, and contextualization.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/references/packages/quickstart"},{"title":"Reliability and Maintenance Data Model reference","sidebarTitle":"Reliability and Maintenance Data Model","description":"Deploy a standardized reliability and maintenance data model aligned with ISO 14224 and NORSOK Z-008 for CDF maintenance, root cause analysis, and condition-based maintenance use cases.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/references/packages/rmdm"},{"title":"Oil and Gas Data Model reference","sidebarTitle":"Oil and Gas Data Model","description":"Deploy a CFIHOS 2.0 and ISO 14224-based data model for oil and gas operations with denormalized, AI-ready views for AVEVA, SAP, OPC UA, and PI source systems.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/references/packages/oil_gas_data_model"},{"title":"ISA Data Model reference","sidebarTitle":"ISA Data Model","description":"Deploy an ISA-95 and ISA-88-based data model for batch and discrete manufacturing operations with an asset-centric, AI-ready structure for organizational hierarchy, batch control, and production management.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/references/packages/isa_data_model"},{"title":"P\u0026ID Annotation reference","sidebarTitle":"P\u0026ID Annotation","description":"Automate P\u0026ID diagram annotation in CDF with a workflow that tags assets and files, detects tags in diagrams, and links them to assets and files as data model annotations.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/references/packages/pid_annotation"},{"title":"File Annotation reference","sidebarTitle":"File Annotation","description":"Complete reference for the File Annotation deployment pack, which annotates piping and instrumentation diagrams (P\u0026IDs) and other documents in CDF with Diagram Detect, pattern mode, automatic promotion, and site or unit scoping.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/references/packages/file_annotation"},{"title":"CDF Entity Matching reference","sidebarTitle":"CDF Entity Matching","description":"Complete reference for the CDF Entity Matching deployment pack, which matches time series to assets with normalized aliases, manual mappings, regex rules, scoped matching, and AI-powered entity matching.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/references/packages/entity_matching"},{"title":"Atlas AI Property Extractor reference","sidebarTitle":"Atlas AI Property Extractor","description":"Extract structured property values from unstructured text in a CDF data model using an Atlas AI LLM agent, on a schedule, with add-new, append, and overwrite write modes.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/references/packages/atlas_ai_property_extractor"}]},{"group":"Applications","pages":[{"title":"InField Quickstart reference","sidebarTitle":"InField Quickstart","description":"Configure Cognite InField per location on the Core Data Model (CDM) and the Industry Data Model (IDM) — instance spaces, location configuration, role-based access groups, and a Fusion location filter for a single plant or site.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/references/packages/infield_quickstart"}]},{"group":"Test / verify","pages":[{"title":"Contextualization Quality Dashboard reference","sidebarTitle":"Contextualization Quality Dashboard","description":"Measure, monitor, and visualize contextualization quality in CDF across asset hierarchy, equipment, time series, maintenance, file annotation, and 3D — with a metrics function and a Streamlit dashboard.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/references/packages/contextualization_status"},{"title":"Qualitizer reference","sidebarTitle":"Qualitizer","description":"Run the Qualitizer web application to understand, troubleshoot, and improve the quality of your CDF deployment — with insights into access groups, data models, and job scheduling.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/references/packages/qualitizer"}]}]},{"title":"Upgrading the Cognite Toolkit CLI and modules","sidebarTitle":"Upgrading","description":"Follow these steps to upgrade the Cognite Toolkit CLI and modules to the latest version.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/upgrade"},{"title":"Authentication and authorization for Cognite Toolkit","description":"How you set up authentication and authorization for Cognite Toolkit depends on whether you'll use it in a CI/CD pipeline with full access or a local development environment with limited access.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/auth"},{"title":"Working with the Cognite Toolkit in a team","sidebarTitle":"Working in a team","description":"Learn how to prevent configuration conflicts with the Cognite Toolkit using multiple config files, git diff module selection, and deployment protection.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/working_in_team"},{"group":"API reference","pages":[{"title":"Configuring the Cognite Toolkit","sidebarTitle":"Overview","description":"Configure the Cognite Toolkit with settings for projects, modules, and environments.","content-type":"map","audience":"administrator","experience-level":100,"mode":"wide","lifecycle":"use","article-type":"map","href":"/cdf/deploy/cdf_toolkit/api/index"},{"title":"modules/","description":"The modules directory contains the modules with the configuration that the Cognite Toolkit reads, including resource directories for different CDF resource types.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/api/modules_dir"},{"title":"cdf.toml","description":"Use the cdf.toml file to configure the Cognite Toolkit CLI with settings for the organization directory, environment, plugins, and modules.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/api/cdf_toml"},{"title":"config.[env].yaml","description":"The config.[env].yaml file configures the modules for a specific environment, including project settings, selected modules, and variables.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/api/config_yaml"},{"title":"Alpha flags","description":"The Cognite Toolkit uses alpha flags to enable experimental functionality that is often planned for support in the next minor release.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/api/alpha_flags"},{"title":"Toolkit versions","description":"See what changed between Cognite Toolkit versions, including breaking changes and new commands.","content-type":"changelog","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/api/toolkit_update"},{"title":"Environment variables","description":"The Cognite Toolkit supports injecting environment variables into the configuration files to inject secrets or other sensitive information.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/api/environment_vars"}]},{"group":"CI/CD","pages":[{"title":"Setting up CI/CD for the Cognite Toolkit","sidebarTitle":"Overview","description":"Set up CI/CD for the Cognite Toolkit with GitHub Actions, Azure DevOps, or GitLab.","content-type":"map","audience":"administrator","experience-level":100,"mode":"wide","lifecycle":"use","article-type":"map","href":"/cdf/deploy/cdf_toolkit/guides/cicd/index"},{"title":"Setting up Azure DevOps pipelines","description":"Step-by-step guide to automate Cognite Toolkit deployments using Azure DevOps Pipelines with version control.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/cicd/ado_setup"},{"title":"Setting up GitHub Actions","description":"Configure GitHub Actions to build and deploy Cognite Toolkit modules. You create a workflow with jobs, add environment variables and secrets, run a dry-run, and verify deployments on the main branch.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/cicd/github_setup"},{"title":"Setting up GitLab CI/CD","description":"Configure GitLab CI/CD to build and deploy Cognite Toolkit modules. You create stages and jobs, add secure variables for authentication, run a dry run, and verify deployments on the main branch.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/cicd/gitlab_setup"}]},{"group":"Plugins","pages":[{"title":"Using Cognite Toolkit plugins","sidebarTitle":"Overview","description":"Plugins add extra functionality to interact with Cognite Data Fusion including run, pull, and dump capabilities.","content-type":"map","mode":"wide","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"map","href":"/cdf/deploy/cdf_toolkit/guides/plugins/index"},{"title":"Using the Run plugin","sidebarTitle":"Run plugin","description":"Use the Run plugin to run Cognite Functions locally and live, for example to debug or test Functions before deploying them to Cognite Data Fusion.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/run_plugin"},{"title":"Using the Pull plugin","sidebarTitle":"Pull plugin","description":"Use the Pull plugin to develop a configuration in Cognite Data Fusion and pull the configuration down to your local machine.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/pull_plugin"},{"title":"Using the Dump plugin","sidebarTitle":"Dump plugin","description":"Use the Dump plugin to download the configuration of a Cognite Data Fusion resource that is not governed by the Cognite Toolkit.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/dump_plugin"},{"group":"Data plugin","pages":[{"title":"Using the Data plugin","sidebarTitle":"Overview","description":"Use the Data plugin to download, upload, and delete data in Cognite Data Fusion (CDF).","content-type":"map","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"map","href":"/cdf/deploy/cdf_toolkit/guides/plugins/data_plugin/index"},{"title":"Download data using the Data plugin","sidebarTitle":"Download","description":"Use the Data plugin to download data from Cognite Data Fusion to your local machine.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/data_plugin/download"},{"title":"Upload data using the Data plugin","sidebarTitle":"Upload","description":"Run cdf data upload with manifest files to send structured data from your machine to Cognite Data Fusion (CDF), including optional --deploy-resources and per-type manifest formats.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/data_plugin/upload"},{"title":"Purge data using the Data plugin","sidebarTitle":"Purge","description":"Use the Data plugin to delete data from Cognite Data Fusion (CDF).","content-type":"procedure","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/data_plugin/purge"}]},{"group":"Migration plugin","pages":[{"title":"Using the migration plugin","sidebarTitle":"Overview","description":"Use the migration plugin to migrate from an asset-centric to a data modeling-based Cognite Data Fusion (CDF) project.","content-type":"map","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"map","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/index"},{"group":"Get started","pages":[{"title":"About the Kelmarsh example","sidebarTitle":"Kelmarsh example","description":"Learn about the Kelmarsh wind farm sample data and how the Cognite Data Fusion (CDF) migration plugin guides use it.","content-type":"concept","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/example"},{"title":"Known limitations","sidebarTitle":"Known limitations","description":"Known limitations in data modeling that do not yet have feature parity with asset-centric CDF projects.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/known_limitations"},{"title":"Migrating from asset-centric to data modeling-based projects","sidebarTitle":"Migration overview","description":"Follow the recommended sequence to migrate from asset-centric to data modeling-based Cognite Data Fusion (CDF) projects with the Cognite Toolkit.","content-type":"concept","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/steps"},{"title":"Testing migration of production data in a development project","sidebarTitle":"Test with production data","description":"Replicate production data to a development CDF project so you can test a migration command before running it in production.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/test_data"}]},{"group":"Prepare","pages":[{"title":"Creating a data model and mappings","sidebarTitle":"Data model and mappings","description":"Step-by-step guide to create a Cognite Core Data Model (CDM) target data model and resource view mappings before you migrate asset-centric resources.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/data_model_migration"},{"title":"Deploying the CogniteMigration data model","sidebarTitle":"Deploy CogniteMigration","description":"Deploy the CogniteMigration data model to prepare for migration from an asset-centric to a data modeling-based Cognite Data Fusion (CDF) project.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/prepare"}]},{"group":"Migrate resources","pages":[{"title":"Migrating data sets","sidebarTitle":"Migrate data sets","description":"Step-by-step guide to migrate asset-centric data sets to instance spaces in a data modeling-based Cognite Data Fusion (CDF) project.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/datasets"},{"title":"Migrating source systems","sidebarTitle":"Migrate source systems","description":"Step-by-step guide to create CogniteSourceSystem nodes from the source field on assets, events, and files.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/source_systems"},{"title":"Migrating assets","sidebarTitle":"Migrate assets","description":"Step-by-step guide to migrate assets from an asset-centric to a data modeling-based Cognite Data Fusion (CDF) project.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/assets"},{"title":"Migrating events","sidebarTitle":"Migrate events","description":"Step-by-step guide to migrate events from an asset-centric to a data modeling-based Cognite Data Fusion (CDF) project.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/events"},{"title":"Migrating events to records","sidebarTitle":"Migrate events to records","description":"Step-by-step guide to migrate system-generated events from an asset-centric Cognite Data Fusion (CDF) project to records using the Streams API.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/events_to_records"},{"title":"Migrating files and time series","sidebarTitle":"Migrate files and time series","description":"Step-by-step guide to migrate files and time series from an asset-centric to a data modeling-based Cognite Data Fusion (CDF) project.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/files_timeseries"},{"title":"Migrating annotations","sidebarTitle":"Migrate annotations","description":"Step-by-step guide to migrate file annotations from an asset-centric to a data modeling-based Cognite Data Fusion (CDF) project.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/annotations"}]},{"group":"Migrate applications","pages":[{"title":"Migrating Canvas","sidebarTitle":"Migrate Canvas","description":"Step-by-step guide to migrate asset-centric Canvas configurations to a data modeling-based Cognite Data Fusion (CDF) project.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/canvas"},{"title":"Migrating Charts","sidebarTitle":"Migrate Charts","description":"Step-by-step guide to migrate asset-centric Charts configurations to a data modeling-based Cognite Data Fusion (CDF) project.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/charts"},{"title":"Migrating InField","sidebarTitle":"Migrate InField","description":"Step-by-step guide to migrate asset-centric InField configuration and data to InField on the Cognite Core Data Model (CDM).","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/infield"},{"title":"Migrating 3D models","sidebarTitle":"Migrate 3D models","description":"Step-by-step guide to migrate 3D models from an asset-centric to a data modeling-based Cognite Data Fusion (CDF) project.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/3d"},{"title":"Migrating 360 images","sidebarTitle":"Migrate 360 images","description":"Step-by-step guide to migrate 360 images and annotations from an asset-centric to a data modeling-based Cognite Data Fusion (CDF) project.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/360_images"}]},{"group":"Reference","pages":[{"title":"Understanding data modeling syncers","sidebarTitle":"Syncers","description":"Learn how Cognite Data Fusion (CDF) uses syncers to manage CogniteFile and CogniteTimeSeries data model concepts.","content-type":"concept","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/guides/plugins/migration_plugin/syncers"}]}]}]},{"title":"YAML reference library","description":"The YAML resource configuration files are core to the Cognite Toolkit, with each file configuring one of the resource types supported by the Cognite Toolkit and the Cognite API.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/cdf_toolkit/references/resource_library"}]},{"group":"Developing data models with NEAT","pages":[{"title":"Developing data models with NEAT","sidebarTitle":"Overview","description":"Develop, validate, and deploy data models to Cognite Data Fusion with the NEAT toolkit.","content-type":"map","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/cdf/deploy/neat/index"},{"title":"Setting up NEAT","sidebarTitle":"Setting up","description":"Step-by-step guide to install NEAT in CDF Notebooks or locally with Jupyter Lab.","content-type":"procedure","audience":"dataEngineer","experience-level":100,"href":"/cdf/deploy/neat/installation"},{"group":"Data modeling","pages":[{"title":"About data modeling principles","description":"Learn principles and best practices for organizing data models across an organization, including Enterprise and Solution model ownership.","content-type":"concept","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/cdf/deploy/neat/data_modeling/principles"},{"title":"About data modeling modes","description":"Learn about additive and rebuild modes for deploying data model changes with NEAT. Understand when to use each mode.","content-type":"concept","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/data_modeling/modes"},{"group":"Data modeling in Excel","pages":[{"title":"Modeling data in Excel","sidebarTitle":"Overview","description":"Use Excel templates to create and modify data models with NEAT.","content-type":"map","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/data_modeling/excel/overview"},{"title":"About the physical data model","description":"Learn about the physical data model and how it implements your conceptual model in CDF Data Modeling Service (DMS).","content-type":"concept","audience":"dataEngineer","experience-level":200,"href":"/cdf/deploy/neat/data_modeling/excel/physical/overview"},{"title":"Physical data model reference","description":"Reference for the physical data model sheets and fields in NEAT Excel templates.","content-type":"reference","audience":"dataEngineer","experience-level":200,"href":"/cdf/deploy/neat/data_modeling/excel/physical/reference"},{"title":"Properties sheet reference","description":"Complete reference for properties sheet fields and syntax in the NEAT physical data model.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/data_modeling/excel/physical/properties"},{"title":"Views sheet reference","description":"Complete reference for views and filters in the NEAT physical data model Excel sheet, including filter syntax and examples.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/data_modeling/excel/physical/views"},{"title":"Enum sheet reference","description":"Complete reference for defining and referencing enumerations in the NEAT physical data model Excel sheet.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/data_modeling/excel/physical/enum"},{"title":"Units reference","description":"Complete reference for units available in Cognite Data Fusion for use in NEAT physical data model properties.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/data_modeling/excel/physical/units"}]}]},{"group":"Reference","pages":[{"title":"Using the Neat reference","sidebarTitle":"Overview","article-type":"map","description":"Find API and configuration reference for NeatSession, NeatConfig, alpha flags, and validation rules.","content-type":"map","audience":"dataEngineer","experience-level":200,"href":"/cdf/deploy/neat/reference/index"},{"group":"Validation rules","pages":[{"title":"Validation rules","sidebarTitle":"Overview","description":"Overview of the validation rules supported by NEAT to ensure your data model adheres to best practices.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/index"},{"group":"AI readiness","pages":[{"title":"DataModelMissingName validation rule","description":"Validates that the data model has a human-readable name. Ensures usability, maintainability, searchability, and AI-readiness.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-ai-readiness-001"},{"title":"DataModelMissingDescription validation rule","description":"Validates that the data model has a human-readable description. Ensures users understand the purpose, scope, and use cases.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-ai-readiness-002"},{"title":"ViewMissingName validation rule","description":"Validates that each view in the data model has a human-readable name. Ensures usability, maintainability, searchability, and AI-readiness.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-ai-readiness-003"},{"title":"ViewMissingDescription validation rule","description":"Validates that each view in the data model has a human-readable description. Ensures users understand the view's purpose, scope, and usage.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-ai-readiness-004"},{"title":"ViewPropertyMissingName validation rule","description":"Validates that each view property in the data model has a human-readable name. Improves usability, maintainability, and AI-readiness.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-ai-readiness-005"},{"title":"ViewPropertyMissingDescription validation rule","description":"Validates that each view property in the data model has a human-readable description. Ensures users understand the property's purpose, scope, and usage.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-ai-readiness-006"},{"title":"EnumerationMissingName validation rule","description":"Validates that each enumeration value in the data model has a human-readable name. Improves usability, maintainability, and AI-readiness.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-ai-readiness-007"},{"title":"EnumerationMissingDescription validation rule","description":"Validates that each enumeration value in the data model has a human-readable description. Ensures users understand the value's meaning and usage context.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-ai-readiness-008"}]},{"group":"Connections","pages":[{"title":"ConnectionValueTypeUnexisting validation rule","description":"Validates that all connection value types defined in the data model exist. Ensures the data model can be deployed to CDF.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-connections-001"},{"title":"ConnectionValueTypeUndefined validation rule","description":"Validates that all connections have explicitly defined value types. Prevents ambiguous data model definitions that may cause issues when consuming data from CDF.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-connections-002"},{"title":"ReverseConnectionSourceViewMissing validation rule","description":"Validates that the source view referenced in a reverse connection exists. Ensures the reverse connection can function correctly.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-connections-reverse-001"},{"title":"ReverseConnectionSourcePropertyMissing validation rule","description":"Validates that the direct connection property referenced in a reverse connection's 'through' clause exists in the source view.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-connections-reverse-002"},{"title":"ReverseConnectionSourcePropertyWrongType validation rule","description":"Validates that the property referenced in a reverse connection's 'through' clause is a direct connection property, not a primitive or other type.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-connections-reverse-003"},{"title":"ReverseConnectionContainerMissing validation rule","description":"Validates that the container holding the direct connection property (used in a reverse connection) exists. Ensures the connection can be persisted.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-connections-reverse-004"},{"title":"ReverseConnectionContainerPropertyMissing validation rule","description":"Validates that the container property mapped from the view's direct connection property actually exists in the container.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-connections-reverse-005"},{"title":"ReverseConnectionContainerPropertyWrongType validation rule","description":"Validates that the container property mapped from the view's direct connection property has type DirectNodeRelation. Ensures connections can be stored correctly.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-connections-reverse-006"},{"title":"ReverseConnectionTargetMissing validation rule","description":"Validates that the direct connection property referenced by a reverse connection has a value type specified. Recommends explicit target view for clarity.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-connections-reverse-007"},{"title":"ReverseConnectionPointsToAncestor validation rule","description":"Validates that direct connection properties point to specific target views rather than ancestor views. Recommends the specific target for clarity.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-connections-reverse-008"},{"title":"ReverseConnectionTargetMismatch validation rule","description":"Validates that the direct connection property points to the expected target view (the view containing the reverse connection). Ensures bidirectional relationships are correct.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-connections-reverse-009"}]},{"group":"Consistency","pages":[{"title":"ViewSpaceVersionInconsistentWithDataModel validation rule","description":"Validates that all views in the data model have the same space and version as the data model. Reduces deployment and maintenance complexity.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-consistency-001"}]},{"group":"Containers","pages":[{"title":"ExternalContainerDoesNotExist validation rule","description":"Validates that any container referenced by a view property, when the referenced container does not belong to the data model's space, exists in CDF.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-container-001"},{"title":"ExternalContainerPropertyDoesNotExist validation rule","description":"Validates that any container property referenced by a view property, when the referenced container does not belong to the data model's space, exists in CDF.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-container-002"},{"title":"RequiredContainerDoesNotExist validation rule","description":"Validates that any container required by another container exists in the data model.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-container-003"},{"title":"RequiresConstraintCycle validation rule","description":"Validates that requires constraints between containers do not form cycles. Deployment will fail if cycles exist.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-container-005"}]},{"group":"Limits","pages":[{"title":"ContainerPropertyCountIsOutOfLimits validation rule","description":"Validates that containers do not exceed the maximum number of properties allowed by CDF. Ensures optimal performance and deployment success.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-limits-container-001"},{"title":"ContainerPropertyListSizeIsOutOfLimits validation rule","description":"Validates that container property list sizes (max_list_size) do not exceed CDF limits based on data type and indexing. Ensures optimal performance.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-limits-container-002"},{"title":"DataModelViewCountIsOutOfLimits validation rule","description":"Validates that the data model does not exceed the maximum number of views allowed by CDF. Ensures optimal performance and deployment success.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-limits-data-model-001"},{"title":"ViewPropertyCountIsOutOfLimits validation rule","description":"Validates that views do not exceed the maximum number of properties allowed by CDF. Ensures optimal performance and deployment success.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-limits-view-001"},{"title":"ViewContainerCountIsOutOfLimits validation rule","description":"Validates that views do not reference more containers than the CDF limit allows. Prevents performance issues from excessive joins.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-limits-view-002"},{"title":"ViewImplementsCountIsOutOfLimits validation rule","description":"Validates that views do not implement more other views than the CDF limit allows. Prevents overly deep inheritance hierarchies.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-limits-view-003"}]},{"group":"Performance","pages":[{"title":"MissingRequiresConstraint validation rule","description":"Recommends adding requires constraints to optimize query performance. Identifies views where adding a constraint would improve query efficiency.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-performance-001"},{"title":"SuboptimalRequiresConstraint validation rule","description":"Recommends removing requires constraints that are not optimal for querying. Identifies redundant or unnecessary constraints that can be safely removed.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-performance-002"},{"title":"UnresolvableQueryPerformance validation rule","description":"Identifies views with query performance issues that cannot be resolved by adding or removing requires constraints. Requires restructuring to fix.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-performance-003"},{"title":"MissingReverseDirectRelationTargetIndex validation rule","description":"Recommends adding a cursorable index on direct relation properties that are targets of reverse direct relations for query performance.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-performance-004"}]},{"group":"Views","pages":[{"title":"ViewToContainerMappingNotPossible validation rule","description":"Validates that the container and container property referenced by each view property exist. Ensures the data model can be deployed to CDF.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-view-001"},{"title":"ImplementedViewNotExisting validation rule","description":"Validates that all implemented (inherited) views in the data model actually exist either locally or in CDF. Ensures deployment success.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-view-002"},{"title":"CyclicImplements validation rule","description":"Validates that view implements do not form a cycle (cyclic graph). Cyclic implements prevent deployment to CDF.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-view-003"},{"title":"DataModelViewDoesNotExist validation rule","description":"Validates that all views referenced in the data model actually exist either locally or in CDF. Ensures deployment success.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/validation/neat-dms-view-004"}]}]},{"title":"NeatSession reference","description":"Complete reference for the NeatSession class, the main interface for working with NEAT.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/reference/session"},{"title":"NeatConfig reference","description":"Complete reference for configuring your NEAT session with data modeling modes and validation rules.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/reference/config"},{"title":"Alpha flags reference","description":"Complete reference for Neat alpha feature flags that enable experimental and early-access functionality.","content-type":"reference","audience":"dataEngineer","experience-level":200,"lifecycle":"use","href":"/cdf/deploy/neat/reference/alpha_flags"}]},{"title":"Read and write CDF data models with NEAT","description":"Learn to read and write CDF physical data models using NeatSession, explore validator insights, and perform dry-run deployments.","content-type":"tutorial","audience":"dataEngineer","experience-level":100,"lifecycle":"setup","href":"/cdf/deploy/neat/tutorials/introduction"},{"title":"Known issues with NEAT","sidebarTitle":"Known issues","description":"Known issues and workarounds when using NEAT, including ad-blocker conflicts and NeatSession initialization errors.","content-type":"troubleshooting","audience":"dataEngineer","experience-level":100,"lifecycle":"support","href":"/cdf/deploy/neat/known_issues"}]}]}]},{"tab":"Develop","groups":[{"group":"Develop","pages":[{"title":"Building with Cognite Data Fusion","sidebarTitle":"Overview","description":"Use the Cognite API and SDKs to retrieve data, add context, and develop applications that match your operational needs.","content-type":"map","audience":"developer","experience-level":"100","lifecycle":"investigate","mode":"wide","article-type":"map","href":"/dev"},{"group":"Getting started","pages":[{"title":"Development quickstart","sidebarTitle":"Quickstart","description":"Get your first API response in 5 minutes using Postman. Try with Open Industrial Data (no admin setup) or connect to your CDF project.","content-type":"quickstart","audience":"developer","experience-level":200,"lifecycle":"setup","article-type":"article","href":"/dev/quickstart"},{"title":"Use the API","description":"Learn how to construct requests to access resources in Cognite Data Fusion using the RESTful web API, including HTTP methods, versioning, and resource types.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/dev/use_the_API"},{"title":"API versions","description":"Learn about Cognite API versioning, the policy for backwards compatibility, and the end-of-life schedule for the APIs.","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/dev/API_versioning"},{"title":"About authentication credentials","description":"Learn about IdP credentials, CDF authentication, and common troubleshooting for developers.","content-type":"concept","audience":"developer","experience-level":200,"article-type":"article","lifecycle":"use","href":"/dev/guides/iam/authentication_credentials_guide"},{"title":"Set up Postman with Cognite API","description":"Step-by-step guide to configure Postman with OpenID Connect authentication to test Cognite API requests and verify responses.","content-type":"procedure","audience":["developer"],"experience-level":"100","lifecycle":"setup","article-type":"article","href":"/dev/guides/postman"},{"title":"Connecting your IDE to Cognite documentation","description":"Step-by-step guide to connect your development environment to Cognite's documentation through MCP server and SKILL.md integration.","content-type":"procedure","audience":"developer","experience-level":"100","lifecycle":"setup","href":"/dev/guides/ide_ai_integration"}]},{"group":"API guides","pages":[{"title":"Define unique IDs with externalId","description":"Learn how to use the externalId field to define unique IDs for data objects in CDF and maintain relationships between source systems.","content-type":"concept","audience":["developer","dataEngineer"],"experience-level":100,"article-type":"article","lifecycle":"use","href":"/dev/concepts/external_id"},{"title":"Pagination","description":"Learn how to paginate CDF resources using cursors, including parallel retrieval techniques and datapoint pagination strategies.","content-type":"concept","audience":["developer","dataEngineer"],"experience-level":200,"article-type":"article","lifecycle":"use","href":"/dev/concepts/pagination"},{"title":"API rate limits","sidebarTitle":"Rate limits","description":"Rate and concurrency limits for Cognite Data Fusion (CDF) API endpoints.","content-type":"reference","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/rate-limits"},{"group":"Time series","pages":[{"title":"Working with time series data","description":"Learn how to aggregate, subscribe to, and visualize time series data using the CDF API.","content-type":"map","audience":["developer","dataEngineer"],"experience-level":100,"href":"/dev/concepts/time_series_index"},{"title":"Aggregation","description":"Learn how Cognite Data Fusion (CDF) aggregates and interpolates time series data, and see details about the available aggregation functions.","content-type":"concept","audience":["developer","dataEngineer","dataScientist"],"experience-level":100,"article-type":"article","lifecycle":"use","href":"/dev/concepts/aggregation/index"},{"title":"Calendar and time zone","description":"Learn how to use Cognite Data Fusion in a local time zone with queries that span over calendar entities like months.","content-type":"concept","audience":["developer","dataEngineer"],"experience-level":200,"lifecycle":"use","href":"/dev/concepts/aggregation/calendar"},{"title":"Gap filling","description":"Reconstruct compressed historian data: enable server-side interpolation and extrapolation on aggregate queries with the fill parameter.","content-type":"concept","audience":["developer","dataEngineer","dataScientist"],"experience-level":200,"article-type":"article","lifecycle":"use","href":"/dev/concepts/aggregation/gap_filling"},{"title":"Data point subscriptions","description":"Learn how to subscribe to time series updates in real-time using data point subscriptions to monitor changes across large sets of time series.","content-type":"concept","audience":["developer","dataEngineer"],"experience-level":100,"article-type":"article","lifecycle":"use","href":"/dev/concepts/data_point_subscriptions/index"},{"title":"Status codes","description":"Learn how status codes determine the quality of time series data points and impact data retrieval, aggregate computation, and visualization.","content-type":"reference","audience":["developer","dataEngineer"],"experience-level":200,"article-type":"article","lifecycle":"use","href":"/dev/concepts/reference/status_codes"},{"title":"State time series","description":"Track discrete operational states of industrial equipment with predefined valid states and specialized aggregations optimized for analyzing state changes.","content-type":"concept","audience":["developer","dataEngineer"],"experience-level":200,"lifecycle":"use","article-type":"article","href":"/dev/concepts/resource_types/state_timeseries"},{"title":"Best practices for plotting charts with data points","description":"Learn how to use the Time Series API to render precise, high fidelity charts with proper aggregation and data point handling.","content-type":"reference","audience":["developer","dataScientist","dataEngineer"],"experience-level":200,"article-type":"article","lifecycle":"use","href":"/dev/concepts/reference/ts_plotting_charts"}]},{"group":"Units","pages":[{"title":"Units overview","sidebarTitle":"Overview","description":"Learn how to use units in Cognite Data Fusion (CDF) to standardize measurement data and enable seamless unit conversion.","content-type":"map","audience":"developer","experience-level":200,"href":"/dev/concepts/resource_types/units/index"},{"title":"About units in CDF","description":"Learn how to use Units in Cognite Data Fusion (CDF) to standardize measurement data and enable seamless unit conversion across time series, data models, and records.","content-type":"concept","toc":{"min-heading-level":2,"max-heading-level":4},"audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/dev/concepts/resource_types/units/units"},{"title":"Contributing to the unit catalog","description":"Learn how to contribute new units and unit systems to the Cognite global unit catalog through GitHub.","content-type":"procedure","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/dev/concepts/resource_types/units/contribute"},{"title":"Unit catalog changelog","url":"https://github.com/cognitedata/units-catalog/blob/main/CHANGELOG.md","description":null,"href":"/dev/concepts/resource_types/units/changelog"}]},{"group":"AI features","pages":[{"title":"Using AI features","description":"Learn how to use AI-powered APIs to search, summarize, and ask questions about documents in CDF.","content-type":"map","audience":["developer","aiEngineer","dataScientist"],"experience-level":200,"href":"/dev/guides/ai/index"},{"title":"Document question answering","description":"Learn how to use the AI-powered Document question answering API to ask questions about PDF documents uploaded to CDF.","content-type":"procedure","audience":["developer","aiEngineer","dataScientist"],"experience-level":200,"article-type":"article","lifecycle":"use","href":"/dev/guides/ai/document_qa"},{"title":"Document summary","description":"Learn how to use the AI-powered Document summary API to create summaries for PDF documents uploaded to CDF.","content-type":"procedure","audience":["developer","aiEngineer","dataScientist"],"experience-level":200,"article-type":"article","lifecycle":"use","href":"/dev/guides/ai/document_summarization"},{"title":"Semantic search","description":"Learn how to use the Semantic search API to find texts with similar semantic meaning in PDF documents using vector embeddings.","content-type":"procedure","audience":["developer","aiEngineer","dataScientist"],"experience-level":200,"article-type":"article","lifecycle":"use","href":"/dev/guides/ai/semantic_search"}]},{"title":"Entity matching","description":"Learn how to use entity matching to contextualize data with machine learning by matching entities like time series, files, and sequences to assets.","content-type":"concept","audience":["developer","dataEngineer"],"experience-level":200,"article-type":"article","lifecycle":"use","href":"/dev/concepts/resource_types/entity_matching"},{"title":"Geospatial","description":"Learn how to store and query geospatial features with spatial representations, coordinate reference systems, and complex filtering in CDF.","content-type":"concept","audience":["developer","dataEngineer"],"experience-level":200,"article-type":"article","lifecycle":"use","href":"/dev/concepts/resource_types/geospatial"},{"group":"3D","pages":[{"title":"Working with 3D APIs","sidebarTitle":"Overview","description":"Upload and contextualize CAD models, point clouds, and 360° images in Cognite Data Fusion (CDF) using the 3D API endpoints.","content-type":"map","audience":"developer","mode":"wide","experience-level":200,"lifecycle":"use","article-type":"map","href":"/dev/3d/index"},{"group":"Upload","pages":[{"title":"Upload 3D models programmatically","sidebarTitle":"CAD models","description":"Learn how to upload multiple 3D models to Cognite Data Fusion (CDF) using the Cognite API and SDKs for automated updates.","content-type":"procedure","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/dev/3d/api_asset_centric/upload_cad"},{"title":"Upload point clouds with Python SDK","sidebarTitle":"Point clouds","description":"Upload large point clouds to Cognite Data Fusion (CDF) using Python SDK to avoid file transfer failures and long upload times.","content-type":"procedure","audience":"dataEngineer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/dev/3d/api_asset_centric/upload_pointcloud"},{"title":"Upload 360° images programmatically","sidebarTitle":"360° images","description":"Trigger 360° image extraction from E57 files with Python or upload and register custom 360° formats using the Files API and Data Modeling Service (DMS).","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/dev/3d/api_asset_centric/upload_360"}]},{"group":"Contextualize","pages":[{"title":"Contextualizing 3D data","sidebarTitle":"Overview","description":"Link CAD models, point clouds, and 360° images to assets using data modeling or legacy and hybrid contextualization APIs in Cognite Data Fusion (CDF).","content-type":"map","audience":"developer","mode":"wide","experience-level":200,"lifecycle":"use","article-type":"map","href":"/dev/3d/contextualize_index"},{"title":"About 3D contextualization APIs","sidebarTitle":"About contextualization APIs","description":"Learn which APIs to use for 3D contextualization in asset-centric (legacy), hybrid, and data modeling projects in Cognite Data Fusion (CDF).","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/dev/3d/api_dmonly/3d_contextualization_apis"},{"group":"Data modeling","pages":[{"title":"Contextualize CAD models in data modeling projects","sidebarTitle":"CAD models","description":"Use 3D nodes to review CAD node metadata and the CAD contextualization API to contextualize by linking CAD nodes to CogniteAsset instances.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/dev/3d/api_dmonly/contextualize_cad_dm"},{"title":"Contextualize point clouds in data modeling projects","sidebarTitle":"Point clouds","description":"Use 3D jobs to generate point cloud volume suggestions and the point cloud contextualization API to create approvals that link suggested volumes to CogniteAsset instances.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/dev/3d/api_dmonly/contextualize_pointcloud_dm"},{"title":"Contextualize 360° images in data modeling projects","sidebarTitle":"360° images","description":"Use 3D jobs (ImageTextDetection) and the 360 image contextualization API to link 360° text regions to CogniteAsset instances.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/dev/3d/api_dmonly/contextualize_360_dm"}]},{"group":"Legacy and hybrid","pages":[{"title":"Contextualize CAD models in asset-centric and hybrid projects","sidebarTitle":"CAD models","description":"Review CAD node metadata through the 3D nodes endpoints and contextualize by linking CAD nodes to assets using 3D asset mappings.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/dev/3d/api_asset_centric/contextualize_cad"},{"title":"Contextualize point clouds in asset-centric and hybrid projects","sidebarTitle":"Point clouds","description":"Generate point cloud volume suggestions during processing and contextualize by creating point cloud bounding volume annotations linked to assets.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/dev/3d/api_asset_centric/contextualize_pointcloud"},{"title":"Contextualize 360° images in asset-centric and hybrid projects","sidebarTitle":"360° images","description":"Use the Vision API for text detection on 360° images. The bounding boxes with detected text can then be contextualized towards assets.","content-type":"procedure","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","href":"/dev/3d/api_asset_centric/contextualize_360"}]}]}]},{"group":"Advanced querying","pages":[{"title":"Advanced querying","description":"Learn how to use advanced query language (AQL) for search, filter, sort, and aggregation operations on CDF resources.","content-type":"concept","audience":["developer","dataEngineer","dataScientist"],"experience-level":100,"article-type":"article","lifecycle":"use","href":"/dev/guides/advanced-query/advanced_query_intro"},{"title":"Filtering","description":"Learn how to build complex queries with boolean logic, leaf filters, and advanced query operations in CDF.","content-type":"reference","audience":["developer","dataEngineer"],"experience-level":200,"article-type":"article","lifecycle":"use","href":"/dev/guides/advanced-query/filtering"},{"title":"Aggregation types","description":"Learn about advanced aggregation APIs including count, cardinality, unique values, and unique properties for contextualizing data.","content-type":"reference","audience":["developer","dataEngineer"],"experience-level":200,"article-type":"article","lifecycle":"use","href":"/dev/guides/advanced-query/aggregation_types"}]}]}]},{"group":"SDKs and toolkits","pages":[{"title":"Overview of SDKs and toolkits","sidebarTitle":"Overview","description":"Overview of Cognite Data Fusion (CDF) SDKs and toolkits, including general, specialized, and industry SDKs, as well as supported languages and tools.","mode":"wide","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/dev/sdks/index"},{"group":"Python SDK","icon":"python","pages":[{"title":"Register an app in Entra ID","description":"Learn how to register an application in Entra ID for use with the Python SDK, Jupyter notebooks, or Postman with interactive authentication.","content-type":"procedure","audience":["developer","administrator"],"experience-level":100,"lifecycle":"setup","article-type":"article","href":"/dev/sdks/python/register_app_jupyter_sdk"},{"title":"Authenticate with Entra ID","description":"Learn how to authenticate the Python SDK with Entra ID using user credentials, interactive login, device code, or client secrets.","content-type":"procedure","audience":["developer","dataEngineer"],"experience-level":100,"lifecycle":"setup","article-type":"article","href":"/dev/sdks/python/python_auth_oidc"},{"title":"Usage","url":"https://cognite-sdk-python.readthedocs-hosted.com/en/stable/","description":null,"href":"/dev/sdks/python/usage"},{"title":"GitHub","url":"https://github.com/cognitedata/cognite-sdk-python","description":null,"href":"/dev/sdks/python/github"},{"title":"Changelog","url":"https://github.com/cognitedata/cognite-sdk-python/blob/master/CHANGELOG.md","description":null,"href":"/dev/sdks/python/changelog"}]},{"group":"JavaScript SDK","icon":"js","pages":[{"title":"Get started with JavaScript SDK","sidebarTitle":"Get started","description":"Learn how to install the JavaScript SDK, authenticate with OAuth, and build web and backend applications with Cognite Data Fusion.","content-type":"quickstart","audience":["developer"],"experience-level":200,"lifecycle":"setup","article-type":"map","href":"/dev/sdks/js/index"},{"title":"Upgrade JavaScript SDK","sidebarTitle":"Upgrade","description":"Learn how to upgrade the JavaScript SDK from version 1.x to 2.x and from 2.x to 3.x with migration guides and code examples.","content-type":"reference","audience":["developer"],"experience-level":"200","lifecycle":"use","article-type":"article","href":"/dev/sdks/js/migration"},{"title":"Authentication","url":"https://github.com/cognitedata/cognite-sdk-js/blob/master/guides/authentication.md","description":null,"href":"/dev/sdks/js/authentication"},{"title":"Usage","url":"https://cognitedata.github.io/cognite-sdk-js/","description":null,"href":"/dev/sdks/js/usage"},{"title":"GitHub","url":"https://github.com/cognitedata/cognite-sdk-js","description":null,"href":"/dev/sdks/js/github"},{"title":"Changelog","url":"https://github.com/cognitedata/cognite-sdk-js/blob/master/packages/stable/CHANGELOG.md","description":null,"href":"/dev/sdks/js/changelog"}]},{"title":"Java SDK","url":"https://github.com/cognitedata/cdf-sdk-java","icon":"java","description":null,"href":"/dev/sdks/java_sdk"},{"title":"Scala SDK","url":"https://github.com/cognitedata/cognite-sdk-scala","icon":"code","description":null,"href":"/dev/sdks/scala_sdk"},{"title":"Rust SDK","url":"https://github.com/cognitedata/cognite-sdk-rust","icon":"rust","description":null,"href":"/dev/sdks/rust_sdk"},{"title":".Net SDK","url":"https://github.com/cognitedata/cognite-sdk-dotnet","icon":"microsoft","description":null,"href":"/dev/sdks/dotnet_sdk"},{"group":"Specialized SDKs","pages":[{"title":"Working with specialized SDKs","sidebarTitle":"About specialized SDKs","description":"Explore specialized SDKs for 3D visualization, geospatial data, and Apache Spark integration.","content-type":"map","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","href":"/dev/sdks/specialized_sdks"},{"title":"Reveal 3D SDK","url":"https://cognitedata.github.io/reveal-docs/docs/","icon":"box","description":null,"href":"/dev/sdks/reveal_3d_sdk"},{"title":"Spark Data Source","url":"https://github.com/cognitedata/cdp-spark-datasource/blob/master/README.md","icon":"bolt","description":null,"href":"/dev/sdks/spark_data_source"},{"title":"Geospatial SDK","url":"https://github.com/cognitedata/cognite-sdk-geospatial","icon":"map","description":null,"href":"/dev/sdks/geospatial_sdk"}]},{"group":"Toolkits","pages":[{"group":"Data modeling SDK generator","icon":"package","pages":[{"title":"Python Data Modeling SDK Generator (Pygen)","sidebarTitle":"Pygen","description":"Learn about Pygen, a Python package and CLI for generating Python SDKs from Cognite Data Fusion data models for exploration, development, and data population.","content-type":"concept","audience":["developer","dataEngineer"],"experience-level":100,"lifecycle":"use","article-type":"map","href":"/dev/sdks/pygen/index"},{"title":"Usage","url":"https://cognite-pygen.readthedocs-hosted.com/en/latest/usage/generation.html","description":null,"href":"/dev/sdks/pygen/usage"},{"title":"GitHub","url":"https://github.com/cognitedata/pygen","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","description":null,"href":"/dev/sdks/pygen/github"},{"title":"Changelog","url":"https://github.com/cognitedata/pygen/releases","description":null,"href":"/dev/sdks/pygen/changelog"}]},{"title":"Python extractor utils","url":"https://cognite-extractor-utils.readthedocs-hosted.com/en/latest/","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","description":null,"href":"/dev/sdks/extractor_utils"},{"title":"Simulator utils","url":"https://cognitedata.github.io/dotnet-simulator-utils/","content-type":"reference","audience":"developer","experience-level":100,"lifecycle":"use","article-type":"article","description":null,"href":"/dev/sdks/simulator_utils"},{"group":"Cognite CLI","icon":"terminal","pages":[{"title":"Quickstart: Deploy Flows custom apps with the Cognite CLI","sidebarTitle":"Get started","description":"Scaffold, deploy, publish, and activate a Flows custom app with @cognite/cli@latest from install through activation.","content-type":"quickstart","audience":"developer","experience-level":100,"lifecycle":"setup","article-type":"article","href":"/dev/sdks/cognite-cli/index"},{"title":"Building Atlas AI agents with the Cognite CLI","sidebarTitle":"Building Atlas AI agents","description":"Step-by-step guide to scaffold, push, evaluate, and publish an Atlas AI agent with @cognite/cli.","content-type":"procedure","audience":["developer","aiEngineer"],"experience-level":100,"lifecycle":"setup","article-type":"article","href":"/dev/sdks/cognite-cli/agents"},{"title":"Agent definition (`\u003cname>.agent.yaml`)","sidebarTitle":"Agent definition","description":"Complete field reference for \u003cname>.agent.yaml, the Atlas AI agent definition used by the Cognite CLI and compatible with the Cognite Toolkit.","content-type":"reference","audience":["developer","aiEngineer"],"experience-level":200,"lifecycle":"use","article-type":"article","href":"/dev/sdks/cognite-cli/agent-yaml"},{"title":"Agent evaluation cases","sidebarTitle":"Evaluation cases","description":"Complete reference for eval/eval.yaml used by `cognite agents eval`: criteria, groundTruth, tools, and session context.","content-type":"reference","audience":["developer","aiEngineer"],"experience-level":200,"lifecycle":"verify","article-type":"article","href":"/dev/sdks/cognite-cli/agents-eval"},{"title":"Cognite CLI command reference","sidebarTitle":"Command reference","description":"Complete reference for @cognite/cli@latest commands: Flows custom apps, Atlas AI agents, and code signing keys.","content-type":"reference","audience":["developer","appMaker","aiEngineer"],"experience-level":200,"lifecycle":"use","article-type":"article","href":"/dev/sdks/cognite-cli/reference"}]}]}]}]},{"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","description":"How to call the Cognite Data Fusion REST API: URLs, calendar versioning, Postman, pagination, and throttling.","content-type":"reference","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/api-description"},{"title":"API rate limits","sidebarTitle":"Rate limits","description":"Rate and concurrency limits for Cognite Data Fusion (CDF) API endpoints.","content-type":"reference","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/rate-limits"},{"title":"Cognite API changelog","sidebarTitle":"Changelog","description":"Track all notable changes, updates, and deprecations for the Cognite Data Fusion (CDF) API v1, aligned with the published API reference changelog (api-docs.cognite.com).","rss":true,"href":"/api-reference/changelog"}]},{"group":"Organizations and projects","pages":[{"title":"Organizations and projects","sidebarTitle":"Overview","description":"Manage organizations and projects in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/organizations-and-projects"},{"group":"Organizations","pages":[{"title":"Organizations","sidebarTitle":"Overview","description":"Manage organizations, projects, and external identity providers (IdPs).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/organizations"},{"title":"Create an organization","description":"Creates a child organization. Requires an admin and `adminsCanCreateOrgsInSubtree`. See [Create a child organization](/api-reference/concepts/20230101/organizations#create-a-child-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","autogeneratedByOpenApi":true},{"title":"Delete an organization","description":"Soft-deletes an organization with no children and no projects. Requires an admin of the organization or an ancestor. See [Delete an organization](/api-reference/concepts/20230101/organizations#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","autogeneratedByOpenApi":true},{"title":"List child organizations","description":"Lists child organizations. Requires an admin of the parent or an ancestor. See [Create a child organization](/api-reference/concepts/20230101/organizations#create-a-child-organization).","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","autogeneratedByOpenApi":true},{"title":"Retrieve an organization","description":"Retrieves an organization. Requires an admin of the organization or an ancestor. See [Organizations](/api-reference/concepts/20230101/organizations).","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","autogeneratedByOpenApi":true}]},{"group":"Projects","pages":[{"title":"Projects","sidebarTitle":"Overview","description":"Manage projects in an organization.","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/projects"},{"title":"Create a project","description":"Creates a project on an allowed cluster. Requires an admin and `adminsCanCreateProjectsInSubtree`. See [Create a project](/api-reference/concepts/20230101/projects#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","autogeneratedByOpenApi":true},{"title":"List projects in an organization","description":"Lists projects in an organization. Admin properties require an admin. See [List projects](/api-reference/concepts/20230101/projects#list-projects).","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","autogeneratedByOpenApi":true}]}]},{"group":"Identity and access management","pages":[{"title":"Identity and access management","sidebarTitle":"Overview","description":"Manage principals, groups, security categories, sessions, and tokens in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/identity-and-access-management"},{"group":"Principals","pages":[{"title":"Principals","sidebarTitle":"Overview","description":"Understanding user accounts and service accounts.","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/principals"},{"title":"Get the current caller's information","description":"Retrieves the information of the principal issuing the request.\n\nThis endpoint is useful for clients to verify their own identity.\nAll authenticated principals can call this endpoint.","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","autogeneratedByOpenApi":true},{"title":"List login sessions","description":"Lists login sessions for a user. Requires an admin of that organization. See [Login sessions](/api-reference/concepts/20230101/principals#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","autogeneratedByOpenApi":true},{"title":"List principals","description":"List principals in an organization.\n\nAll principal types are supported.\n\n#### Access control\nRequires the caller to be logged into the target organization, or\nto be an admin in any of its the ancestor organizations.","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","autogeneratedByOpenApi":true},{"title":"Retrieve principals by reference","description":"Retrieves principals by ID. Service accounts can also be retrieved by external ID. See [Retrieve principals](/api-reference/concepts/20230101/principals#retrieve-principals).","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","autogeneratedByOpenApi":true},{"title":"Revoke login sessions","description":"Revokes login sessions for a user. The call is atomic and can take up to one hour. See [Login sessions](/api-reference/concepts/20230101/principals#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","autogeneratedByOpenApi":true}]},{"group":"Groups","pages":[{"title":"Groups","sidebarTitle":"Overview","description":"Manage groups and group membership in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/groups"},{"title":"Create groups","description":"Creates groups and their capabilities. Members receive `userProfilesAcl:READ`. Requires `groupsAcl:CREATE`. See [Capabilities](/api-reference/concepts/20230101/groups#capabilities).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /groups","href":"/20230101/groups/create-groups","autogeneratedByOpenApi":true},{"title":"Delete groups","description":"\n\n> **Required capabilities:** `groupsAcl:DELETE`\n\nDeletes the groups with the given IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /groups/delete","href":"/20230101/groups/delete-groups","autogeneratedByOpenApi":true},{"title":"List groups","description":"\n\n> **Required capabilities:** `groupsAcl:LIST`\n\nRetrieves a list of groups the asking principal a member of. Principals with groups:list capability can optionally ask for all groups in a project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /groups","href":"/20230101/groups/list-groups","autogeneratedByOpenApi":true}]},{"group":"Security categories","pages":[{"title":"Security categories","sidebarTitle":"Overview","description":"Manage security categories in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/security-categories"},{"title":"Create security categories","description":"\n\n> **Required capabilities:** `securityCategoriesAcl:CREATE`\n\nCreates security categories with the given names. Duplicate names in the request are ignored.\nIf a security category with one of the provided names exists already, then the request will fail and no security categories are created.\n","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /securitycategories","href":"/20230101/security-categories/create-security-categories","autogeneratedByOpenApi":true},{"title":"Delete security categories","description":"\n\n> **Required capabilities:** `securityCategoriesAcl:DELETE`\n\nDeletes the security categories that match the provided IDs.\nIf any of the provided IDs does not belong to an existing security category, then the request will fail and no security categories are deleted.\n","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","autogeneratedByOpenApi":true},{"title":"List security categories","description":"\n\n> **Required capabilities:** `securityCategoriesAcl:LIST`\n\nRetrieves a list of all security categories for a project.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /securitycategories","href":"/20230101/security-categories/list-security-categories","autogeneratedByOpenApi":true}]},{"group":"Sessions","pages":[{"title":"Sessions","sidebarTitle":"Overview","description":"Manage sessions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/sessions"},{"title":"Create sessions","description":"\n\n> **Required capabilities:** `sessionsAcl:CREATE`\n\nCreate sessions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sessions","href":"/20230101/sessions/create-sessions","autogeneratedByOpenApi":true},{"title":"List sessions","description":"\n\n> **Required capabilities:** `sessionsAcl:LIST`\n\nList all sessions in the current project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /sessions","href":"/20230101/sessions/list-sessions","autogeneratedByOpenApi":true},{"title":"Retrieve sessions with given IDs","description":"\n\n> **Required capabilities:** `sessionsAcl:LIST`\n\nRetrieves sessions with given IDs. The request will fail if any of the IDs does not belong to an existing session.","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","autogeneratedByOpenApi":true},{"title":"Revoke sessions","description":"\n\n> **Required capabilities:** `sessionsAcl:DELETE`\n\nRevoke access to a session. Revocation is idempotent.\nRevocation of a session may in some cases take up to 1 hour to take effect.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sessions/revoke","href":"/20230101/sessions/revoke-sessions","autogeneratedByOpenApi":true}]},{"group":"Token","pages":[{"title":"Tokens","sidebarTitle":"Overview","description":"Manage tokens in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/tokens"},{"title":"Inspect","description":"\n\n> **Required capabilities:** `projectsAcl:LIST` `groupsAcl:LIST`\n\nInspect CDF access granted to an IdP issued token","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /token/inspect","href":"/20230101/token/inspect","autogeneratedByOpenApi":true}]},{"group":"User profiles","tag":"deprecated","pages":[{"title":"User profiles","sidebarTitle":"Overview","description":"Manage user profiles in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/user-profiles"},{"title":"(deprecated) Get the user profile of the principal issuing the request","description":"Returns the caller's profile. A new principal can receive 404 until the profile exists. Requires `userProfilesAcl:READ`. See [User profiles](/api-reference/concepts/20230101/user-profiles).","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","autogeneratedByOpenApi":true},{"title":"Get the user profile of the principal issuing the request","description":"Deprecated in favor of the new [endpoint](#tag/Principals/operation/getMe).\n\nRetrieves 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","autogeneratedByOpenApi":true},{"title":"List all user profiles in the current project","description":"Lists user profiles. Deprecated. Use principals. Requires `userProfilesAcl:READ`. See [User profiles](/api-reference/concepts/20230101/user-profiles).","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","autogeneratedByOpenApi":true},{"title":"Retrieve profiles by ID in the current project","description":"\n\n> **Required capabilities:** `userProfilesAcl:READ`\n\nDeprecated in favor of the [Retrieve principals](#tag/Principals/operation/getPrincipalsById) endpoint.\n\nRetrieve one or more user profiles indexed by the user identifier in the same CDF 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","autogeneratedByOpenApi":true},{"title":"Search user profiles in the current project","description":"Searches user profiles. Deprecated. Matching can change, and the operation does not paginate. Requires `userProfilesAcl:READ`. See [User profiles](/api-reference/concepts/20230101/user-profiles).","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","autogeneratedByOpenApi":true}]}]}]},{"group":"Core data","icon":"database","expanded":true,"pages":[{"group":"Data modeling","pages":[{"title":"Data modeling with the industrial knowledge graph","sidebarTitle":"Overview","description":"Use these APIs for all new projects. The data modeling service (DMS) offers the full power of the Cognite Data Fusion (CDF) Knowledge Graph, allowing you to model your industrial reality exactly as it is, connecting physical assets, processes, work orders, and more without rigid hierarchy limits.","keywords":"asset, assets, asset hierarchy, CogniteAsset, knowledge graph, data model","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","applicable-to":["data-modeling"],"article-type":"article","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/data-modeling"},{"group":"Data models","pages":[{"title":"Data models","sidebarTitle":"Overview","description":"Create and manage data models in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/data-models"},{"title":"Create or update data models","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nAdd or update (upsert) data models. For unchanged data model specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for models that remain unchanged.","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","autogeneratedByOpenApi":true},{"title":"Delete data models","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more data models. Currently limited to 100 models at a time. This does not delete the views, nor the containers they reference.","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","autogeneratedByOpenApi":true},{"title":"List data models defined in the project","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nList data models defined in the project. You can filter the returned models by the specified space.","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","autogeneratedByOpenApi":true},{"title":"Retrieve data models by their external ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 100 data models by their external ids. Views can be auto-expanded when the ```InlineViews``` query parameter is set.","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","autogeneratedByOpenApi":true}]},{"group":"Spaces","pages":[{"title":"Spaces","sidebarTitle":"Overview","description":"Manage spaces for organizing data models in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/spaces"},{"title":"Create or update spaces","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nAdd or update (upsert) spaces. For unchanged space specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for spaces that remain unchanged.","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","autogeneratedByOpenApi":true},{"title":"Delete spaces","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more spaces, maximum 100 spaces at a time.\n\n\nOnly empty spaces can be deleted. ","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/spaces/delete","href":"/20230101/spaces/delete-spaces","autogeneratedByOpenApi":true},{"title":"List spaces defined in the project","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nList spaces defined in the current 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","autogeneratedByOpenApi":true},{"title":"Retrieve spaces by their space-ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 100 spaces by specifying 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","autogeneratedByOpenApi":true}]},{"group":"Views","pages":[{"title":"Views","sidebarTitle":"Overview","description":"Define and manage views for data modeling in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/views"},{"title":"Create or update views","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nAdd or update (upsert) views. For unchanged view specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for views that remain unchanged.","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","autogeneratedByOpenApi":true},{"title":"Delete views","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more views. Currently limited to 100 views at a time.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/views/delete","href":"/20230101/views/delete-views","autogeneratedByOpenApi":true},{"title":"List views defined in the project","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nList of views defined in the current project. You can filter the list by specifying a space.","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","autogeneratedByOpenApi":true},{"title":"Retrieve views by their external ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 100 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","autogeneratedByOpenApi":true}]},{"group":"Containers","pages":[{"title":"Containers","sidebarTitle":"Overview","description":"Create and manage containers for data storage in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/containers"},{"title":"Create or update containers","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nAdd or update (upsert) containers. For unchanged container specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for containers that remain unchanged.","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","autogeneratedByOpenApi":true},{"title":"Delete containers","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more containers. Currently limited to 100 containers at a time.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/containers/delete","href":"/20230101/containers/delete-containers","autogeneratedByOpenApi":true},{"title":"Delete indexes from containers","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more container indexes. Currently limited to 10 indexes at a time.","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","autogeneratedByOpenApi":true},{"title":"Delete constraints from containers","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more container constraints. Currently limited to 10 constraints at a time.","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","autogeneratedByOpenApi":true},{"title":"Inspect containers","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/containers/inspect","href":"/20230101/containers/inspect-containers","autogeneratedByOpenApi":true},{"title":"List containers defined in the project","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nList of containers defined in the current project. You can filter the list by specifying a space.","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","autogeneratedByOpenApi":true},{"title":"Retrieve containers by their external ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 100 containers by their specified 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","autogeneratedByOpenApi":true},{"title":"Retry failed container constraints","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nTriggers a revalidation of the given failed container constraints. This will usually entail scanning through all the data in the container, so use this sparingly. There are strict limits as to how often a given constraint can be revalidated, and how many schema entities can be in a retrying state simultaneously.","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","autogeneratedByOpenApi":true},{"title":"Retry failed indexes","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nTriggers a retry of the given failed container indexes. This will usually entail scanning through all the data in the container, so use this sparingly. There are strict limits as to how often a given index can be retried, and how many schema entities can be in a retrying state simultaneously.","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","autogeneratedByOpenApi":true},{"title":"Retry failed property constraints","description":"Revalidates failed property constraints by scanning the container. Requires `dataModelsAcl:WRITE`. See [Retry property constraints](/api-reference/concepts/20230101/containers#retry-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","autogeneratedByOpenApi":true}]},{"group":"Instances","pages":[{"title":"Instances","sidebarTitle":"Overview","description":"Create and manage nodes and edges in the Cognite Data Fusion (CDF) knowledge graph.","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/instances"},{"title":"Aggregate data across nodes/edges","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nAggregate data for nodes or edges in a project. You can use an optional query or filter specification to limit the result.","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","autogeneratedByOpenApi":true},{"title":"Create or update nodes/edges","description":"Creates, patches, replaces, or deletes nodes and edges in one transaction. Requires `dataModelsAcl:WRITE`. See [Create, patch, and replace](/api-reference/concepts/20230101/instances#create-patch-replace).","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","autogeneratedByOpenApi":true},{"title":"Delete nodes/edges","description":"Deletes nodes and edges. Deleting a node also deletes its edges. Requires `dataModelsAcl:WRITE`. See [Delete instances](/api-reference/concepts/20230101/instances#delete-instances).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/instances/delete","href":"/20230101/instances/delete-nodesedges","autogeneratedByOpenApi":true},{"title":"Filter nodes/edges","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nFilter the instances - nodes and edges - in a project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/instances/list","href":"/20230101/instances/filter-nodesedges","autogeneratedByOpenApi":true},{"title":"Inspect instances","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/instances/inspect","href":"/20230101/instances/inspect-instances","autogeneratedByOpenApi":true},{"title":"Query nodes/edges","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nSpecification of query endpoint. For more information, see [Query language](https://docs.cognite.com/cdf/dm/dm_concepts/dm_querying).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/instances/query","href":"/20230101/instances/query-nodesedges","autogeneratedByOpenApi":true},{"title":"Retrieve nodes/edges by their external ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 1000 nodes or 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","autogeneratedByOpenApi":true},{"title":"Search for nodes/edges","description":"\n\n> **Required capabilities:** `DataModels:READ`\n\nSearch text fields in views for nodes or edge(s). The service will return up to 1000 results. This operation orders the results by relevance, across the specified spaces.","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","autogeneratedByOpenApi":true},{"title":"Sync nodes/edges","description":"Returns changes for nodes and edges that match a filter. Requires `dataModelsAcl:READ`. See [Sync](/api-reference/concepts/20230101/instances#sync).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /models/instances/sync","href":"/20230101/instances/sync-nodesedges","autogeneratedByOpenApi":true}]},{"group":"Statistics","pages":[{"title":"Statistics","sidebarTitle":"Statistics","description":"Retrieve data modeling statistics in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/dm-statistics"},{"title":"Retrieve project-wide statistics and limits","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nReturns statistics and limits for data modeling resources across the project. Use this endpoint to monitor your overall data modeling usage and available capacity.","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","autogeneratedByOpenApi":true},{"title":"Retrieve statistics by space","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nReturns statistics for data modeling resources grouped by each space in the project.","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","autogeneratedByOpenApi":true},{"title":"Retrieve statistics by space for specific space-ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nReturns statistics for data modeling resources grouped by space for a specified list of spaces.","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","autogeneratedByOpenApi":true}]},{"group":"Streams","pages":[{"title":"Streams","sidebarTitle":"Overview","description":"Manage streams in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/streams"},{"title":"Create stream","description":"Creates a stream from a template. The template sets mutability, limits, and retention. Requires `streamsAcl:CREATE`. See [Stream templates](/api-reference/concepts/20230101/streams#stream-templates).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /streams","href":"/20230101/streams/create-stream","autogeneratedByOpenApi":true},{"title":"Delete stream","description":"\n\n> **Required capabilities:** `streamsAcl:DELETE`\n\nDelete a stream by its identifier, along with all records stored in the stream.\n\nIf the stream does not exist, the operation succeeds without error (idempotent delete).\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /streams/delete","href":"/20230101/streams/delete-stream","autogeneratedByOpenApi":true},{"title":"Delete stream (DEPRECATED)","description":"\n\n> **Required capabilities:** `streamsAcl:DELETE`\n\n**DEPRECATED**: This endpoint is no longer supported and returns HTTP 410 Gone.\nPlease use `POST /streams/delete` instead.\n","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json delete /streams/{streamId}","href":"/20230101/streams/delete-stream-deprecated","autogeneratedByOpenApi":true},{"title":"List streams","description":"\n\n> **Required capabilities:** `streamsAcl:READ`\n\nList all streams available in the project.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /streams","href":"/20230101/streams/list-streams","autogeneratedByOpenApi":true},{"title":"Retrieve stream","description":"\n\n> **Required capabilities:** `streamsAcl:READ`\n\nRetrieve a stream by its identifier.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /streams/{streamId}","href":"/20230101/streams/retrieve-stream","autogeneratedByOpenApi":true}]},{"group":"Records","pages":[{"title":"Records","sidebarTitle":"Overview","description":"Manage records in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/records"},{"title":"Aggregate records data from a stream","description":"Aggregates records in a stream. Requires `streamRecordsAcl:READ` and `dataModelsAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/records#aggregates).","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","autogeneratedByOpenApi":true},{"title":"Delete records from a stream","description":"Deletes records from a mutable stream. Requires `streamRecordsAcl:WRITE`. See [Delete records](/api-reference/concepts/20230101/records#delete-records).","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","autogeneratedByOpenApi":true},{"title":"Ingest records into a stream","description":"Ingests a batch of records into a stream. Requires `streamRecordsAcl:WRITE` and `dataModelsAcl:READ`. See [Ingest records](/api-reference/concepts/20230101/records#ingest-records).","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","autogeneratedByOpenApi":true},{"title":"Retrieve records from a stream","description":"\n\n> **Required capabilities:** `streamRecordsAcl:READ` `dataModelsAcl:READ`\n\nFilter the records from the ```stream```.\n","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","autogeneratedByOpenApi":true},{"title":"Sync records from a stream","description":"\n\n> **Required capabilities:** `streamRecordsAcl:READ` `dataModelsAcl:READ`\n\nSubscribe to changes for records from the ```stream```, matching a supplied filter.\n","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","autogeneratedByOpenApi":true},{"title":"Upsert (create or update) records into a stream","description":"Creates or replaces records in a mutable stream. Requires `streamRecordsAcl:WRITE` and `dataModelsAcl:READ`. See [Upsert records](/api-reference/concepts/20230101/records#upsert-records).","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","autogeneratedByOpenApi":true}]}]},{"group":"Time series and datapoints","pages":[{"title":"Time series and datapoints","sidebarTitle":"Overview","description":"Insert, retrieve, and query time series datapoints in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["data-modeling","asset-centric"],"api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/time-series-data"},{"group":"Datapoints","pages":[{"title":"Datapoints","sidebarTitle":"Overview","description":"Insert, retrieve, and delete time series data points in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["data-modeling","asset-centric"],"api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/datapoints"},{"title":"Insert data points","description":"\n\n> **Required capabilities:** `timeSeriesAcl:WRITE`\n\nInsert data points into a time series. You can do this for multiple time series.\nIf you insert a data point with a timestamp that already exists, it will be overwritten with the new value.","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","autogeneratedByOpenApi":true},{"title":"Retrieve data points","description":"Lists data points from multiple time series. If `start` is omitted, it defaults to 1 January 1970. Requires `timeSeriesAcl:READ`. See [List data points](/api-reference/concepts/20230101/time-series#list-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","autogeneratedByOpenApi":true},{"title":"Retrieve latest data point","description":"\n\n> **Required capabilities:** `timeSeriesAcl:READ`\n\nRetrieves the latest data point in one or more time series. Note that the latest data point\nin a time series is the one with the highest timestamp, which is not necessarily the one\nthat was ingested most recently.\n","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","autogeneratedByOpenApi":true},{"title":"Delete data points","description":"\n\n> **Required capabilities:** `timeSeriesAcl:WRITE`\n\nDelete data points from time series.","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","autogeneratedByOpenApi":true}]},{"group":"Synthetic time series","pages":[{"title":"Synthetic time series","sidebarTitle":"Overview","description":"Create synthetic time series queries in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["data-modeling","asset-centric"],"api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/synthetic-time-series"},{"title":"Synthetic query","description":"Execute an on-the-fly 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","autogeneratedByOpenApi":true}]},{"group":"Data point subscriptions","pages":[{"title":"Data point subscriptions","sidebarTitle":"Overview","description":"Subscribe to changes in time series data points in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["data-modeling","asset-centric"],"api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/data-point-subscriptions"},{"title":"Create subscriptions","description":"\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:WRITE`\n\nCreate one or more subscriptions that can be used to listen for changes in data points for a set of time series.","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","autogeneratedByOpenApi":true},{"title":"Delete subscriptions","description":"\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:WRITE`\n\nDelete subscription(s). This operation cannot be undone","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","autogeneratedByOpenApi":true},{"title":"List subscription data","description":"Returns the next batch of data-point updates for one or more partitions. Requires `timeSeriesSubscriptionsAcl:READ`. See [Partitions](/api-reference/concepts/20230101/data-point-subscriptions#partitions).","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","autogeneratedByOpenApi":true},{"title":"List subscription members","description":"Lists the time series in a subscription. A series added by both external ID and instance ID appears twice. Requires `timeSeriesSubscriptionsAcl:READ`. See [Data point subscriptions](/api-reference/concepts/20230101/data-point-subscriptions).","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","autogeneratedByOpenApi":true},{"title":"List subscriptions","description":"\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:READ`\n\nList all subscriptions for the tenant. Use nextCursor to paginate through the results.","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","autogeneratedByOpenApi":true},{"title":"Retrieve subscriptions","description":"\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:READ`\n\nRetrieve one or more subscriptions by external ID.","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","autogeneratedByOpenApi":true},{"title":"Update subscriptions","description":"\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:WRITE`\n\nUpdates one or more subscriptions. Fields that are not included in the request, are not changed.\n\nIf both `instanceIds` and `timeSeriesIds` are set, they must either both be add/remove or\nboth be set operations.","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","autogeneratedByOpenApi":true}]}]},{"group":"File content","pages":[{"title":"File content","sidebarTitle":"Overview","description":"Upload and download file content in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["data-modeling","asset-centric"],"api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/file-content"},{"title":"Get upload file link","description":"Returns an upload URL for an existing file. Requires `filesAcl:WRITE`, or data modeling read and write. See [Upload limits](/api-reference/concepts/20230101/file-content#upload-limits).","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","autogeneratedByOpenApi":true},{"title":"Download files","description":"Returns download URLs. A URL expires after 30 seconds unless you extend it. Requires `filesAcl:READ`, or data modeling read. See [Download links](/api-reference/concepts/20230101/file-content#download-links).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/downloadlink","href":"/20230101/files/download-files","autogeneratedByOpenApi":true},{"title":"Upload multipart file","description":"Creates file metadata and returns multipart upload URLs. Requires `filesAcl:WRITE`. See [Upload limits](/api-reference/concepts/20230101/file-content#upload-limits).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/initmultipartupload","href":"/20230101/files/upload-multipart-file","autogeneratedByOpenApi":true},{"title":"Get multipart file upload link","description":"Returns multipart upload URLs for an existing file. Requires `filesAcl:WRITE`, or data modeling read and write. See [Upload limits](/api-reference/concepts/20230101/file-content#upload-limits).","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","autogeneratedByOpenApi":true},{"title":"Complete multipart upload","description":"Assembles uploaded parts into one file. Requires `filesAcl:WRITE`, or data modeling read and write. See [Upload limits](/api-reference/concepts/20230101/file-content#upload-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/completemultipartupload","href":"/20230101/files/complete-multipart-upload","autogeneratedByOpenApi":true},{"title":"Get icon","description":"Returns an icon for a JPEG or PNG file. Requires `filesAcl:READ`, or data modeling read. See [File icons](/api-reference/concepts/20230101/file-content#file-icons).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /files/icon","href":"/20230101/files/get-icon","autogeneratedByOpenApi":true}]},{"group":"3D","pages":[{"title":"3D","sidebarTitle":"Overview","description":"Manage 3D models, revisions, files, asset mappings, and processing jobs in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/3d"},{"group":"3D models","pages":[{"title":"3D Models","sidebarTitle":"Overview","description":"Manage 3D models in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/3d-models"},{"title":"List 3D models","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nRetrieves a list of all models in a project. This operation supports pagination. You can filter out all models without a published revision.","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","autogeneratedByOpenApi":true},{"title":"Create 3D models","description":"\n\n> **Required capabilities:** `threedAcl:CREATE`\n","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","autogeneratedByOpenApi":true},{"title":"Update 3D models","description":"\n\n> **Required capabilities:** `threedAcl:UPDATE`\n","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","autogeneratedByOpenApi":true},{"title":"Delete 3D models","description":"\n\n> **Required capabilities:** `threedAcl:DELETE`\n","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","autogeneratedByOpenApi":true},{"title":"Retrieve a 3D model","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n","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","autogeneratedByOpenApi":true}]},{"group":"3D model revisions","pages":[{"title":"3D Model Revisions","sidebarTitle":"Overview","description":"Manage 3D model revisions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/3d-model-revisions"},{"title":"List 3D revisions","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nRetrieves a list of all revisions of a model. This operation supports pagination. You can also filter revisions if they are marked as published or not by using the query param published.","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","autogeneratedByOpenApi":true},{"title":"Create 3D revisions","description":"Creates revisions and starts processing. Data modeling only projects use 3D jobs. Requires `threedAcl:CREATE`. See [Create revisions](/api-reference/concepts/20230101/3d-model-revisions#create-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","autogeneratedByOpenApi":true},{"title":"Update 3D revisions","description":"\n\n> **Required capabilities:** `threedAcl:UPDATE`\n","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","autogeneratedByOpenApi":true},{"title":"Delete 3D revisions","description":"\n\n> **Required capabilities:** `threedAcl:DELETE`\n","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","autogeneratedByOpenApi":true},{"title":"Retrieve a 3D revision","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n","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","autogeneratedByOpenApi":true},{"title":"List 3D revision logs","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nList log entries for the revision","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","autogeneratedByOpenApi":true},{"title":"Update 3D revision thumbnail","description":"\n\n> **Required capabilities:** `threedAcl:UPDATE`\n","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","autogeneratedByOpenApi":true},{"title":"List available outputs","description":"Lists outputs for a processed revision. Requires `threedAcl:READ`. See [Outputs](/api-reference/concepts/20230101/3d-model-revisions#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","autogeneratedByOpenApi":true},{"title":"List 3D nodes","description":"Lists nodes in a revision. Wait until the revision status is `Done`. Requires `threedAcl:READ`. See [Nodes](/api-reference/concepts/20230101/3d-model-revisions#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","autogeneratedByOpenApi":true},{"title":"Filter 3D nodes","description":"Filters nodes by name or property. Wait until the revision status is `Done`. Requires `threedAcl:READ`. See [Nodes](/api-reference/concepts/20230101/3d-model-revisions#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","autogeneratedByOpenApi":true},{"title":"Get 3D nodes by ID","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nRetrieves specific nodes given by a list of IDs.","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","autogeneratedByOpenApi":true},{"title":"List 3D ancestor nodes","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nRetrieves a list of ancestor nodes of a given node, including itself, in the hierarchy of the 3D model. This operation supports pagination. Will return error 400 if the revision is still being processed.","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","autogeneratedByOpenApi":true}]},{"group":"3D files","pages":[{"title":"3D Files","sidebarTitle":"Overview","description":"Retrieve 3D files from Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/3d-files"},{"title":"Retrieve a single 3D file","description":"Returns a processed 3D file by ID. Requires `threedAcl:READ`. See [Output types](/api-reference/concepts/20230101/3d-files#output-types).","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","autogeneratedByOpenApi":true},{"title":"Retrieve a 3D directory file","description":"Returns one file inside a 3D directory output. Requires `threedAcl:READ`. See [Output types](/api-reference/concepts/20230101/3d-files#output-types).","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","autogeneratedByOpenApi":true}]},{"group":"3D asset mapping","pages":[{"title":"3D Asset Mapping","sidebarTitle":"Overview","description":"Map 3D model nodes to assets in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/3d-asset-mapping"},{"title":"List 3D asset mappings","description":"Lists mappings for one filter. Not available in data modeling only projects. Requires `threedAcl:READ`. See [Mapping rules](/api-reference/concepts/20230101/3d-asset-mapping#mapping-rules).","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","autogeneratedByOpenApi":true},{"title":"Create 3D asset mappings","description":"Creates mappings between assets and 3D nodes. Requires `threedAcl:UPDATE`. See [Mapping rules](/api-reference/concepts/20230101/3d-asset-mapping#mapping-rules).","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","autogeneratedByOpenApi":true},{"title":"Delete 3D asset mappings","description":"\n\n> **Required capabilities:** `threedAcl:DELETE`\n\nDelete a list of asset mappings.\n\nIn Hybrid CDF projects: The delete request items requires a `nodeId`, and either an `assetId` or an `assetInstanceId`.\n\nIn DataModelingOnly CDF projects: The delete request items requires a `nodeId` and an `assetInstanceId` (with space and externalId).","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","autogeneratedByOpenApi":true},{"title":"Filter 3D asset mappings","description":"Lists mappings for one filter. Not available in data modeling only projects. Requires `threedAcl:READ`. See [Mapping rules](/api-reference/concepts/20230101/3d-asset-mapping#mapping-rules).","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","autogeneratedByOpenApi":true},{"title":"Filter which nodes are within a boundingbox for a revision.","description":"This endpoint is only supported in dm-only projects.\nThe nodeIds can be found as part of a CogniteCadNode in the field `cadNodeReference`.\nSimilar functionality is supported in classic through:\n- list 3D asset mappings endpoint + intersectsBoundingBox","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","autogeneratedByOpenApi":true},{"title":"List mappings for one assetID across all 3D models","description":"Lists node IDs mapped to an asset across models. Requires `threedAcl:READ`. See [Mapping rules](/api-reference/concepts/20230101/3d-asset-mapping#mapping-rules).","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","autogeneratedByOpenApi":true}]},{"group":"3D jobs","pages":[{"title":"3D Jobs","sidebarTitle":"Overview","description":"Manage 3D processing jobs in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/3d-jobs"},{"title":"Create a job using 3D source data","description":"Creates a 3D job in a data modeling project. Requires a session nonce. See [Job sources](/api-reference/concepts/20230101/3d-jobs#job-sources).","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","autogeneratedByOpenApi":true},{"title":"List jobs","description":"\n\n> **Required capabilities:** `datamodels:READ(cdf_cdm, cdf_cdm_3d)` `datamodelinstances:READ`\n\nList jobs for your project.","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","autogeneratedByOpenApi":true},{"title":"Delete jobs","description":"\n\n> **Required capabilities:** `datamodels:READ(cdf_cdm, cdf_cdm_3d)` `datamodelinstances:WRITE`\n\nDelete jobs in your project. The job instance results won't be deleted by this operation.","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","autogeneratedByOpenApi":true},{"title":"List Job Results","description":"List the results of a job","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","autogeneratedByOpenApi":true},{"title":"Update Job Result Rejections","description":"Job Instance Results have internal unique keys you can reject\nto allow yourself to filter away job results items you are no longer\ninterested in","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","autogeneratedByOpenApi":true},{"title":"List Job Result Rejections","description":"A list of internal keys that are to be considered rejected","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","autogeneratedByOpenApi":true}]}]}]},{"group":"Cognite AI","icon":"bot","expanded":true,"pages":[{"title":"Cognite AI","sidebarTitle":"Overview","description":"Overview of Cognite AI APIs in Cognite Data Fusion (CDF), including document understanding, agents, skills, and language models.","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/cognite-ai"},{"group":"Document AI","pages":[{"title":"Document AI","sidebarTitle":"Overview","description":"Ask questions about and summarize documents in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/document-ai"},{"title":"Ask questions about one or more documents.","description":"Answers a question from up to 100 PDFs. Each PDF can be at most 400 pages. See [Ask limits](/api-reference/concepts/20230101/document-ai#ask-limits).","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","autogeneratedByOpenApi":true},{"title":"Summarize documents.","description":"Generates concise summaries for a list of input documents using a language model.","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","autogeneratedByOpenApi":true}]}]},{"group":"Compute and automation","icon":"cpu","expanded":true,"pages":[{"group":"Functions","pages":[{"title":"Functions","sidebarTitle":"Overview","description":"Deploy and run serverless functions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/functions-overview"},{"group":"Functions","pages":[{"title":"Functions","sidebarTitle":"Overview","description":"Deploy and manage serverless functions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/functions"},{"title":"Activate Functions","description":"\n\n> **Required capabilities:** `functionsAcl:WRITE`\n\nActivate Cognite Functions. This will create the necessary backend infrastructure for Cognite Functions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/status","href":"/20230101/functions/activate-functions","autogeneratedByOpenApi":true},{"title":"Get activation status","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nGet 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","autogeneratedByOpenApi":true},{"title":"Create functions","description":"\n\n> **Required capabilities:** `functionsAcl:WRITE`\n\nYou can only create one function per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions","href":"/20230101/functions/create-functions","autogeneratedByOpenApi":true},{"title":"Delete functions","description":"\n\n> **Required capabilities:** `functionsAcl:WRITE`\n\nDelete functions. You can delete a maximum of 10 functions per request. Function source files stored in the Files API must be deleted separately.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/delete","href":"/20230101/functions/delete-functions","autogeneratedByOpenApi":true},{"title":"Filter functions","description":"Use advanced filtering options to find functions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/list","href":"/20230101/functions/filter-functions","autogeneratedByOpenApi":true},{"title":"Functions limits","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nService limits for the associated project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /functions/limits","href":"/20230101/functions/functions-limits","autogeneratedByOpenApi":true},{"title":"List functions","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nList functions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /functions","href":"/20230101/functions/list-functions","autogeneratedByOpenApi":true},{"title":"Retrieve a function by its id","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve a function by its id. If you want to retrieve functions by names, use Retrieve functions instead.","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","autogeneratedByOpenApi":true},{"title":"Retrieve functions","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve functions by ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/byids","href":"/20230101/functions/retrieve-functions","autogeneratedByOpenApi":true}]},{"group":"Function calls","pages":[{"title":"Function calls","sidebarTitle":"Overview","description":"Execute and monitor function calls in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/function-calls"},{"title":"Call a function asynchronously","description":"Calls a function. Pass input in `data`, not secrets. Requires `functionsAcl:RUN`. See [Call input](/api-reference/concepts/20230101/function-calls#call-input).","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","autogeneratedByOpenApi":true},{"title":"Filter function calls","description":"Use advanced filtering options to find 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","autogeneratedByOpenApi":true},{"title":"List function calls","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nList 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","autogeneratedByOpenApi":true},{"title":"Retrieve calls","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve function calls by call ids.","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","autogeneratedByOpenApi":true},{"title":"Retrieve a function call by its id","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve function calls.","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","autogeneratedByOpenApi":true},{"title":"Retrieve logs for function call","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nGet logs from a 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","autogeneratedByOpenApi":true},{"title":"Retrieve response for function call","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve response from a 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","autogeneratedByOpenApi":true}]},{"group":"Function schedules","pages":[{"title":"Function schedules","sidebarTitle":"Overview","description":"Schedule function executions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/function-schedules"},{"title":"Create schedules","description":"Creates schedules that call a function on a cron expression. A schedule with a `nonce` must use `functionId`. Requires `functionsAcl:WRITE`. See [Sessions](/api-reference/concepts/20230101/function-schedules#sessions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /functions/schedules","href":"/20230101/function-schedules/create-schedules","autogeneratedByOpenApi":true},{"title":"Delete schedules","description":"\n\n> **Required capabilities:** `functionsAcl:WRITE`\n\nDelete function 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","autogeneratedByOpenApi":true},{"title":"Filter function schedules","description":"Use advanced filtering options to find function schedules. At most one of `FunctionId` or `FunctionExternalId` can be specified.","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","autogeneratedByOpenApi":true},{"title":"List schedules","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nList function schedules in project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /functions/schedules","href":"/20230101/function-schedules/list-schedules","autogeneratedByOpenApi":true},{"title":"Retrieve a function schedule by its id","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve 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","autogeneratedByOpenApi":true},{"title":"Retrieve schedules","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve function schedules by schedule ids.","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","autogeneratedByOpenApi":true},{"title":"Retrieve function input data","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve the input data to the associated function.","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","autogeneratedByOpenApi":true}]}]}]},{"group":"Connectors","icon":"plug","expanded":true,"pages":[{"group":"PostgreSQL gateway","pages":[{"title":"PostgreSQL gateway","sidebarTitle":"Overview","description":"Ingest data into Cognite Data Fusion (CDF) using the PostgreSQL protocol and SQL clients.","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/postgresql-gateway"},{"group":"Postgres gateway users","pages":[{"title":"Postgres Gateway Users","sidebarTitle":"Overview","description":"Create and manage PostgreSQL gateway users and credentials in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/postgres-gateway-users"},{"title":"Create users","description":"\n\n> **Required capabilities:** `postgresGateway:WRITE`\n\nCreate postgres 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","autogeneratedByOpenApi":true},{"title":"Filter users","description":"List all postgres users for a given project. If more than `limit` users exist, a cursor for pagination will be returned with the response.","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","autogeneratedByOpenApi":true},{"title":"Retrieve users","description":"\n\n> **Required capabilities:** `postgresGateway:READ`\n\nRetrieve a list of postgres users by their usernames, optionally ignoring unknown usernames","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","autogeneratedByOpenApi":true},{"title":"Update users","description":"\n\n> **Required capabilities:** `[object Object]`\n\nUpdate postgres 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","autogeneratedByOpenApi":true},{"title":"Delete users","description":"\n\n> **Required capabilities:** `[object Object]`\n\nDelete postgres 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","autogeneratedByOpenApi":true},{"title":"List users","description":"\n\n> **Required capabilities:** `postgresGateway:READ`\n\nList all users in a given project. If more than `limit` users exist, a cursor for pagination will be returned with the response.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /postgresgateway","href":"/20230101/postgres-gateway-users/list-users","autogeneratedByOpenApi":true}]},{"group":"Postgres gateway tables","pages":[{"title":"Postgres Gateway Tables","sidebarTitle":"Overview","description":"Create and manage PostgreSQL gateway tables that expose Cognite Data Fusion (CDF) resources.","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/postgres-gateway-tables"},{"title":"Create tables","description":"\n\n> **Required capabilities:** `postgresGateway:WRITE`\n\nCreate up to 10 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","autogeneratedByOpenApi":true},{"title":"List tables","description":"\n\n> **Required capabilities:** `postgresGateway:READ`\n\nList all tables in a given project. If more than `limit` tables exist, a cursor for pagination will be returned with the response.","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","autogeneratedByOpenApi":true},{"title":"Retrieve tables","description":"\n\n> **Required capabilities:** `postgresGateway:READ`\n\nRetrieve a list of postgres tables for a user by their table names, optionally ignoring unknown table names","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","autogeneratedByOpenApi":true},{"title":"Delete tables","description":"\n\n> **Required capabilities:** `[object Object]`\n\nDelete up to 10 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","autogeneratedByOpenApi":true}]}]},{"group":"SAP writeback","pages":[{"title":"SAP writeback","sidebarTitle":"Overview","description":"Write data from Cognite Data Fusion (CDF) back to SAP systems.","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/sap-writeback"},{"group":"SAP instances","pages":[{"title":"SAP Instances","sidebarTitle":"Overview","description":"Manage SAP instance connections in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/sap-instances"},{"title":"Create SAP Instances","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nCreate up to 100 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","autogeneratedByOpenApi":true},{"title":"Retrieve SAP Instances","description":"\n\n> **Required capabilities:** `sapWritebackAcl:READ`\n\nRetrieve a list of up to 100 SAP instances by their external ID, optionally ignoring unknown IDs.","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","autogeneratedByOpenApi":true},{"title":"Delete SAP Instances","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nDelete a list of SAP instance configurations by their external ID. This operation will fail if any destination in the request is associated with an SAP endpoint configuration, unless the `force` query parameter is set to `true`.","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","autogeneratedByOpenApi":true}]},{"group":"SAP endpoints","pages":[{"title":"SAP Endpoints","sidebarTitle":"Overview","description":"Manage SAP writeback endpoints in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/sap-endpoints"},{"title":"Create SAP Endpoints","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nCreate up to 100 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","autogeneratedByOpenApi":true},{"title":"Retrieve SAP Endpoints","description":"\n\n> **Required capabilities:** `sapWritebackAcl:READ`\n\nRetrieve a list of up to 100 SAP endpoints by their external ID, optionally ignoring unknown IDs.","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","autogeneratedByOpenApi":true},{"title":"Delete SAP Endpoints","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nDelete a list of SAP endpoint configurations by their external ID. This operation will fail if any endpoint in the request is associated to a SAP instance configuration.","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","autogeneratedByOpenApi":true},{"title":"Verify SAP Endpoint","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nVerify the connectivity between the writeback API, and the SAP endpoint destination.","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","autogeneratedByOpenApi":true}]},{"group":"Schema mappings","pages":[{"title":"Schema Mappings","sidebarTitle":"Schema Mappings","description":"Map CDF data to SAP schemas for writeback in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/sap-schema-mappings"},{"title":"Create Mappings","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nCreate a maximum of 100 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","autogeneratedByOpenApi":true},{"title":"Retrieve Mappings","description":"\n\n> **Required capabilities:** `sapWritebackAcl:READ`\n\nRetrieve a list of up to 100 mappings by their external ID, optionally ignoring unknown IDs.","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","autogeneratedByOpenApi":true},{"title":"Delete Mappings","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nDelete a list of mappings by their external ID.","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","autogeneratedByOpenApi":true}]},{"group":"Writeback requests","pages":[{"title":"Writeback Requests","sidebarTitle":"Overview","description":"Send data from CDF back to SAP systems.","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/writeback-requests"},{"title":"Create Writeback Requests","description":"\n\n> **Required capabilities:** `sapWritebackRequestsAcl:WRITE`\n\nCreate a writeback request","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","autogeneratedByOpenApi":true},{"title":"Retrieve Writeback Requests","description":"\n\n> **Required capabilities:** `sapWritebackRequestsAcl:WRITE`\n\nRetrieve a list of up to 100 writeback requests by their external ID, optionally ignoring unknown IDs.","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","autogeneratedByOpenApi":true}]}]}]},{"group":"Contextualization","icon":"puzzle","expanded":true,"pages":[{"title":"Contextualization","sidebarTitle":"Overview","description":"Match entities, extract features from engineering diagrams, and analyze images in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/contextualization"},{"group":"Entity matching","pages":[{"title":"Entity matching","sidebarTitle":"Overview","description":"Match entities across data sources in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/entity-matching"},{"title":"Create entity matcher model","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE`\n\nTrain a model that predicts matches between entities (for example, time series names to asset names). This is also known as fuzzy joining. If there are no trueMatches (labeled data), you train a static (unsupervised) model, otherwise a machine learned (supervised) model is trained.","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","autogeneratedByOpenApi":true},{"title":"Delete entity matcher model","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE`\n\nDeletes an entity matching model. Currently, this is a soft delete, and only removes the entry from listing.","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","autogeneratedByOpenApi":true},{"title":"Filter models","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nUse filtering options to find entity matcher 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","autogeneratedByOpenApi":true},{"title":"List entity matching models","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nList all available entity matching models, with pagination.","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","autogeneratedByOpenApi":true},{"title":"Retrieve an entity matching model by the ID of the model","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nShows the status of the model. If the status is completed, shows the parameters used to train 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","autogeneratedByOpenApi":true},{"title":"Predict matches","description":"Predicts matches with a trained model. Requires `entitymatchingAcl:WRITE`. See [Predict and refit](/api-reference/concepts/20230101/entity-matching#predict-and-refit).","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","autogeneratedByOpenApi":true},{"title":"Re-fit entity matcher model","description":"Trains a new model from confirmed matches. The original model stays unchanged. Requires `entitymatchingAcl:READ` and `entitymatchingAcl:WRITE`. See [Predict and refit](/api-reference/concepts/20230101/entity-matching#predict-and-refit).","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","autogeneratedByOpenApi":true},{"title":"Retrieve entity matcher predict results","description":"\n\n> **Required capabilities:** `assetsAcl:READ` `entitymatchingAcl:WRITE`\n\nGet the results from a predict job. Note: 'assetsAcl:READ' capability is required, unless you specify a valid `X-Job-Token` in the request header. The `X-Job-Token` is provided in the response header of the initial call to `/context/entitymatching/predict`","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","autogeneratedByOpenApi":true},{"title":"Retrieve entity matching models","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nRetrieve entity matching models by IDs or external IDs.","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","autogeneratedByOpenApi":true},{"title":"Update entity matching models","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE`\n\nUpdate entity matching models by IDs or external IDs.","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","autogeneratedByOpenApi":true}]},{"group":"Engineering diagrams","pages":[{"title":"Engineering diagrams","sidebarTitle":"Overview","description":"Detect and convert engineering diagrams in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/engineering-diagrams"},{"title":"Convert a diagram to image format","description":"Converts a diagram to PNG or SVG. Only SVG embeds annotations. Requires `assetsAcl:READ` and `filesAcl:READ`. See [Detect and convert](/api-reference/concepts/20230101/engineering-diagrams#detect-and-convert).","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","autogeneratedByOpenApi":true},{"title":"Detect annotations in engineering diagrams","description":"Detects annotations in a PDF, JPEG, PNG, or TIFF diagram. Requires `assetsAcl:READ` and `filesAcl:READ`. See [Detect and convert](/api-reference/concepts/20230101/engineering-diagrams#detect-and-convert).","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","autogeneratedByOpenApi":true},{"title":"Get the results for converting an engineering diagram to an image","description":"\n\n> **Required capabilities:** `assetsAcl:READ` `filesAcl:READ`\n\nGet the results for converting an engineering diagram to SVG and PNG formats.","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","autogeneratedByOpenApi":true},{"title":"Retrieve engineering diagram detect results","description":"\n\n> **Required capabilities:** `assetsAcl:READ` `filesAcl:READ`\n\nGet the results from an engineering diagram detect job. Providing the `X-Job-Token` header returned by the\n`/context/diagram/detect` endpoint is required unless the caller has read access to all assets. Results are available for 30 days following the completion of the detect job.","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","autogeneratedByOpenApi":true}]},{"group":"Vision","pages":[{"title":"Vision","sidebarTitle":"Overview","description":"Extract features from images in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/vision"},{"title":"Extract features from images","description":"Starts an image feature extraction job. A project can run 20 jobs at once. Requires `filesAcl:READ`. See [Extract](/api-reference/concepts/20230101/vision#extract).","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","autogeneratedByOpenApi":true},{"title":"Retrieve results from a feature extraction job on images","description":"Returns completed extract batches while the job is still running. Requires `filesAcl:READ`. See [Extract](/api-reference/concepts/20230101/vision#extract).","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","autogeneratedByOpenApi":true}]}]},{"group":"Data lifecycle","icon":"git-branch","expanded":true,"pages":[{"group":"Data ingestion","pages":[{"title":"Data ingestion","sidebarTitle":"Overview","description":"Ingest data into Cognite Data Fusion (CDF) using Raw, extraction pipelines, extractors, and hosted extractors.","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/data-ingestion"},{"group":"Raw","pages":[{"title":"Raw","sidebarTitle":"Overview","description":"Manage raw NoSQL databases in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/raw"},{"title":"Create databases","description":"\n\n> **Required capabilities:** `rawAcl:WRITE`\n\nCreate databases in a project. It is possible to post a maximum of 1000 databases per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /raw/dbs","href":"/20230101/raw/create-databases","autogeneratedByOpenApi":true},{"title":"Delete databases","description":"\n\n> **Required capabilities:** `rawAcl:WRITE`\n\nIt deletes a database, but fails if the database is not empty and recursive is set to false (default).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /raw/dbs/delete","href":"/20230101/raw/delete-databases","autogeneratedByOpenApi":true},{"title":"Create tables in a database","description":"\n\n> **Required capabilities:** `rawAcl:WRITE`\n\nCreate tables in a database. It is possible to post a maximum of 1000 tables per request.","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","autogeneratedByOpenApi":true},{"title":"Delete tables in a database","description":"\n\n> **Required capabilities:** `rawAcl:WRITE`\n","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","autogeneratedByOpenApi":true},{"title":"Insert rows into a table","description":"Inserts or replaces up to 10,000 rows. A failed request can leave a partial write. Requires `rawAcl:WRITE`. See [Insert rows](/api-reference/concepts/20230101/raw#insert-rows).","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","autogeneratedByOpenApi":true},{"title":"Delete rows in a table","description":"\n\n> **Required capabilities:** `rawAcl:WRITE`\n","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","autogeneratedByOpenApi":true},{"title":"List databases","description":"\n\n> **Required capabilities:** `rawAcl:LIST`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /raw/dbs","href":"/20230101/raw/list-databases","autogeneratedByOpenApi":true},{"title":"List tables in a database","description":"\n\n> **Required capabilities:** `rawAcl:LIST`\n","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","autogeneratedByOpenApi":true},{"title":"Retrieve cursors for parallel reads","description":"Returns cursors for parallel row reads. Requires `rawAcl:READ`. See [Cursors](/api-reference/concepts/20230101/raw#cursors).","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","autogeneratedByOpenApi":true},{"title":"Retrieve rows from a table","description":"\n\n> **Required capabilities:** `rawAcl:READ`\n","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","autogeneratedByOpenApi":true},{"title":"Retrieve row by key","description":"\n\n> **Required capabilities:** `rawAcl:READ`\n","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","autogeneratedByOpenApi":true}]},{"group":"Extraction pipelines","pages":[{"title":"Extraction Pipelines","sidebarTitle":"Overview","description":"Manage extraction pipelines in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/extraction-pipelines"},{"title":"Create extraction pipelines","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:WRITE` `datasetsAcl:READ`\n\nCreates multiple new extraction pipelines. A maximum of 1000 extraction pipelines can be created per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extpipes","href":"/20230101/extraction-pipelines/create-extraction-pipelines","autogeneratedByOpenApi":true},{"title":"Delete extraction pipelines","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:WRITE` `datasetsAcl:READ`\n\nDelete extraction pipelines for given list of ids and externalIds. When the extraction pipeline is deleted, all extraction pipeline runs related to the extraction pipeline are automatically deleted.","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","autogeneratedByOpenApi":true},{"title":"Filter extraction pipelines","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:READ`\n\nUse advanced filtering options to find 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","autogeneratedByOpenApi":true},{"title":"Retrieve an extraction pipeline by its ID.","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:READ`\n\nRetrieve an extraction pipeline by its ID. If you want to retrieve extraction pipelines by externalIds, use Retrieve extraction pipelines instead.","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","autogeneratedByOpenApi":true},{"title":"Retrieve extraction pipelines","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:READ`\n\nRetrieves information about multiple extraction pipelines in the same project. All ids and externalIds must be unique.","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","autogeneratedByOpenApi":true},{"title":"Update extraction pipelines","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:WRITE` `datasetsAcl:READ`\n\nUpdate information for a list of extraction pipelines. Fields that are not included in the request, are not changed.","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","autogeneratedByOpenApi":true}]},{"group":"Extraction pipelines runs","pages":[{"title":"Extraction Pipelines Runs","sidebarTitle":"Overview","description":"Track extraction pipeline run statuses in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/extraction-pipelines-runs"},{"title":"Create extraction pipeline runs","description":"Creates one extraction pipeline run. Requires `extractionrunsAcl:WRITE` and `datasetsAcl:READ`. See [Run statuses](/api-reference/concepts/20230101/extraction-pipelines-runs#run-statuses).","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","autogeneratedByOpenApi":true},{"title":"Filter extraction pipeline runs","description":"\n\n> **Required capabilities:** `extractionrunsAcl:READ`\n\nUse advanced filtering options to find extraction pipeline runs. Sorted by createdTime value with descendant order.","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","autogeneratedByOpenApi":true}]},{"group":"Extraction pipelines config","pages":[{"title":"Extraction Pipelines Config","sidebarTitle":"Overview","description":"Manage extraction pipeline configurations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/extraction-pipelines-config"},{"title":"Create extraction configuration revision","description":"\n\n> **Required capabilities:** `extractionconfigsAcl:WRITE`\n\nCreates a configuration revision for the given extraction pipeline.","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","autogeneratedByOpenApi":true},{"title":"Get a single configuration revision","description":"\n\n> **Required capabilities:** `extractionconfigsAcl:READ`\n\nRetrieves a single configuration revision. By default, the latest revision is retrieved.","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","autogeneratedByOpenApi":true},{"title":"List configuration revisions","description":"\n\n> **Required capabilities:** `extractionconfigsAcl:READ`\n\nLists configuration revisions for the given extraction pipeline.","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","autogeneratedByOpenApi":true},{"title":"Revert configuration revision","description":"\n\n> **Required capabilities:** `extractionconfigsAcl:WRITE`\n\nReverts the latest configuration revision to an older revision. Equivalent to creating a new revision identical to the old 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","autogeneratedByOpenApi":true}]},{"group":"Extractors","pages":[{"title":"Extractors","sidebarTitle":"Overview","description":"Discover available extractors in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/extractors"},{"title":"List Extractors","description":"List all available extractors.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /extractors","href":"/20230101/extractors/list-extractors","autogeneratedByOpenApi":true},{"title":"Retrieve Extractors","description":"Retrieve extractors by external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extractors/byids","href":"/20230101/extractors/retrieve-extractors","autogeneratedByOpenApi":true},{"title":"List releases","description":"List releases for all extractors, or optionally for a single extractor. Results are sorted in descending version order.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /extractors/releases","href":"/20230101/extractors/list-releases","autogeneratedByOpenApi":true},{"title":"Retrieve Releases","description":"Retrieve releases by extractor external ID and version, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extractors/releases/byids","href":"/20230101/extractors/retrieve-releases","autogeneratedByOpenApi":true},{"title":"List Source Systems","description":"List source systems. Source systems represent sources that extractors may read from. They are tied to extractors through Solutions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /extractors/sources","href":"/20230101/extractors/list-source-systems","autogeneratedByOpenApi":true},{"title":"Retrieve Source Systems","description":"Retrieve source systems. Source systems represent sources that extractors may read from. They are tied to extractors through Solutions.","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","autogeneratedByOpenApi":true},{"title":"List Solutions","description":"List solutions. Solutions connect sources to extractors, documenting how a specific extractor might be used to connect to a source system.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /extractors/solutions","href":"/20230101/extractors/list-solutions","autogeneratedByOpenApi":true},{"title":"Retrieve Solutions","description":"Retrieve solutions by external ID. Solutions connect sources to extractors, documenting how a specific extractor might be used to connect to a source system.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /extractors/solutions/byids","href":"/20230101/extractors/retrieve-solutions","autogeneratedByOpenApi":true},{"title":"Get Config Schema","description":"Retrieve the configuration schema for the specified extractor and release version. The configuration schema is a [JSON Schema](https://json-schema.org/) file.","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","autogeneratedByOpenApi":true}]},{"group":"Hosted extractors","pages":[{"title":"Hosted extractors","sidebarTitle":"Overview","description":"Manage hosted extractor sources, jobs, destinations, and mappings in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/hosted-extractors"},{"group":"Sources","pages":[{"title":"Sources","sidebarTitle":"Sources","description":"Manage hosted extractor sources in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/hosted-extractors-sources"},{"title":"Create Sources","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nCreate up to 100 sources.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/sources","href":"/20230101/sources/create-sources","autogeneratedByOpenApi":true},{"title":"Delete Sources","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nDelete a list of sources by their external ID. This operation will fail if any destination in the request is associated with a job, unless the `force` query parameter is set to `true`.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/sources/delete","href":"/20230101/sources/delete-sources","autogeneratedByOpenApi":true},{"title":"List Sources","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nList all sources in a given project. If more than `limit` sources exist, a cursor for pagination will be returned with the response.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /hostedextractors/sources","href":"/20230101/sources/list-sources","autogeneratedByOpenApi":true},{"title":"Retrieve Sources","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nRetrieve a list of up to 100 sources by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/sources/byIds","href":"/20230101/sources/retrieve-sources","autogeneratedByOpenApi":true},{"title":"Update Sources","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nUpdate up to 100 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","autogeneratedByOpenApi":true}]},{"group":"Jobs","pages":[{"title":"Jobs","sidebarTitle":"Jobs","description":"Manage hosted extractor jobs in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/hosted-extractors-jobs"},{"title":"Create Jobs","description":"\n\n> **Required capabilities:** `hostedExtractors:READ` `hostedExtractors:WRITE`\n\nCreate up to 10 jobs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/jobs","href":"/20230101/jobs/create-jobs","autogeneratedByOpenApi":true},{"title":"Delete Jobs","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nDelete a list of jobs by their external ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/jobs/delete","href":"/20230101/jobs/delete-jobs","autogeneratedByOpenApi":true},{"title":"Get Job Logs","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nList logs, optionally filtering on job, source, or destination. Logs are retrieved in reverse chronological order.","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","autogeneratedByOpenApi":true},{"title":"Get Job DLQ Messages","description":"Lists dead letter queue messages for a job. Requires `hostedExtractors:READ` and `rawAcl:READ`. See [Dead letter queue](/api-reference/concepts/20230101/hosted-extractors-jobs#dead-letter-queue).","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","autogeneratedByOpenApi":true},{"title":"Get Job Metrics","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nList metrics, optionally filtering on job, source, or destination. Logs are retrieved in reverse chronological order.","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","autogeneratedByOpenApi":true},{"title":"Retrieve Jobs","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nRetrieve a list of up to 100 jobs by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/jobs/byIds","href":"/20230101/jobs/retrieve-jobs","autogeneratedByOpenApi":true},{"title":"Update Jobs","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nUpdate a list of up to 100 jobs. Enabling the dead letter queue for a job, or moving a job that has it enabled to a different destination, requires the job's destination credentials to have write access to CDF RAW, in addition to `hostedExtractors:WRITE`. Before updating, the destination session is refreshed and the DLQ storage for the job is created. The request fails with status 400 if the destination has no session, the session cannot be refreshed, or the session lacks RAW write access. It fails with status 502 if CDF cannot be reached or RAW returns a server error during this check. If the check fails for any job, no jobs in the request are updated. The check is not run for jobs that already have the dead letter queue enabled and keep their destination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/jobs/update","href":"/20230101/jobs/update-jobs","autogeneratedByOpenApi":true}]},{"group":"Destinations","pages":[{"title":"Destinations","sidebarTitle":"Destinations","description":"Manage hosted extractor destinations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/hosted-extractors-destinations"},{"title":"Create Destinations","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nCreate up to 100 destinations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/destinations","href":"/20230101/destinations/create-destinations","autogeneratedByOpenApi":true},{"title":"Delete Destinations","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nDelete a list of destinations by their external ID. This operation will fail if any destination in the request is associated with a job, unless the `force` query parameter is set to `true`.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/destinations/delete","href":"/20230101/destinations/delete-destinations","autogeneratedByOpenApi":true},{"title":"Retrieve Destinations","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nRetrieve a list of up to 100 destinations by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/destinations/byIds","href":"/20230101/destinations/retrieve-destinations","autogeneratedByOpenApi":true},{"title":"Update Destinations","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nUpdate up to 100 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","autogeneratedByOpenApi":true}]},{"group":"Mappings","pages":[{"title":"Mappings","sidebarTitle":"Mappings","description":"Manage hosted extractor mappings in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/hosted-extractors-mappings"},{"title":"Create Mappings","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nCreate up to 100 mappings.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/mappings","href":"/20230101/mappings/create-mappings","autogeneratedByOpenApi":true},{"title":"Delete Mappings","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nDelete a list of mappings by their external ID. This operation will fail if any mapping in the request is associated with a job, unless the `force` query parameter is set to `true`.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/mappings/delete","href":"/20230101/mappings/delete-mappings","autogeneratedByOpenApi":true},{"title":"Retrieve Mappings","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nRetrieve a list of up to 100 mappings by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /hostedextractors/mappings/byIds","href":"/20230101/mappings/retrieve-mappings","autogeneratedByOpenApi":true},{"title":"Update Mappings","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nUpdate up to 100 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","autogeneratedByOpenApi":true}]}]}]},{"group":"Data organization","pages":[{"title":"Data organization","sidebarTitle":"Overview","description":"Govern ready-for-consumption data with data products in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/data-organization"},{"group":"Data products","pages":[{"title":"Data products","sidebarTitle":"Overview","description":"Govern ready-for-consumption data with data products and versioned views in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/data-products"},{"title":"Create a data product","description":"\n\n> **Required capabilities:** `dataProductsAcl:CREATE`\n\nCreates a new data product. Maximum 100 data products allowed per project. Request body must contain an 'items' array with up to 1 data product definition per request.","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","autogeneratedByOpenApi":true},{"title":"List data products","description":"\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nList all data products, with pagination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /dataproducts","href":"/20230101/data-products/list-data-products","autogeneratedByOpenApi":true},{"title":"Get a data product","description":"\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nRetrieves a specific data product by its external identifier.","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","autogeneratedByOpenApi":true},{"title":"Delete a data product","description":"\n\n> **Required capabilities:** `dataProductsAcl:DELETE`\n\nPermanently removes a data product. A data product can not be deleted if it contains versions. This operation cannot be undone.","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","autogeneratedByOpenApi":true},{"title":"Update a data product","description":"\n\n> **Required capabilities:** `dataProductsAcl:UPDATE`\n\nUpdate the attributes of a data product. Fields that aren't included in the request aren't changed.\n","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","autogeneratedByOpenApi":true},{"title":"Get data products","description":"\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nGet data products by externalId.","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","autogeneratedByOpenApi":true},{"title":"Create a data product version","description":"Creates one data product version. A product can have 10 versions. Requires `dataProductsAcl:UPDATE`. See [Limits](/api-reference/concepts/20230101/data-products#limits).","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","autogeneratedByOpenApi":true},{"title":"List data product versions","description":"\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nList all versions of a data product, with pagination.","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","autogeneratedByOpenApi":true},{"title":"Get a data product version","description":"\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nRetrieves a specific version of a data product by its semantic 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","autogeneratedByOpenApi":true},{"title":"Delete data product versions","description":"\n\n> **Required capabilities:** `dataProductsAcl:UPDATE`\n\nDeletes one or more versions of a data product. Accepts a list of semantic versions. When a version is deleted, access filter entries for that version are removed from all data product roles of the owning data product. This operation cannot be undone.\n","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","autogeneratedByOpenApi":true},{"title":"Update data product version","description":"\n\n> **Required capabilities:** `dataProductsAcl:UPDATE`\n\nUpdate the attributes of a data product version. Fields that aren't included in the request aren't changed.\n","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","autogeneratedByOpenApi":true}]}]},{"group":"Transformations","pages":[{"title":"Transformations","sidebarTitle":"Overview","description":"Process and move data within Cognite Data Fusion (CDF) using SQL-based transformations.","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/transformations-overview"},{"group":"Transformations","pages":[{"title":"Transformations","sidebarTitle":"Overview","description":"Create and manage data transformations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/transformations"},{"title":"Create transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nCreate a maximum of 1000 transformations per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations","href":"/20230101/transformations/create-transformations","autogeneratedByOpenApi":true},{"title":"Cancel a transformation","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/cancel","href":"/20230101/transformations/cancel-a-transformation","autogeneratedByOpenApi":true},{"title":"Delete transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nDelete a maximum of 1000 transformations by ids and externalIds per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/delete","href":"/20230101/transformations/delete-transformations","autogeneratedByOpenApi":true},{"title":"Filter transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nFilter transformations. Use nextCursor to paginate through the results.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/filter","href":"/20230101/transformations/filter-transformations","autogeneratedByOpenApi":true},{"title":"Retrieve transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nRetrieve a maximum of 1000 transformations by ids and externalIds per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/byids","href":"/20230101/transformations/retrieve-transformations","autogeneratedByOpenApi":true},{"title":"Run a transformation","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/run","href":"/20230101/transformations/run-a-transformation","autogeneratedByOpenApi":true},{"title":"Update transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nUpdate the attributes of transformations, maximum 1000 per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/update","href":"/20230101/transformations/update-transformations","autogeneratedByOpenApi":true}]},{"group":"Transformation jobs","pages":[{"title":"Transformation Jobs","sidebarTitle":"Overview","description":"Monitor transformation job executions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/transformation-jobs"},{"title":"List jobs","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /transformations/jobs","href":"/20230101/transformation-jobs/list-jobs","autogeneratedByOpenApi":true},{"title":"Retrieve jobs by ids","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nRetrieve a maximum of 1000 jobs by ids per request.","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","autogeneratedByOpenApi":true},{"title":"List job metrics by job id","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n","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","autogeneratedByOpenApi":true}]},{"group":"Transformation schedules","pages":[{"title":"Transformation Schedules","sidebarTitle":"Overview","description":"Schedule transformations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/transformation-schedules"},{"title":"List all schedules","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nList all transformation schedules. Use nextCursor to paginate through the results.","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","autogeneratedByOpenApi":true},{"title":"Schedule transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nSchedule transformations with the specified configurations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /transformations/schedules","href":"/20230101/transformation-schedules/schedule-transformations","autogeneratedByOpenApi":true},{"title":"Retrieve schedules","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nRetrieve transformation schedules by transformation IDs or external IDs.","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","autogeneratedByOpenApi":true},{"title":"Unschedule transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nUnschedule transformations by IDs or externalIds.","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","autogeneratedByOpenApi":true},{"title":"Update schedules","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n","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","autogeneratedByOpenApi":true}]},{"group":"Transformation notifications","pages":[{"title":"Transformation Notifications","sidebarTitle":"Overview","description":"Subscribe to transformation notifications in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/transformation-notifications"},{"title":"Subscribe for notifications","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nSubscribe for notifications on the transformation errors.","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","autogeneratedByOpenApi":true},{"title":"Delete notification subscriptions by notification ID","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nDeletes the specified notification subscriptions on the transformation. Requests to delete non-existing subscriptions do nothing, but do not throw an error.","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","autogeneratedByOpenApi":true}]},{"group":"Query","pages":[{"title":"Query","sidebarTitle":"Overview","description":"Run SQL queries against CDF resources in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/transformation-query"},{"title":"Run query","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nPreview a SQL 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","autogeneratedByOpenApi":true}]},{"group":"Schema","pages":[{"title":"Schema","sidebarTitle":"Overview","description":"Retrieve resource schemas for transformations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/transformation-schema"},{"title":"Get Instance schema.","description":"Returns the instance schema for a view or a data model. Requires `transformationsAcl:READ`. See [Instance schema](/api-reference/concepts/20230101/transformations#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","autogeneratedByOpenApi":true},{"title":"Get the schema of a sequence","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n","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","autogeneratedByOpenApi":true},{"title":"Get the schema of resource type","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n","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","autogeneratedByOpenApi":true}]}]}]},{"group":"Documents","icon":"file-text","expanded":true,"pages":[{"group":"Documents","pages":[{"title":"Documents","sidebarTitle":"Overview","description":"Search, manage, and preview documents in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/documents-overview"},{"group":"Documents","pages":[{"title":"Documents","sidebarTitle":"Overview","description":"Search and manage documents in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/documents"},{"title":"Aggregate","description":"Compute aggregated results on documents, such as counts, distinct values, and unique properties.","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/aggregate"},{"title":"Search","description":"Search for documents using advanced filters and free text queries.","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/search"},{"title":"Passages search","description":"Search for relevant passages of PDF documents using semantic and lexical search filters.","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/passages-search"},{"title":"Aggregate documents","description":"Aggregates documents that match a filter or search. Requires `filesAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/documents#aggregates).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /documents/aggregate","href":"/20230101/documents/aggregate-documents","autogeneratedByOpenApi":true},{"title":"List documents","description":"Lists documents. Unlike search, pagination is not capped at 1000 documents. 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/list","href":"/20230101/documents/list-documents","autogeneratedByOpenApi":true},{"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","autogeneratedByOpenApi":true},{"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},{"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","autogeneratedByOpenApi":true}]},{"group":"Document preview","pages":[{"title":"Document preview","sidebarTitle":"Overview","description":"Preview documents in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/document-preview"},{"title":"Retrieve a image preview of a page from a document","description":"Returns a PNG preview of one page. Set `Accept` to `image/png`. Requires `filesAcl:READ`. See [Rendering limits](/api-reference/concepts/20230101/document-preview#rendering-limits).","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","autogeneratedByOpenApi":true},{"title":"Retrieve a PDF preview of a document","description":"Returns a PDF preview. Set `Accept` to `application/pdf`. Requires `filesAcl:READ`. See [Rendering limits](/api-reference/concepts/20230101/document-preview#rendering-limits).","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","autogeneratedByOpenApi":true},{"title":"Retrieve a temporary link to a PDF preview of a document","description":"\n\n> **Required capabilities:** `filesAcl:READ`\n\nThis endpoint works similar as the normal preview endpoint except\nit returns a short-lived temporary link to download the rendered preview instead\nof returning the binary data.","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","autogeneratedByOpenApi":true}]}]}]},{"group":"Workflows","icon":"workflow","pages":[{"title":"Workflows API overview","sidebarTitle":"Overview","description":"Orchestrate multi-step data processing pipelines in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/workflows-overview"},{"group":"Workflows","pages":[{"title":"Workflows API","sidebarTitle":"Overview","description":"Create and manage data workflows in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/workflows"},{"title":"Create or update a workflow","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nCreate or update a workflow. Limited to a single workflow per request.","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","autogeneratedByOpenApi":true},{"title":"Delete workflows","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nDelete workflows, including all associated workflow versions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /workflows/delete","href":"/20230101/workflows/delete-workflows","autogeneratedByOpenApi":true},{"title":"Retrieve a workflow","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nRetrieve a workflow by its external id.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /workflows/{workflowExternalId}","href":"/20230101/workflows/retrieve-a-workflow","autogeneratedByOpenApi":true}]},{"group":"Workflow versions","pages":[{"title":"Workflow versions","sidebarTitle":"Overview","description":"Manage workflow versions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/workflow-versions"},{"title":"Create or update a workflow version","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nCreate or update a workflow version. Limited to a single workflow version per request.","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","autogeneratedByOpenApi":true},{"title":"Filter workflow versions","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nList workflow versions matching a given filter.","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","autogeneratedByOpenApi":true},{"title":"Retrieve a workflow version","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nRetrieve a version of a given workflow.","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","autogeneratedByOpenApi":true},{"title":"Delete workflow versions","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nDelete specific versions of one or more workflows.","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","autogeneratedByOpenApi":true}]},{"group":"Workflow executions","pages":[{"title":"Workflow executions","sidebarTitle":"Overview","description":"Run and monitor workflow executions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/workflow-executions"},{"title":"Run a workflow","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nStart an execution of a specific version of 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","autogeneratedByOpenApi":true},{"title":"Filter workflow executions","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nList workflow executions matching a given filter.","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","autogeneratedByOpenApi":true},{"title":"Retrieve workflow execution details","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nRetrieve detailed information about a specific workflow execution.","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","autogeneratedByOpenApi":true},{"title":"Cancel a workflow execution","description":"Stops an execution from starting new tasks and sets it to `TERMINATED`. Requires `workflowOrchestrationACL:WRITE`. See [Canceling executions](/api-reference/concepts/20230101/workflow-executions#canceling-executions).","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","autogeneratedByOpenApi":true},{"title":"Retry workflow execution","description":"Retries tasks that did not finish in a failed, timed out, or terminated execution. Requires `workflowOrchestrationACL:WRITE`. See [Retrying executions](/api-reference/concepts/20230101/workflow-executions#retrying-executions).","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","autogeneratedByOpenApi":true}]},{"group":"Workflow triggers","pages":[{"title":"Workflow triggers","sidebarTitle":"Overview","description":"Schedule and manage workflow triggers in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/workflow-triggers"},{"title":"Create or update triggers","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nCreate or update a trigger.","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","autogeneratedByOpenApi":true},{"title":"Delete triggers","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nDelete a trigger.","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","autogeneratedByOpenApi":true},{"title":"Get the run history of a trigger","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nGet information about every run of a trigger. This includes timing information and a reference to the started execution (or an explanation as to why it failed). The returned items are sorted by `fireTime` in descending order (newest first), followed by `externalId` in ascending order.","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","autogeneratedByOpenApi":true},{"title":"Pause a trigger","description":"Pauses a trigger so it does not fire. Stream triggers resume from the cursor at pause time. Requires `workflowOrchestrationACL:WRITE`. See [Pause and resume](/api-reference/concepts/20230101/workflow-triggers#pause-and-resume).","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","autogeneratedByOpenApi":true},{"title":"Resume a trigger","description":"Resumes a paused trigger. Stream triggers continue from the cursor at pause time. Requires `workflowOrchestrationACL:WRITE`. See [Pause and resume](/api-reference/concepts/20230101/workflow-triggers#pause-and-resume).","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","autogeneratedByOpenApi":true}]},{"group":"Tasks","pages":[{"title":"Tasks","sidebarTitle":"Tasks","description":"Update workflow task statuses in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/workflow-tasks"},{"title":"Update task status","description":"Sets the status of an asynchronous task to completed or failed. Requires `workflowOrchestrationACL:WRITE`. See [Complete an async task](/api-reference/concepts/20230101/workflow-executions#complete-an-async-task).","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","autogeneratedByOpenApi":true}]}]},{"group":"Specialized","icon":"sparkles","expanded":true,"pages":[{"group":"Simulators","pages":[{"title":"Simulators","sidebarTitle":"Overview","description":"Integrate simulation software with Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/simulators-overview"},{"group":"Simulators","pages":[{"title":"Simulators","sidebarTitle":"Overview","description":"Manage simulators in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/simulators"},{"title":"Filter Simulators","description":"List simulators.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/list","href":"/20230101/simulators/filter-simulators","autogeneratedByOpenApi":true}]},{"group":"Simulator integrations","pages":[{"title":"Simulator Integrations","sidebarTitle":"Overview","description":"Manage simulator integrations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/simulator-integrations"},{"title":"Delete Simulator Integrations","description":"Delete a simulator integration. This will also delete all associated simulator resources (e.g. routines, runs).","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","autogeneratedByOpenApi":true},{"title":"Filter Simulator Integrations","description":"Retrieves a list of simulator integrations that match the given criteria.","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","autogeneratedByOpenApi":true}]},{"group":"Simulator models","pages":[{"title":"Simulator Models","sidebarTitle":"Overview","description":"Manage simulator models in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/simulator-models"},{"title":"Create Simulator Model","description":"Create a 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","autogeneratedByOpenApi":true},{"title":"Filter Simulator Models","description":"Retrieves a list of simulator models that match the given criteria.","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","autogeneratedByOpenApi":true},{"title":"Aggregate Simulator Models","description":"Calculate aggregates for simulator models, considering the optional filter specification.","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","autogeneratedByOpenApi":true},{"title":"Delete Simulator Model","description":"Delete a simulator model. This will also delete all associated simulator resources (e.g. revisions, routines, runs).","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","autogeneratedByOpenApi":true},{"title":"Update Simulator Model","description":"Update a 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","autogeneratedByOpenApi":true},{"title":"Retrieve Simulator Model","description":"Retrieve a simulator model by ID or external ID.","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","autogeneratedByOpenApi":true},{"title":"Create Simulator Model Revision","description":"Create a 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","autogeneratedByOpenApi":true},{"title":"Filter Simulator Model Revisions","description":"Retrieves a list of simulator model revisions that match the given criteria.","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","autogeneratedByOpenApi":true},{"title":"Retrieve Simulator Model Revisions","description":"Retrieve one or more simulator model revisions by IDs or external IDs.","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","autogeneratedByOpenApi":true}]},{"group":"Simulator routines","pages":[{"title":"Simulator Routines","sidebarTitle":"Overview","description":"Manage simulator routines in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/simulator-routines"},{"title":"Create Simulator Routine","description":"Create a 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","autogeneratedByOpenApi":true},{"title":"Filter Simulator Routines","description":"Retrieves a list of simulator routines that match the given criteria.","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","autogeneratedByOpenApi":true},{"title":"Delete Simulator Routine","description":"Delete a simulator routine. This will also delete all associated simulator resources (e.g. revisions, runs, data).","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","autogeneratedByOpenApi":true},{"title":"Aggregate Simulator Routines","description":"Calculate aggregates for simulator routines, considering the optional filter specification.","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","autogeneratedByOpenApi":true},{"title":"Create Simulator Routine Revision","description":"Creates a routine revision. The body can be at most 50 KB. See [Revision size](/api-reference/concepts/20230101/simulator-routines#revision-size).","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","autogeneratedByOpenApi":true},{"title":"Filter Simulator Routine Revisions","description":"Retrieves a list of simulator routine revisions that match the given criteria.","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","autogeneratedByOpenApi":true},{"title":"Retrieve Simulator Routine Revisions","description":"Retrieve one or more simulator routine revisions by IDs or external IDs.","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","autogeneratedByOpenApi":true}]},{"group":"Simulation runs","pages":[{"title":"Simulation Runs","sidebarTitle":"Overview","description":"Execute and monitor simulation runs in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/simulation-runs"},{"title":"Run Simulation","description":"Request to run a simulator routine asynchronously.\n\nThe total size of the request body can be a maximum of 50.00 KB.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /simulators/run","href":"/20230101/simulation-runs/run-simulation","autogeneratedByOpenApi":true},{"title":"Filter Simulation Runs","description":"Retrieves a list of simulation runs that match the given criteria.","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","autogeneratedByOpenApi":true},{"title":"Retrieve Simulation","description":"Retrieve a simulation run by ID.","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","autogeneratedByOpenApi":true},{"title":"Retrieve Simulation Data","description":"Retrieve data associated with a simulation run by ID.","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","autogeneratedByOpenApi":true}]},{"group":"Simulator logs","pages":[{"title":"Simulator Logs","sidebarTitle":"Overview","description":"Retrieve simulator logs in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/simulator-logs"},{"title":"Retrieve Simulator Logs","description":"Retrieve one or more simulator logs by IDs.","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","autogeneratedByOpenApi":true}]}]},{"group":"Units","pages":[{"title":"Units","sidebarTitle":"Overview","description":"Access the units catalog and unit systems in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/units-overview"},{"group":"Units","pages":[{"title":"Units","sidebarTitle":"Overview","description":"Access the units catalog in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/units"},{"title":"List all units","description":"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","autogeneratedByOpenApi":true},{"title":"Retrieve unit by external ID","description":"Retrieve a single unit by its 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","autogeneratedByOpenApi":true},{"title":"Retrieve units by external IDs","description":"Retrieves one or more units by external ID. The response returns the units in the same order as in the request.","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","autogeneratedByOpenApi":true}]},{"group":"Unit systems","pages":[{"title":"Unit Systems","sidebarTitle":"Overview","description":"Access unit systems in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/unit-systems"},{"title":"List all unit systems","description":"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","autogeneratedByOpenApi":true}]}]}]},{"group":"Legacy","icon":"archive","expanded":true,"pages":[{"group":"Legacy data modeling","pages":[{"title":"Asset-centric data modeling (legacy)","sidebarTitle":"Overview","description":"This is the original CDF approach, where data is organized around a hierarchy of physical equipment (assets). While fully supported for existing solutions, it lacks the flexibility of data modeling for the knowledge graph.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","applicable-to":["asset-centric"],"article-type":"article","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/asset-centric"},{"group":"Assets","pages":[{"title":"Assets","sidebarTitle":"Overview","description":"Manage assets in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/assets"},{"title":"Aggregate assets","description":"Aggregates assets. Requires `assetsAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/assets#aggregates).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /assets/aggregate","href":"/20230101/assets/aggregate-assets","autogeneratedByOpenApi":true},{"title":"Create assets","description":"Creates assets. Requires `assetsAcl:WRITE`. See [Assets](/api-reference/concepts/20230101/assets).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /assets","href":"/20230101/assets/create-assets","autogeneratedByOpenApi":true},{"title":"Delete assets","description":"Deletes assets. Set `recursive` to true to delete descendants. Requires `assetsAcl:WRITE`. See [Delete assets](/api-reference/concepts/20230101/assets#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","autogeneratedByOpenApi":true},{"title":"Filter assets","description":"Lists assets that match a filter. This endpoint is for exploration. Requires `assetsAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/assets#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /assets/list","href":"/20230101/assets/filter-assets","autogeneratedByOpenApi":true},{"title":"List assets","description":"Lists assets in the project. This endpoint is for exploration. Requires `assetsAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/assets#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /assets","href":"/20230101/assets/list-assets","autogeneratedByOpenApi":true},{"title":"Retrieve an asset by its ID","description":"Retrieves an asset by internal ID. Requires `assetsAcl:READ`. See [Assets](/api-reference/concepts/20230101/assets).","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","autogeneratedByOpenApi":true},{"title":"Retrieve assets","description":"Retrieves assets by internal or external ID. Requires `assetsAcl:READ`. See [Assets](/api-reference/concepts/20230101/assets).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /assets/byids","href":"/20230101/assets/retrieve-assets","autogeneratedByOpenApi":true},{"title":"Search assets","description":"Searches assets by relevance. Matching and order can change, and the operation does not paginate. Requires `assetsAcl:READ`. See [Sorting](/api-reference/concepts/20230101/assets#sorting).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /assets/search","href":"/20230101/assets/search-assets","autogeneratedByOpenApi":true},{"title":"Update assets","description":"\n\n> **Required capabilities:** `assetsAcl:WRITE`\n\nUpdate the attributes of assets.\n\n### Request throttling\nThis endpoint is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Assets resource description](../../) for more information.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /assets/update","href":"/20230101/assets/update-assets","autogeneratedByOpenApi":true}]},{"group":"Time series metadata","pages":[{"title":"Time series","sidebarTitle":"Overview","description":"Manage time series data in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["asset-centric"],"api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/time-series"},{"title":"Aggregate time series","description":"Aggregates time series. Requires `timeSeriesAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/time-series#aggregates).","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","autogeneratedByOpenApi":true},{"title":"Create time series","description":"\n\n> **Required capabilities:** `timeSeriesAcl:WRITE`\n\nCreates one or more 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","autogeneratedByOpenApi":true},{"title":"Delete time series","description":"\n\n> **Required capabilities:** `timeSeriesAcl:WRITE`\n\nDeletes the time series with the specified IDs and their data points.","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","autogeneratedByOpenApi":true},{"title":"Filter time series","description":"Lists time series that match a filter. This endpoint is for exploration. Requires `timeSeriesAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/time-series#advanced-filtering).","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","autogeneratedByOpenApi":true},{"title":"List time series","description":"\n\n> **Required capabilities:** `timeSeriesAcl:READ`\n\nList time series. Use `nextCursor` to paginate through the results.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /timeseries","href":"/20230101/time-series/list-time-series","autogeneratedByOpenApi":true},{"title":"Retrieve time series","description":"\n\n> **Required capabilities:** `timeSeriesAcl:READ`\n\nRetrieves one or more time series by ID or external ID. The response returns the time series in the same order as in the request.","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","autogeneratedByOpenApi":true},{"title":"Search time series","description":"Searches time series by relevance. Requires `timeSeriesAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/time-series#advanced-filtering).","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","autogeneratedByOpenApi":true},{"title":"Update time series","description":"Updates time series. Requires `timeSeriesAcl:WRITE`. See [Time series](/api-reference/concepts/20230101/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","autogeneratedByOpenApi":true}]},{"group":"Events","pages":[{"title":"Events","sidebarTitle":"Overview","description":"Manage events in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/events"},{"title":"Aggregate events","description":"Aggregates events. Requires `eventsAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/events#aggregates).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /events/aggregate","href":"/20230101/events/aggregate-events","autogeneratedByOpenApi":true},{"title":"Create events","description":"Creates events. Requires `eventsAcl:WRITE`. See [Events](/api-reference/concepts/20230101/events).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /events","href":"/20230101/events/create-events","autogeneratedByOpenApi":true},{"title":"Delete events","description":"Deletes up to 1000 events. Requires `eventsAcl:WRITE`. See [Delete events](/api-reference/concepts/20230101/events#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","autogeneratedByOpenApi":true},{"title":"Filter events","description":"Lists events that match a filter. This endpoint is for exploration. Requires `eventsAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/events#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /events/list","href":"/20230101/events/filter-events","autogeneratedByOpenApi":true},{"title":"List events","description":"\n\n> **Required capabilities:** `eventsAcl:READ`\n\nList events optionally filtered on query parameters\n\n### Request throttling\nThis endpoint is meant for data analytics/exploration usage and is not suitable for high load data retrieval usage.\nIt is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Events resource description](../../) for more information.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /events","href":"/20230101/events/list-events","autogeneratedByOpenApi":true},{"title":"Receive an event by its ID","description":"\n\n> **Required capabilities:** `eventsAcl:READ`\n\nRetrieves an event by its internal (service-generated) ID.\n\n### Request throttling\nThis endpoint is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Events resource description](../../) for more information.","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","autogeneratedByOpenApi":true},{"title":"Retrieve events","description":"Retrieves events by internal or external ID. Requires `eventsAcl:READ`. See [Events](/api-reference/concepts/20230101/events).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /events/byids","href":"/20230101/events/retrieve-events","autogeneratedByOpenApi":true},{"title":"Search events","description":"Searches events by relevance. Matching and order can change, and the operation does not paginate. Requires `eventsAcl:READ`. See [Sorting](/api-reference/concepts/20230101/events#sorting).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /events/search","href":"/20230101/events/search-events","autogeneratedByOpenApi":true},{"title":"Update events","description":"Partially updates up to 1000 events. Requires `eventsAcl:WRITE`. See [Update events](/api-reference/concepts/20230101/events#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","autogeneratedByOpenApi":true}]},{"group":"File metadata","pages":[{"title":"Files","sidebarTitle":"Overview","description":"Manage files in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["asset-centric"],"api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/files"},{"title":"Aggregate files","description":"Counts files that match a filter. Requires `filesAcl:READ`. See [Files](/api-reference/concepts/20230101/files).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/aggregate","href":"/20230101/files/aggregate-files","autogeneratedByOpenApi":true},{"title":"Upload file","description":"Creates file metadata and returns an upload URL. Requires `filesAcl:WRITE`. See [Upload limits](/api-reference/concepts/20230101/file-content#upload-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files","href":"/20230101/files/upload-file","autogeneratedByOpenApi":true},{"title":"Delete files","description":"Deletes up to 1000 files. Requires `filesAcl:WRITE`. See [Delete files](/api-reference/concepts/20230101/files#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","autogeneratedByOpenApi":true},{"title":"Filter files","description":"Lists files that match a filter. This endpoint is for exploration. Requires `filesAcl:READ`. See [Files](/api-reference/concepts/20230101/files).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/list","href":"/20230101/files/filter-files","autogeneratedByOpenApi":true},{"title":"List files","description":"Lists files in the project. This endpoint is for exploration. Requires `filesAcl:READ`. See [Files](/api-reference/concepts/20230101/files).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /files","href":"/20230101/files/list-files","autogeneratedByOpenApi":true},{"title":"Retrieve a file by its ID","description":"Retrieves file metadata by internal ID. Requires `filesAcl:READ`, or data modeling read. See [Files](/api-reference/concepts/20230101/files).","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","autogeneratedByOpenApi":true},{"title":"Retrieve files","description":"Retrieves file metadata for the requested IDs, in request order. Requires `filesAcl:READ`, or data modeling read. See [Files](/api-reference/concepts/20230101/files).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/byids","href":"/20230101/files/retrieve-files","autogeneratedByOpenApi":true},{"title":"Search files","description":"Searches files by relevance and returns at most 1000 matches. Requires `filesAcl:READ`. See [Search](/api-reference/concepts/20230101/files#search).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/search","href":"/20230101/files/search-files","autogeneratedByOpenApi":true},{"title":"Update files","description":"Updates file metadata. Replace content with init upload and `overwrite=true`. Requires `filesAcl:WRITE`. See [Update metadata](/api-reference/concepts/20230101/files#update-metadata).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /files/update","href":"/20230101/files/update-files","autogeneratedByOpenApi":true}]},{"group":"Sequences","pages":[{"title":"Sequences","sidebarTitle":"Overview","description":"Manage sequences in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/sequences"},{"title":"Aggregate sequences","description":"Aggregates sequences. Requires `sequencesAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/sequences#aggregates).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/aggregate","href":"/20230101/sequences/aggregate-sequences","autogeneratedByOpenApi":true},{"title":"Create sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nCreate one or more sequences.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences","href":"/20230101/sequences/create-sequences","autogeneratedByOpenApi":true},{"title":"Delete rows","description":"\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nDeletes the given rows of the sequence. All columns are affected.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/data/delete","href":"/20230101/sequences/delete-rows","autogeneratedByOpenApi":true},{"title":"Delete sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nDeletes the sequences with the specified IDs. If one or more of the sequences do not exist, the `ignoreUnknownIds` parameter controls what will happen: if it is `true`, the sequences that do exist will be deleted, and the request succeeds; if it is `false` or absent, nothing will be deleted, and the request fails.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/delete","href":"/20230101/sequences/delete-sequences","autogeneratedByOpenApi":true},{"title":"Filter sequences","description":"Lists sequences that match a filter. This endpoint is for exploration. Requires `sequencesAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/sequences#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/list","href":"/20230101/sequences/filter-sequences","autogeneratedByOpenApi":true},{"title":"Insert rows","description":"\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nInserts rows into a sequence. This overwrites data in rows and columns that exist.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/data","href":"/20230101/sequences/insert-rows","autogeneratedByOpenApi":true},{"title":"List sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nList sequences. Use `nextCursor` to paginate through the results.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /sequences","href":"/20230101/sequences/list-sequences","autogeneratedByOpenApi":true},{"title":"Retrieve last row","description":"\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nRetrieves the last row in one or more sequences. Note that the last row in a sequence is the\none with the highest row number, which is not necessarily the one that was ingested most\nrecently.\n","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","autogeneratedByOpenApi":true},{"title":"Retrieve rows","description":"\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nProcesses data requests and returns the result. Note that this operation uses a dynamic limit on the number of rows returned based on the number and type of columns; use the provided cursor to paginate and retrieve all data.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/data/list","href":"/20230101/sequences/retrieve-rows","autogeneratedByOpenApi":true},{"title":"Retrieve sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nRetrieves one or more sequences by ID or external ID. The response returns the sequences in the same order as in the request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/byids","href":"/20230101/sequences/retrieve-sequences","autogeneratedByOpenApi":true},{"title":"Search sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nRetrieves a list of sequences matching the given criteria. This operation doesn't support pagination.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/search","href":"/20230101/sequences/search-sequences","autogeneratedByOpenApi":true},{"title":"Update sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nUpdates one or more sequences. Fields outside of the request remain unchanged.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /sequences/update","href":"/20230101/sequences/update-sequences","autogeneratedByOpenApi":true}]},{"group":"Data sets","pages":[{"title":"Data sets","sidebarTitle":"Overview","description":"Organize and govern data with data sets in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/data-sets"},{"title":"Create data sets","description":"\n\n> **Required capabilities:** `datasetsAcl:WRITE`\n\nYou can create a maximum of 10 data sets per request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /datasets","href":"/20230101/data-sets/create-data-sets","autogeneratedByOpenApi":true},{"title":"Aggregate data sets","description":"\n\n> **Required capabilities:** `datasetsAcl:READ`\n\nAggregate data sets in the same project. Criteria can be applied to select a subset of 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","autogeneratedByOpenApi":true},{"title":"Filter data sets","description":"\n\n> **Required capabilities:** `datasetsAcl:READ`\n\nUse advanced filtering options to find 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","autogeneratedByOpenApi":true},{"title":"Retrieve data sets","description":"\n\n> **Required capabilities:** `datasetsAcl:READ`\n\nRetrieve data sets by IDs or external IDs.","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","autogeneratedByOpenApi":true},{"title":"Update data sets.","description":"\n\n> **Required capabilities:** `datasetsAcl:WRITE`\n","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","autogeneratedByOpenApi":true}]},{"group":"Labels","pages":[{"title":"Labels","sidebarTitle":"Overview","description":"Create and manage labels in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/labels"},{"title":"Create label definitions.","description":"\n\n> **Required capabilities:** `labelsAcl:WRITE`\n\nCreates label definitions that can be used across different resource types. The label definitions are uniquely identified by their external id.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /labels","href":"/20230101/labels/create-label-definitions","autogeneratedByOpenApi":true},{"title":"Filter labels","description":"\n\n> **Required capabilities:** `labelsAcl:READ`\n\nUse advanced filtering options to find label definitions.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /labels/list","href":"/20230101/labels/filter-labels","autogeneratedByOpenApi":true},{"title":"Retrieve labels","description":"\n\n> **Required capabilities:** `labelsAcl:READ`\n\nRetrieve labels using their external ids","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /labels/byids","href":"/20230101/labels/retrieve-labels","autogeneratedByOpenApi":true},{"title":"Delete label definitions.","description":"\n\n> **Required capabilities:** `labelsAcl:WRITE`\n\nDelete all the label definitions specified by their external ids. The resource items that have the corresponding label attached remain unmodified. It is up to the client to clean up the resource items from their attached labels if necessary.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /labels/delete","href":"/20230101/labels/delete-label-definitions","autogeneratedByOpenApi":true}]},{"group":"Relationships","pages":[{"title":"Relationships","sidebarTitle":"Overview","description":"Create and manage relationships between resources in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/relationships"},{"title":"Create relationships","description":"Creates up to 1000 relationships. `externalId` must be unique. Requires `relationshipsAcl:WRITE`. See [Create and update](/api-reference/concepts/20230101/relationships#create-and-update).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /relationships","href":"/20230101/relationships/create-relationships","autogeneratedByOpenApi":true},{"title":"Delete relationships","description":"\n\n> **Required capabilities:** `relationshipsAcl:WRITE`\n\nDelete the relationships between resources identified by the external IDs in the request. You can delete a maximum of 1000 relationships per request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /relationships/delete","href":"/20230101/relationships/delete-relationships","autogeneratedByOpenApi":true},{"title":"Filter relationships","description":"\n\n> **Required capabilities:** `relationshipsAcl:READ`\n\nLists relationships matching the query filter in the request. You can retrieve a maximum of 1000 relationships per request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /relationships/list","href":"/20230101/relationships/filter-relationships","autogeneratedByOpenApi":true},{"title":"List relationships","description":"\n\n> **Required capabilities:** `relationshipsAcl:READ`\n\nLists all relationships. The order of retrieved objects may change for two calls with the same parameters.\nThe endpoint supports pagination. The initial call to this endpoint should not contain a cursor, but the cursor parameter should be used to retrieve further pages of results.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /relationships","href":"/20230101/relationships/list-relationships","autogeneratedByOpenApi":true},{"title":"Retrieve relationships","description":"\n\n> **Required capabilities:** `relationshipsAcl:READ`\n\nRetrieve relationships by external IDs. You can retrieve a maximum of 1000 relationships per request.\nThe order of the relationships in the response equals the order in the request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /relationships/byids","href":"/20230101/relationships/retrieve-relationships","autogeneratedByOpenApi":true},{"title":"Update relationships","description":"Partially updates up to 1000 relationships. Requires `relationshipsAcl:WRITE` and `relationshipsAcl:READ`. See [Create and update](/api-reference/concepts/20230101/relationships#create-and-update).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /relationships/update","href":"/20230101/relationships/update-relationships","autogeneratedByOpenApi":true}]},{"group":"Annotations","pages":[{"title":"Annotations","sidebarTitle":"Overview","description":"Create and manage annotations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/annotations"},{"title":"Create annotations","description":"Creates annotations on resources you can read. Requires `annotationsAcl:WRITE`. See [Create annotations](/api-reference/concepts/20230101/annotations#create-annotations).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /annotations","href":"/20230101/annotations/create-annotations","autogeneratedByOpenApi":true},{"title":"Suggest annotations","description":"Creates annotations with status `suggested`. Requires `annotationsAcl:SUGGEST`. See [Create annotations](/api-reference/concepts/20230101/annotations#create-annotations).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /annotations/suggest","href":"/20230101/annotations/suggest-annotations","autogeneratedByOpenApi":true},{"title":"Get an annotation","description":"Retrieves the referenced annotation.\n\nThe caller _must_ have read-access on the **annotated resource**, otherwise the call will fail.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json get /annotations/{annotationId}","href":"/20230101/annotations/get-an-annotation","autogeneratedByOpenApi":true},{"title":"Filter annotations","description":"Lists the annotations the caller has access to, based on a filter.\n\nThe caller _must_ have read-access on the **annotated resources** listed in the filter, otherwise the call will\nfail.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /annotations/list","href":"/20230101/annotations/filter-annotations","autogeneratedByOpenApi":true},{"title":"Retrieve annotations","description":"Retrieves the referenced annotations.\n\nThe caller _must_ have read-access on all the **annotated resources**, otherwise the call will fail.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /annotations/byids","href":"/20230101/annotations/retrieve-annotations","autogeneratedByOpenApi":true},{"title":"Delete annotations","description":"\n\n> **Required capabilities:** `annotationsAcl:WRITE`\n\nDeletes the referenced annotations completely.\n\nThe caller _must_ have read-access on all the **annotated resources**, otherwise the call will fail.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /annotations/delete","href":"/20230101/annotations/delete-annotations","autogeneratedByOpenApi":true},{"title":"Update annotations","description":"\n\n> **Required capabilities:** `annotationsAcl:WRITE`\n\nUpdates the referenced annotations.\n\nThe caller _must_ have read-access on all the **annotated resources**, otherwise the call will fail.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /annotations/update","href":"/20230101/annotations/update-annotations","autogeneratedByOpenApi":true}]},{"group":"Geospatial","pages":[{"title":"Geospatial","sidebarTitle":"Overview","description":"Manage geospatial data in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101","boost":2,"href":"/api-reference/concepts/20230101/geospatial"},{"title":"Aggregate features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nSearch for features based on the feature property filter and perform requested aggregations on a given property. Aggregations are supported for all filters that do not contain `stWithin`, `stWithinProperly`, `stContains` and `stContainsProperly` search in 3D geometries.","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","autogeneratedByOpenApi":true},{"title":"Compute","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialCrsAcl:READ`\n\nCompute custom json output structures or well known binary format responses based on calculation or selection of feature properties or direct values given in the request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101.json post /geospatial/compute","href":"/20230101/geospatial/compute","autogeneratedByOpenApi":true},{"title":"Create Coordinate Reference Systems","description":"\n\n> **Required capabilities:** `geospatialCrsAcl:WRITE`\n\nCreates custom 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","autogeneratedByOpenApi":true},{"title":"Create feature types","description":"\n\n> **Required capabilities:** `geospatialAcl:WRITE`\n\nCreates feature types. Each tenant can have up to 100 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","autogeneratedByOpenApi":true},{"title":"Create features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nCreate 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","autogeneratedByOpenApi":true},{"title":"Delete Coordinate Reference Systems","description":"\n\n> **Required capabilities:** `geospatialCrsAcl:WRITE`\n\nDelete custom 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","autogeneratedByOpenApi":true},{"title":"Delete feature types","description":"\n\n> **Required capabilities:** `geospatialAcl:WRITE`\n\nDelete 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","autogeneratedByOpenApi":true},{"title":"Delete features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nDelete 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","autogeneratedByOpenApi":true},{"title":"Delete a raster from a feature property","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nDelete a raster from a feature property. If there is no raster already, the operation is a no-op.","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","autogeneratedByOpenApi":true},{"title":"Get Coordinate Reference Systems","description":"\n\n> **Required capabilities:** `geospatialCrsAcl:READ`\n\nGet Coordinate Reference Systems by their Spatial Reference IDs","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","autogeneratedByOpenApi":true},{"title":"Get features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nGet features with paging support","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","autogeneratedByOpenApi":true},{"title":"List feature types","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nList all 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","autogeneratedByOpenApi":true},{"title":"Put a raster into a feature property","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nPut a raster into a feature property. The feature property must be of type RASTER.","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","autogeneratedByOpenApi":true},{"title":"Get a raster from a feature property","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nGet a raster from a feature property. The feature property must be of type RASTER.","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","autogeneratedByOpenApi":true},{"title":"Retrieve feature types","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nRetrieves feature types by external ids. It is possible to retrieve up to 100 items per request, i.e. the maximum number of feature types for a tenant.","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","autogeneratedByOpenApi":true},{"title":"Retrieve features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nRetrieves features by external ids. It is possible to retrieve up to 1000 items per request.","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","autogeneratedByOpenApi":true},{"title":"Search and stream features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nSearch for features based on the feature property filter passed in the body of the request. The streaming response format can be length prefixed, new line delimited, record separator delimited or concatenated depending on requested output (see https://en.wikipedia.org/wiki/JSON_streaming).","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","autogeneratedByOpenApi":true},{"title":"Search features","description":"Searches features. The response contains at most 1000 items. Requires `geospatialAcl:READ`. See [Search results](/api-reference/concepts/20230101/geospatial#search-results).","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","autogeneratedByOpenApi":true},{"title":"Update feature types","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nUpdate one or more 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","autogeneratedByOpenApi":true},{"title":"Update features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nUpdate features. This is a replace operation, i.e., all feature properties have to be sent in the request body even if their values do not change.","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","autogeneratedByOpenApi":true},{"title":"Filter all features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nList features based on the feature property filter passed in the body of the request. This operation supports pagination by cursor.","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","autogeneratedByOpenApi":true}]}]}]}]}]},{"item":"Beta (20230101-beta)","description":"Preview API operations on top of stable","groups":[{"group":"API reference (20230101-beta)","boost":0.5,"pages":[{"group":"Foundation","icon":"building-2","expanded":true,"pages":[{"group":"Introduction","icon":"book","expanded":true,"pages":[{"title":"Cognite API introduction","sidebarTitle":"Introduction","description":"How to call the Cognite Data Fusion REST API: URLs, calendar versioning, Postman, pagination, and throttling.","content-type":"reference","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/api-description"},{"title":"API rate limits","sidebarTitle":"Rate limits","description":"Rate and concurrency limits for Cognite Data Fusion (CDF) API endpoints.","content-type":"reference","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/rate-limits"},{"title":"Cognite API changelog","sidebarTitle":"Changelog","description":"Track all notable changes, updates, and deprecations for the Cognite Data Fusion (CDF) API v1, organized by release date and API area.","content-type":"reference","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/changelog"}]},{"group":"Organizations and projects","pages":[{"title":"Organizations and projects","sidebarTitle":"Overview","description":"Manage organizations and projects in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/organizations-and-projects"},{"group":"Organizations","pages":[{"title":"Organizations","sidebarTitle":"Overview","description":"Manage organizations, projects, and external identity providers (IdPs).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/organizations"},{"title":"Create an organization","description":"Creates a child organization. Requires an admin and `adminsCanCreateOrgsInSubtree`. See [Create a child organization](/api-reference/concepts/20230101/organizations#create-a-child-organization).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /api/v1/orgs/{org}/orgs","href":"/20230101-beta/organizations/create-an-organization","autogeneratedByOpenApi":true},{"title":"Delete an organization","description":"Soft-deletes an organization with no children and no projects. Requires an admin of the organization or an ancestor. See [Delete an organization](/api-reference/concepts/20230101/organizations#delete-an-organization).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /api/v1/orgs/{org}/delete","href":"/20230101-beta/organizations/delete-an-organization","autogeneratedByOpenApi":true},{"title":"List child organizations","description":"Lists child organizations. Requires an admin of the parent or an ancestor. See [Create a child organization](/api-reference/concepts/20230101/organizations#create-a-child-organization).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /api/v1/orgs/{org}/orgs","href":"/20230101-beta/organizations/list-child-organizations","autogeneratedByOpenApi":true},{"title":"Retrieve an organization","description":"Retrieves an organization. Requires an admin of the organization or an ancestor. See [Organizations](/api-reference/concepts/20230101/organizations).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /api/v1/orgs/{org}","href":"/20230101-beta/organizations/retrieve-an-organization","autogeneratedByOpenApi":true}]},{"group":"Projects","pages":[{"title":"Projects","sidebarTitle":"Overview","description":"Manage projects in an organization.","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/projects"},{"title":"Create a project","description":"Creates a project on an allowed cluster. Requires an admin and `adminsCanCreateProjectsInSubtree`. See [Create a project](/api-reference/concepts/20230101/projects#create-a-project).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /api/v1/orgs/{org}/projects","href":"/20230101-beta/projects/create-a-project","autogeneratedByOpenApi":true},{"title":"List projects in an organization","description":"Lists projects in an organization. Admin properties require an admin. See [List projects](/api-reference/concepts/20230101/projects#list-projects).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /api/v1/orgs/{org}/projects","href":"/20230101-beta/projects/list-projects-in-an-organization","autogeneratedByOpenApi":true}]}]},{"group":"Identity and access management","pages":[{"title":"Identity and access management","sidebarTitle":"Overview","description":"Manage principals, groups, security categories, sessions, and tokens in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/identity-and-access-management"},{"group":"Principals","pages":[{"title":"Principals","sidebarTitle":"Overview","description":"Understanding user accounts and service accounts.","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/principals"},{"title":"Get the current caller's information","description":"Retrieves the information of the principal issuing the request.\n\nThis endpoint is useful for clients to verify their own identity.\nAll authenticated principals can call this endpoint.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /api/v1/principals/me","href":"/20230101-beta/principals/get-the-current-callers-information","autogeneratedByOpenApi":true},{"title":"List login sessions","description":"Lists login sessions for a user. Requires an admin of that organization. See [Login sessions](/api-reference/concepts/20230101/principals#login-sessions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /api/v1/orgs/{org}/principals/{principal}/sessions","href":"/20230101-beta/principals/list-login-sessions","autogeneratedByOpenApi":true},{"title":"List principals","description":"List principals in an organization.\n\nAll principal types are supported.\n\n#### Access control\nRequires the caller to be logged into the target organization, or\nto be an admin in any of its the ancestor organizations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /api/v1/orgs/{org}/principals","href":"/20230101-beta/principals/list-principals","autogeneratedByOpenApi":true},{"title":"Retrieve principals by reference","description":"Retrieves principals by ID. Service accounts can also be retrieved by external ID. See [Retrieve principals](/api-reference/concepts/20230101/principals#retrieve-principals).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /api/v1/orgs/{org}/principals/byids","href":"/20230101-beta/principals/retrieve-principals-by-reference","autogeneratedByOpenApi":true},{"title":"Revoke login sessions","description":"Revokes login sessions for a user. The call is atomic and can take up to one hour. See [Login sessions](/api-reference/concepts/20230101/principals#login-sessions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /api/v1/orgs/{org}/principals/{principal}/sessions/revoke","href":"/20230101-beta/principals/revoke-login-sessions","autogeneratedByOpenApi":true}]},{"group":"Groups","pages":[{"title":"Groups","sidebarTitle":"Overview","description":"Manage groups and group membership in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/groups"},{"title":"Create groups","description":"Creates groups and their capabilities. Members receive `userProfilesAcl:READ`. Requires `groupsAcl:CREATE`. See [Capabilities](/api-reference/concepts/20230101/groups#capabilities).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /groups","href":"/20230101-beta/groups/create-groups","autogeneratedByOpenApi":true},{"title":"Delete groups","description":"\n\n> **Required capabilities:** `groupsAcl:DELETE`\n\nDeletes the groups with the given IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /groups/delete","href":"/20230101-beta/groups/delete-groups","autogeneratedByOpenApi":true},{"title":"List groups","description":"\n\n> **Required capabilities:** `groupsAcl:LIST`\n\nRetrieves a list of groups the asking principal a member of. Principals with groups:list capability can optionally ask for all groups in a project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /groups","href":"/20230101-beta/groups/list-groups","autogeneratedByOpenApi":true}]},{"group":"Security categories","pages":[{"title":"Security categories","sidebarTitle":"Overview","description":"Manage security categories in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/security-categories"},{"title":"Create security categories","description":"\n\n> **Required capabilities:** `securityCategoriesAcl:CREATE`\n\nCreates security categories with the given names. Duplicate names in the request are ignored.\nIf a security category with one of the provided names exists already, then the request will fail and no security categories are created.\n","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /securitycategories","href":"/20230101-beta/security-categories/create-security-categories","autogeneratedByOpenApi":true},{"title":"Delete security categories","description":"\n\n> **Required capabilities:** `securityCategoriesAcl:DELETE`\n\nDeletes the security categories that match the provided IDs.\nIf any of the provided IDs does not belong to an existing security category, then the request will fail and no security categories are deleted.\n","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /securitycategories/delete","href":"/20230101-beta/security-categories/delete-security-categories","autogeneratedByOpenApi":true},{"title":"List security categories","description":"\n\n> **Required capabilities:** `securityCategoriesAcl:LIST`\n\nRetrieves a list of all security categories for a project.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /securitycategories","href":"/20230101-beta/security-categories/list-security-categories","autogeneratedByOpenApi":true}]},{"group":"Sessions","pages":[{"title":"Sessions","sidebarTitle":"Overview","description":"Manage sessions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/sessions"},{"title":"Create sessions","description":"\n\n> **Required capabilities:** `sessionsAcl:CREATE`\n\nCreate sessions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /sessions","href":"/20230101-beta/sessions/create-sessions","autogeneratedByOpenApi":true},{"title":"List sessions","description":"\n\n> **Required capabilities:** `sessionsAcl:LIST`\n\nList all sessions in the current project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /sessions","href":"/20230101-beta/sessions/list-sessions","autogeneratedByOpenApi":true},{"title":"Retrieve sessions with given IDs","description":"\n\n> **Required capabilities:** `sessionsAcl:LIST`\n\nRetrieves sessions with given IDs. The request will fail if any of the IDs does not belong to an existing session.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /sessions/byids","href":"/20230101-beta/sessions/retrieve-sessions-with-given-ids","autogeneratedByOpenApi":true},{"title":"Revoke sessions","description":"\n\n> **Required capabilities:** `sessionsAcl:DELETE`\n\nRevoke access to a session. Revocation is idempotent.\nRevocation of a session may in some cases take up to 1 hour to take effect.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /sessions/revoke","href":"/20230101-beta/sessions/revoke-sessions","autogeneratedByOpenApi":true}]},{"group":"Token","pages":[{"title":"Tokens","sidebarTitle":"Overview","description":"Manage tokens in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/tokens"},{"title":"Inspect","description":"\n\n> **Required capabilities:** `projectsAcl:LIST` `groupsAcl:LIST`\n\nInspect CDF access granted to an IdP issued token","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /token/inspect","href":"/20230101-beta/token/inspect","autogeneratedByOpenApi":true}]},{"group":"User profiles","tag":"deprecated","pages":[{"title":"User profiles","sidebarTitle":"Overview","description":"Manage user profiles in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/user-profiles"},{"title":"(deprecated) Get the user profile of the principal issuing the request","description":"Returns the caller's profile. A new principal can receive 404 until the profile exists. Requires `userProfilesAcl:READ`. See [User profiles](/api-reference/concepts/20230101/user-profiles).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /profiles/me","href":"/20230101-beta/user-profiles/deprecated-get-the-user-profile-of-the-principal-issuing-the-request","autogeneratedByOpenApi":true},{"title":"Get the user profile of the principal issuing the request","description":"Deprecated in favor of the new [endpoint](#tag/Principals/operation/getMe).\n\nRetrieves the user profile of the principal issuing the request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /principals/me","href":"/20230101-beta/user-profiles/get-the-user-profile-of-the-principal-issuing-the-request","autogeneratedByOpenApi":true},{"title":"List all user profiles in the current project","description":"Lists user profiles. Deprecated. Use principals. Requires `userProfilesAcl:READ`. See [User profiles](/api-reference/concepts/20230101/user-profiles).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /profiles","href":"/20230101-beta/user-profiles/list-all-user-profiles-in-the-current-project","autogeneratedByOpenApi":true},{"title":"Retrieve profiles by ID in the current project","description":"\n\n> **Required capabilities:** `userProfilesAcl:READ`\n\nDeprecated in favor of the [Retrieve principals](#tag/Principals/operation/getPrincipalsById) endpoint.\n\nRetrieve one or more user profiles indexed by the user identifier in the same CDF project.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /profiles/byids","href":"/20230101-beta/user-profiles/retrieve-profiles-by-id-in-the-current-project","autogeneratedByOpenApi":true},{"title":"Search user profiles in the current project","description":"Searches user profiles. Deprecated. Matching can change, and the operation does not paginate. Requires `userProfilesAcl:READ`. See [User profiles](/api-reference/concepts/20230101/user-profiles).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /profiles/search","href":"/20230101-beta/user-profiles/search-user-profiles-in-the-current-project","autogeneratedByOpenApi":true}]}]}]},{"group":"Core data","icon":"database","expanded":true,"pages":[{"group":"Data modeling","pages":[{"title":"Data modeling with the industrial knowledge graph","sidebarTitle":"Overview","description":"Use these APIs for all new projects. The data modeling service (DMS) offers the full power of the Cognite Data Fusion (CDF) Knowledge Graph, allowing you to model your industrial reality exactly as it is, connecting physical assets, processes, work orders, and more without rigid hierarchy limits.","keywords":"asset, assets, asset hierarchy, CogniteAsset, knowledge graph, data model","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","applicable-to":["data-modeling"],"article-type":"article","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/data-modeling"},{"group":"Data models","pages":[{"title":"Data models","sidebarTitle":"Overview","description":"Create and manage data models in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/data-models"},{"title":"Create or update data models","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nAdd or update (upsert) data models. For unchanged data model specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for models that remain unchanged.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/datamodels","href":"/20230101-beta/data-models/create-or-update-data-models","autogeneratedByOpenApi":true},{"title":"Delete data models","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more data models. Currently limited to 100 models at a time. This does not delete the views, nor the containers they reference.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/datamodels/delete","href":"/20230101-beta/data-models/delete-data-models","autogeneratedByOpenApi":true},{"title":"List data models defined in the project","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nList data models defined in the project. You can filter the returned models by the specified space.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /models/datamodels","href":"/20230101-beta/data-models/list-data-models-defined-in-the-project","autogeneratedByOpenApi":true},{"title":"Retrieve data models by their external ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 100 data models by their external ids. Views can be auto-expanded when the ```InlineViews``` query parameter is set.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/datamodels/byids","href":"/20230101-beta/data-models/retrieve-data-models-by-their-external-ids","autogeneratedByOpenApi":true}]},{"group":"Spaces","pages":[{"title":"Spaces","sidebarTitle":"Overview","description":"Manage spaces for organizing data models in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/spaces"},{"title":"Create or update spaces","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nAdd or update (upsert) spaces. For unchanged space specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for spaces that remain unchanged.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/spaces","href":"/20230101-beta/spaces/create-or-update-spaces","autogeneratedByOpenApi":true},{"title":"Delete spaces","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more spaces, maximum 100 spaces at a time.\n\n\nOnly empty spaces can be deleted. ","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/spaces/delete","href":"/20230101-beta/spaces/delete-spaces","autogeneratedByOpenApi":true},{"title":"List spaces defined in the project","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nList spaces defined in the current project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /models/spaces","href":"/20230101-beta/spaces/list-spaces-defined-in-the-project","autogeneratedByOpenApi":true},{"title":"Retrieve spaces by their space-ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 100 spaces by specifying their space-ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/spaces/byids","href":"/20230101-beta/spaces/retrieve-spaces-by-their-space-ids","autogeneratedByOpenApi":true}]},{"group":"Views","pages":[{"title":"Views","sidebarTitle":"Overview","description":"Define and manage views for data modeling in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/views"},{"title":"Create or update views","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nAdd or update (upsert) views. For unchanged view specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for views that remain unchanged.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/views","href":"/20230101-beta/views/create-or-update-views","autogeneratedByOpenApi":true},{"title":"Delete views","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more views. Currently limited to 100 views at a time.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/views/delete","href":"/20230101-beta/views/delete-views","autogeneratedByOpenApi":true},{"title":"List views defined in the project","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nList of views defined in the current project. You can filter the list by specifying a space.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /models/views","href":"/20230101-beta/views/list-views-defined-in-the-project","autogeneratedByOpenApi":true},{"title":"Retrieve views by their external ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 100 views by their external ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/views/byids","href":"/20230101-beta/views/retrieve-views-by-their-external-ids","autogeneratedByOpenApi":true}]},{"group":"Containers","pages":[{"title":"Containers","sidebarTitle":"Overview","description":"Create and manage containers for data storage in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/containers"},{"title":"Create or update containers","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nAdd or update (upsert) containers. For unchanged container specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for containers that remain unchanged.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/containers","href":"/20230101-beta/containers/create-or-update-containers","autogeneratedByOpenApi":true},{"title":"Delete containers","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more containers. Currently limited to 100 containers at a time.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/containers/delete","href":"/20230101-beta/containers/delete-containers","autogeneratedByOpenApi":true},{"title":"Delete indexes from containers","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more container indexes. Currently limited to 10 indexes at a time.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/containers/indexes/delete","href":"/20230101-beta/containers/delete-indexes-from-containers","autogeneratedByOpenApi":true},{"title":"Delete constraints from containers","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more container constraints. Currently limited to 10 constraints at a time.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/containers/constraints/delete","href":"/20230101-beta/containers/delete-constraints-from-containers","autogeneratedByOpenApi":true},{"title":"Inspect containers","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/containers/inspect","href":"/20230101-beta/containers/inspect-containers","autogeneratedByOpenApi":true},{"title":"List containers defined in the project","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nList of containers defined in the current project. You can filter the list by specifying a space.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /models/containers","href":"/20230101-beta/containers/list-containers-defined-in-the-project","autogeneratedByOpenApi":true},{"title":"Retrieve containers by their external ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 100 containers by their specified external ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/containers/byids","href":"/20230101-beta/containers/retrieve-containers-by-their-external-ids","autogeneratedByOpenApi":true},{"title":"Retry failed container constraints","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nTriggers a revalidation of the given failed container constraints. This will usually entail scanning through all the data in the container, so use this sparingly. There are strict limits as to how often a given constraint can be revalidated, and how many schema entities can be in a retrying state simultaneously.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/containers/constraints/retry","href":"/20230101-beta/containers/retry-failed-container-constraints","autogeneratedByOpenApi":true},{"title":"Retry failed indexes","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nTriggers a retry of the given failed container indexes. This will usually entail scanning through all the data in the container, so use this sparingly. There are strict limits as to how often a given index can be retried, and how many schema entities can be in a retrying state simultaneously.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/containers/indexes/retry","href":"/20230101-beta/containers/retry-failed-indexes","autogeneratedByOpenApi":true},{"title":"Retry failed property constraints","description":"Revalidates failed property constraints by scanning the container. Requires `dataModelsAcl:WRITE`. See [Retry property constraints](/api-reference/concepts/20230101/containers#retry-property-constraints).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/containers/properties/retry","href":"/20230101-beta/containers/retry-failed-property-constraints","autogeneratedByOpenApi":true}]},{"group":"Instances","pages":[{"title":"Instances","sidebarTitle":"Overview","description":"Create and manage nodes and edges in the Cognite Data Fusion (CDF) knowledge graph.","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/instances"},{"title":"Aggregate data across nodes/edges","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nAggregate data for nodes or edges in a project. You can use an optional query or filter specification to limit the result.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/instances/aggregate","href":"/20230101-beta/instances/aggregate-data-across-nodesedges","autogeneratedByOpenApi":true},{"title":"Create or update nodes/edges","description":"Creates, patches, replaces, or deletes nodes and edges in one transaction. Requires `dataModelsAcl:WRITE`. See [Create, patch, and replace](/api-reference/concepts/20230101/instances#create-patch-replace).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/instances","href":"/20230101-beta/instances/create-or-update-nodesedges","autogeneratedByOpenApi":true},{"title":"Delete nodes/edges","description":"Deletes nodes and edges. Deleting a node also deletes its edges. Requires `dataModelsAcl:WRITE`. See [Delete instances](/api-reference/concepts/20230101/instances#delete-instances).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/instances/delete","href":"/20230101-beta/instances/delete-nodesedges","autogeneratedByOpenApi":true},{"title":"Filter nodes/edges","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nFilter the instances - nodes and edges - in a project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/instances/list","href":"/20230101-beta/instances/filter-nodesedges","autogeneratedByOpenApi":true},{"title":"Inspect instances","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/instances/inspect","href":"/20230101-beta/instances/inspect-instances","autogeneratedByOpenApi":true},{"title":"Query nodes/edges","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nSpecification of query endpoint. For more information, see [Query language](https://docs.cognite.com/cdf/dm/dm_concepts/dm_querying).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/instances/query","href":"/20230101-beta/instances/query-nodesedges","autogeneratedByOpenApi":true},{"title":"Retrieve nodes/edges by their external ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 1000 nodes or edges by their external ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/instances/byids","href":"/20230101-beta/instances/retrieve-nodesedges-by-their-external-ids","autogeneratedByOpenApi":true},{"title":"Search for nodes/edges","description":"\n\n> **Required capabilities:** `DataModels:READ`\n\nSearch text fields in views for nodes or edge(s). The service will return up to 1000 results. This operation orders the results by relevance, across the specified spaces.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/instances/search","href":"/20230101-beta/instances/search-for-nodesedges","autogeneratedByOpenApi":true},{"title":"Sync nodes/edges","description":"Returns changes for nodes and edges that match a filter. Requires `dataModelsAcl:READ`. See [Sync](/api-reference/concepts/20230101/instances#sync).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/instances/sync","href":"/20230101-beta/instances/sync-nodesedges","autogeneratedByOpenApi":true}]},{"group":"Statistics","pages":[{"title":"Statistics","sidebarTitle":"Statistics","description":"Retrieve data modeling statistics in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/dm-statistics"},{"title":"Retrieve project-wide statistics and limits","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nReturns statistics and limits for data modeling resources across the project. Use this endpoint to monitor your overall data modeling usage and available capacity.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /models/statistics","href":"/20230101-beta/statistics/retrieve-project-wide-statistics-and-limits","autogeneratedByOpenApi":true},{"title":"Retrieve statistics by space","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nReturns statistics for data modeling resources grouped by each space in the project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /models/statistics/spaces","href":"/20230101-beta/statistics/retrieve-statistics-by-space","autogeneratedByOpenApi":true},{"title":"Retrieve statistics by space for specific space-ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nReturns statistics for data modeling resources grouped by space for a specified list of spaces.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /models/statistics/spaces/byids","href":"/20230101-beta/statistics/retrieve-statistics-by-space-for-specific-space-ids","autogeneratedByOpenApi":true}]},{"group":"Streams","pages":[{"title":"Streams","sidebarTitle":"Overview","description":"Manage streams in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/streams"},{"title":"Create stream","description":"Creates a stream from a template. The template sets mutability, limits, and retention. Requires `streamsAcl:CREATE`. See [Stream templates](/api-reference/concepts/20230101/streams#stream-templates).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /streams","href":"/20230101-beta/streams/create-stream","autogeneratedByOpenApi":true},{"title":"Delete stream","description":"\n\n> **Required capabilities:** `streamsAcl:DELETE`\n\nDelete a stream by its identifier, along with all records stored in the stream.\n\nIf the stream does not exist, the operation succeeds without error (idempotent delete).\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /streams/delete","href":"/20230101-beta/streams/delete-stream","autogeneratedByOpenApi":true},{"title":"Delete stream (DEPRECATED)","description":"\n\n> **Required capabilities:** `streamsAcl:DELETE`\n\n**DEPRECATED**: This endpoint is no longer supported and returns HTTP 410 Gone.\nPlease use `POST /streams/delete` instead.\n","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json delete /streams/{streamId}","href":"/20230101-beta/streams/delete-stream-deprecated","autogeneratedByOpenApi":true},{"title":"List streams","description":"\n\n> **Required capabilities:** `streamsAcl:READ`\n\nList all streams available in the project.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /streams","href":"/20230101-beta/streams/list-streams","autogeneratedByOpenApi":true},{"title":"Retrieve stream","description":"\n\n> **Required capabilities:** `streamsAcl:READ`\n\nRetrieve a stream by its identifier.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /streams/{streamId}","href":"/20230101-beta/streams/retrieve-stream","autogeneratedByOpenApi":true}]},{"group":"Records","pages":[{"title":"Records","sidebarTitle":"Overview","description":"Manage records in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/records"},{"title":"Aggregate records data from a stream","description":"Aggregates records in a stream. Requires `streamRecordsAcl:READ` and `dataModelsAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/records#aggregates).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /streams/{streamId}/records/aggregate","href":"/20230101-beta/records/aggregate-records-data-from-a-stream","autogeneratedByOpenApi":true},{"title":"Delete records from a stream","description":"Deletes records from a mutable stream. Requires `streamRecordsAcl:WRITE`. See [Delete records](/api-reference/concepts/20230101/records#delete-records).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /streams/{streamId}/records/delete","href":"/20230101-beta/records/delete-records-from-a-stream","autogeneratedByOpenApi":true},{"title":"Ingest records into a stream","description":"Ingests a batch of records into a stream. Requires `streamRecordsAcl:WRITE` and `dataModelsAcl:READ`. See [Ingest records](/api-reference/concepts/20230101/records#ingest-records).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /streams/{streamId}/records","href":"/20230101-beta/records/ingest-records-into-a-stream","autogeneratedByOpenApi":true},{"title":"Retrieve records from a stream","description":"\n\n> **Required capabilities:** `streamRecordsAcl:READ` `dataModelsAcl:READ`\n\nFilter the records from the ```stream```.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /streams/{streamId}/records/filter","href":"/20230101-beta/records/retrieve-records-from-a-stream","autogeneratedByOpenApi":true},{"title":"Sync records from a stream","description":"\n\n> **Required capabilities:** `streamRecordsAcl:READ` `dataModelsAcl:READ`\n\nSubscribe to changes for records from the ```stream```, matching a supplied filter.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /streams/{streamId}/records/sync","href":"/20230101-beta/records/sync-records-from-a-stream","autogeneratedByOpenApi":true},{"title":"Upsert (create or update) records into a stream","description":"Creates or replaces records in a mutable stream. Requires `streamRecordsAcl:WRITE` and `dataModelsAcl:READ`. See [Upsert records](/api-reference/concepts/20230101/records#upsert-records).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /streams/{streamId}/records/upsert","href":"/20230101-beta/records/upsert-create-or-update-records-into-a-stream","autogeneratedByOpenApi":true}]}]},{"group":"Time series and datapoints","pages":[{"title":"Time series and datapoints","sidebarTitle":"Overview","description":"Insert, retrieve, and query time series datapoints in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["data-modeling","asset-centric"],"api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/time-series-data"},{"group":"Datapoints","pages":[{"title":"Datapoints","sidebarTitle":"Overview","description":"Insert, retrieve, and delete time series data points in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["data-modeling","asset-centric"],"api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/datapoints"},{"title":"Insert data points","description":"\n\n> **Required capabilities:** `timeSeriesAcl:WRITE`\n\nInsert data points into a time series. You can do this for multiple time series.\nIf you insert a data point with a timestamp that already exists, it will be overwritten with the new value.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/data","href":"/20230101-beta/time-series/insert-data-points","autogeneratedByOpenApi":true},{"title":"Retrieve data points","description":"Lists data points from multiple time series. If `start` is omitted, it defaults to 1 January 1970. Requires `timeSeriesAcl:READ`. See [List data points](/api-reference/concepts/20230101/time-series#list-data-points).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/data/list","href":"/20230101-beta/time-series/retrieve-data-points","autogeneratedByOpenApi":true},{"title":"Retrieve latest data point","description":"\n\n> **Required capabilities:** `timeSeriesAcl:READ`\n\nRetrieves the latest data point in one or more time series. Note that the latest data point\nin a time series is the one with the highest timestamp, which is not necessarily the one\nthat was ingested most recently.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/data/latest","href":"/20230101-beta/time-series/retrieve-latest-data-point","autogeneratedByOpenApi":true},{"title":"Delete data points","description":"\n\n> **Required capabilities:** `timeSeriesAcl:WRITE`\n\nDelete data points from time series.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/data/delete","href":"/20230101-beta/time-series/delete-data-points","autogeneratedByOpenApi":true}]},{"group":"Synthetic time series","pages":[{"title":"Synthetic time series","sidebarTitle":"Overview","description":"Create synthetic time series queries in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["data-modeling","asset-centric"],"api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/synthetic-time-series"},{"title":"Synthetic query","description":"Execute an on-the-fly synthetic query","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/synthetic/query","href":"/20230101-beta/synthetic-time-series/synthetic-query","autogeneratedByOpenApi":true}]},{"group":"Data point subscriptions","pages":[{"title":"Data point subscriptions","sidebarTitle":"Overview","description":"Subscribe to changes in time series data points in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["data-modeling","asset-centric"],"api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/data-point-subscriptions"},{"title":"Create subscriptions","description":"\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:WRITE`\n\nCreate one or more subscriptions that can be used to listen for changes in data points for a set of time series.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/subscriptions","href":"/20230101-beta/data-point-subscriptions/create-subscriptions","autogeneratedByOpenApi":true},{"title":"Delete subscriptions","description":"\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:WRITE`\n\nDelete subscription(s). This operation cannot be undone","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/subscriptions/delete","href":"/20230101-beta/data-point-subscriptions/delete-subscriptions","autogeneratedByOpenApi":true},{"title":"List subscription data","description":"Returns the next batch of data-point updates for one or more partitions. Requires `timeSeriesSubscriptionsAcl:READ`. See [Partitions](/api-reference/concepts/20230101/data-point-subscriptions#partitions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/subscriptions/data/list","href":"/20230101-beta/data-point-subscriptions/list-subscription-data","autogeneratedByOpenApi":true},{"title":"List subscription members","description":"Lists the time series in a subscription. A series added by both external ID and instance ID appears twice. Requires `timeSeriesSubscriptionsAcl:READ`. See [Data point subscriptions](/api-reference/concepts/20230101/data-point-subscriptions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /timeseries/subscriptions/members","href":"/20230101-beta/data-point-subscriptions/list-subscription-members","autogeneratedByOpenApi":true},{"title":"List subscriptions","description":"\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:READ`\n\nList all subscriptions for the tenant. Use nextCursor to paginate through the results.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /timeseries/subscriptions","href":"/20230101-beta/data-point-subscriptions/list-subscriptions","autogeneratedByOpenApi":true},{"title":"Retrieve subscriptions","description":"\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:READ`\n\nRetrieve one or more subscriptions by external ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/subscriptions/byids","href":"/20230101-beta/data-point-subscriptions/retrieve-subscriptions","autogeneratedByOpenApi":true},{"title":"Update subscriptions","description":"\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:WRITE`\n\nUpdates one or more subscriptions. Fields that are not included in the request, are not changed.\n\nIf both `instanceIds` and `timeSeriesIds` are set, they must either both be add/remove or\nboth be set operations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/subscriptions/update","href":"/20230101-beta/data-point-subscriptions/update-subscriptions","autogeneratedByOpenApi":true}]}]},{"group":"File content","pages":[{"title":"File content","sidebarTitle":"Overview","description":"Upload and download file content in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["data-modeling","asset-centric"],"api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/file-content"},{"title":"Get upload file link","description":"Returns an upload URL for an existing file. Requires `filesAcl:WRITE`, or data modeling read and write. See [Upload limits](/api-reference/concepts/20230101/file-content#upload-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /files/uploadlink","href":"/20230101-beta/files/get-upload-file-link","autogeneratedByOpenApi":true},{"title":"Download files","description":"Returns download URLs. A URL expires after 30 seconds unless you extend it. Requires `filesAcl:READ`, or data modeling read. See [Download links](/api-reference/concepts/20230101/file-content#download-links).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /files/downloadlink","href":"/20230101-beta/files/download-files","autogeneratedByOpenApi":true},{"title":"Upload multipart file","description":"Creates file metadata and returns multipart upload URLs. Requires `filesAcl:WRITE`. See [Upload limits](/api-reference/concepts/20230101/file-content#upload-limits).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /files/initmultipartupload","href":"/20230101-beta/files/upload-multipart-file","autogeneratedByOpenApi":true},{"title":"Get multipart file upload link","description":"Returns multipart upload URLs for an existing file. Requires `filesAcl:WRITE`, or data modeling read and write. See [Upload limits](/api-reference/concepts/20230101/file-content#upload-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /files/multiuploadlink","href":"/20230101-beta/files/get-multipart-file-upload-link","autogeneratedByOpenApi":true},{"title":"Complete multipart upload","description":"Assembles uploaded parts into one file. Requires `filesAcl:WRITE`, or data modeling read and write. See [Upload limits](/api-reference/concepts/20230101/file-content#upload-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /files/completemultipartupload","href":"/20230101-beta/files/complete-multipart-upload","autogeneratedByOpenApi":true},{"title":"Get icon","description":"Returns an icon for a JPEG or PNG file. Requires `filesAcl:READ`, or data modeling read. See [File icons](/api-reference/concepts/20230101/file-content#file-icons).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /files/icon","href":"/20230101-beta/files/get-icon","autogeneratedByOpenApi":true}]},{"group":"3D","pages":[{"title":"3D","sidebarTitle":"Overview","description":"Manage 3D models, revisions, files, asset mappings, and processing jobs in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/3d"},{"group":"3D models","pages":[{"title":"3D Models","sidebarTitle":"Overview","description":"Manage 3D models in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/3d-models"},{"title":"List 3D models","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nRetrieves a list of all models in a project. This operation supports pagination. You can filter out all models without a published revision.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /3d/models","href":"/20230101-beta/3d-models/list-3d-models","autogeneratedByOpenApi":true},{"title":"Create 3D models","description":"\n\n> **Required capabilities:** `threedAcl:CREATE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/models","href":"/20230101-beta/3d-models/create-3d-models","autogeneratedByOpenApi":true},{"title":"Update 3D models","description":"\n\n> **Required capabilities:** `threedAcl:UPDATE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/models/update","href":"/20230101-beta/3d-models/update-3d-models","autogeneratedByOpenApi":true},{"title":"Delete 3D models","description":"\n\n> **Required capabilities:** `threedAcl:DELETE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/models/delete","href":"/20230101-beta/3d-models/delete-3d-models","autogeneratedByOpenApi":true},{"title":"Retrieve a 3D model","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /3d/models/{modelId}","href":"/20230101-beta/3d-models/retrieve-a-3d-model","autogeneratedByOpenApi":true}]},{"group":"3D model revisions","pages":[{"title":"3D Model Revisions","sidebarTitle":"Overview","description":"Manage 3D model revisions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/3d-model-revisions"},{"title":"List 3D revisions","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nRetrieves a list of all revisions of a model. This operation supports pagination. You can also filter revisions if they are marked as published or not by using the query param published.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /3d/models/{modelId}/revisions","href":"/20230101-beta/3d-model-revisions/list-3d-revisions","autogeneratedByOpenApi":true},{"title":"Create 3D revisions","description":"Creates revisions and starts processing. Data modeling only projects use 3D jobs. Requires `threedAcl:CREATE`. See [Create revisions](/api-reference/concepts/20230101/3d-model-revisions#create-revisions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/models/{modelId}/revisions","href":"/20230101-beta/3d-model-revisions/create-3d-revisions","autogeneratedByOpenApi":true},{"title":"Update 3D revisions","description":"\n\n> **Required capabilities:** `threedAcl:UPDATE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/models/{modelId}/revisions/update","href":"/20230101-beta/3d-model-revisions/update-3d-revisions","autogeneratedByOpenApi":true},{"title":"Delete 3D revisions","description":"\n\n> **Required capabilities:** `threedAcl:DELETE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/models/{modelId}/revisions/delete","href":"/20230101-beta/3d-model-revisions/delete-3d-revisions","autogeneratedByOpenApi":true},{"title":"Retrieve a 3D revision","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /3d/models/{modelId}/revisions/{revisionId}","href":"/20230101-beta/3d-model-revisions/retrieve-a-3d-revision","autogeneratedByOpenApi":true},{"title":"List 3D revision logs","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nList log entries for the revision","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /3d/models/{modelId}/revisions/{revisionId}/logs","href":"/20230101-beta/3d-model-revisions/list-3d-revision-logs","autogeneratedByOpenApi":true},{"title":"Update 3D revision thumbnail","description":"\n\n> **Required capabilities:** `threedAcl:UPDATE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/models/{modelId}/revisions/{revisionId}/thumbnail","href":"/20230101-beta/3d-model-revisions/update-3d-revision-thumbnail","autogeneratedByOpenApi":true},{"title":"List available outputs","description":"Lists outputs for a processed revision. Requires `threedAcl:READ`. See [Outputs](/api-reference/concepts/20230101/3d-model-revisions#outputs).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /3d/models/{modelId}/revisions/{revisionId}/outputs","href":"/20230101-beta/3d-model-revisions/list-available-outputs","autogeneratedByOpenApi":true},{"title":"List 3D nodes","description":"Lists nodes in a revision. Wait until the revision status is `Done`. Requires `threedAcl:READ`. See [Nodes](/api-reference/concepts/20230101/3d-model-revisions#nodes).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /3d/models/{modelId}/revisions/{revisionId}/nodes","href":"/20230101-beta/3d-model-revisions/list-3d-nodes","autogeneratedByOpenApi":true},{"title":"Filter 3D nodes","description":"Filters nodes by name or property. Wait until the revision status is `Done`. Requires `threedAcl:READ`. See [Nodes](/api-reference/concepts/20230101/3d-model-revisions#nodes).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/models/{modelId}/revisions/{revisionId}/nodes/list","href":"/20230101-beta/3d-model-revisions/filter-3d-nodes","autogeneratedByOpenApi":true},{"title":"Get 3D nodes by ID","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nRetrieves specific nodes given by a list of IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/models/{modelId}/revisions/{revisionId}/nodes/byids","href":"/20230101-beta/3d-model-revisions/get-3d-nodes-by-id","autogeneratedByOpenApi":true},{"title":"List 3D ancestor nodes","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nRetrieves a list of ancestor nodes of a given node, including itself, in the hierarchy of the 3D model. This operation supports pagination. Will return error 400 if the revision is still being processed.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}/ancestors","href":"/20230101-beta/3d-model-revisions/list-3d-ancestor-nodes","autogeneratedByOpenApi":true}]},{"group":"3D files","pages":[{"title":"3D Files","sidebarTitle":"Overview","description":"Retrieve 3D files from Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/3d-files"},{"title":"Retrieve a single 3D file","description":"Returns a processed 3D file by ID. Requires `threedAcl:READ`. See [Output types](/api-reference/concepts/20230101/3d-files#output-types).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /3d/files/{threedFileId}","href":"/20230101-beta/3d-files/retrieve-a-single-3d-file","autogeneratedByOpenApi":true},{"title":"Retrieve a 3D directory file","description":"Returns one file inside a 3D directory output. Requires `threedAcl:READ`. See [Output types](/api-reference/concepts/20230101/3d-files#output-types).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /3d/files/{threedFileId}/{subPath}","href":"/20230101-beta/3d-files/retrieve-a-3d-directory-file","autogeneratedByOpenApi":true}]},{"group":"3D asset mapping","pages":[{"title":"3D Asset Mapping","sidebarTitle":"Overview","description":"Map 3D model nodes to assets in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/3d-asset-mapping"},{"title":"List 3D asset mappings","description":"Lists mappings for one filter. Not available in data modeling only projects. Requires `threedAcl:READ`. See [Mapping rules](/api-reference/concepts/20230101/3d-asset-mapping#mapping-rules).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /3d/models/{modelId}/revisions/{revisionId}/mappings","href":"/20230101-beta/3d-asset-mapping/list-3d-asset-mappings","autogeneratedByOpenApi":true},{"title":"Create 3D asset mappings","description":"Creates mappings between assets and 3D nodes. Requires `threedAcl:UPDATE`. See [Mapping rules](/api-reference/concepts/20230101/3d-asset-mapping#mapping-rules).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/models/{modelId}/revisions/{revisionId}/mappings","href":"/20230101-beta/3d-asset-mapping/create-3d-asset-mappings","autogeneratedByOpenApi":true},{"title":"Delete 3D asset mappings","description":"\n\n> **Required capabilities:** `threedAcl:DELETE`\n\nDelete a list of asset mappings.\n\nIn Hybrid CDF projects: The delete request items requires a `nodeId`, and either an `assetId` or an `assetInstanceId`.\n\nIn DataModelingOnly CDF projects: The delete request items requires a `nodeId` and an `assetInstanceId` (with space and externalId).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/models/{modelId}/revisions/{revisionId}/mappings/delete","href":"/20230101-beta/3d-asset-mapping/delete-3d-asset-mappings","autogeneratedByOpenApi":true},{"title":"Filter 3D asset mappings","description":"Lists mappings for one filter. Not available in data modeling only projects. Requires `threedAcl:READ`. See [Mapping rules](/api-reference/concepts/20230101/3d-asset-mapping#mapping-rules).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/models/{modelId}/revisions/{revisionId}/mappings/list","href":"/20230101-beta/3d-asset-mapping/filter-3d-asset-mappings","autogeneratedByOpenApi":true},{"title":"Filter which nodes are within a boundingbox for a revision.","description":"This endpoint is only supported in dm-only projects.\nThe nodeIds can be found as part of a CogniteCadNode in the field `cadNodeReference`.\nSimilar functionality is supported in classic through:\n- list 3D asset mappings endpoint + intersectsBoundingBox","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/nodes/list","href":"/20230101-beta/3d-asset-mapping/filter-which-nodes-are-within-a-boundingbox-for-a-revision","autogeneratedByOpenApi":true},{"title":"List mappings for one assetID across all 3D models","description":"Lists node IDs mapped to an asset across models. Requires `threedAcl:READ`. See [Mapping rules](/api-reference/concepts/20230101/3d-asset-mapping#mapping-rules).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /3d/mappings/{assetId}/modelnodes","href":"/20230101-beta/3d-asset-mapping/list-mappings-for-one-assetid-across-all-3d-models","autogeneratedByOpenApi":true},{"title":"Filter 3D assetInstanceId mappings across all 3D models","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nFilters the mappings for a specific assetInstanceId across all 3D models in the project.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/mappings/modelnodes/filter","href":"/20230101-beta/3d-asset-mapping/filter-3d-assetinstanceid-mappings-across-all-3d-models","autogeneratedByOpenApi":true}]},{"group":"3D jobs","pages":[{"title":"3D Jobs","sidebarTitle":"Overview","description":"Manage 3D processing jobs in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/3d-jobs"},{"title":"Create a job using 3D source data","description":"Creates a 3D job in a data modeling project. Requires a session nonce. See [Job sources](/api-reference/concepts/20230101/3d-jobs#job-sources).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/jobs","href":"/20230101-beta/3d-jobs/create-a-job-using-3d-source-data","autogeneratedByOpenApi":true},{"title":"List jobs","description":"\n\n> **Required capabilities:** `datamodels:READ(cdf_cdm, cdf_cdm_3d)` `datamodelinstances:READ`\n\nList jobs for your project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/jobs/list","href":"/20230101-beta/3d-jobs/list-jobs","autogeneratedByOpenApi":true},{"title":"Delete jobs","description":"\n\n> **Required capabilities:** `datamodels:READ(cdf_cdm, cdf_cdm_3d)` `datamodelinstances:WRITE`\n\nDelete jobs in your project. The job instance results won't be deleted by this operation.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/jobs/delete","href":"/20230101-beta/3d-jobs/delete-jobs","autogeneratedByOpenApi":true},{"title":"List Job Results","description":"List the results of a job","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/job/results/list","href":"/20230101-beta/3d-jobs/list-job-results","autogeneratedByOpenApi":true},{"title":"Update Job Result Rejections","description":"Job Instance Results have internal unique keys you can reject\nto allow yourself to filter away job results items you are no longer\ninterested in","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/job/result/rejections","href":"/20230101-beta/3d-jobs/update-job-result-rejections","autogeneratedByOpenApi":true},{"title":"List Job Result Rejections","description":"A list of internal keys that are to be considered rejected","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/job/result/rejections/list","href":"/20230101-beta/3d-jobs/list-job-result-rejections","autogeneratedByOpenApi":true}]},{"group":"3D contextualization","pages":[{"title":"3D contextualization","sidebarTitle":"Overview","description":"Contextualize CAD models, 360 images, and point clouds in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/3d-contextualization"},{"title":"Create CAD contextualization","description":"Links CAD nodes to `CogniteAsset` instances. One node links to one asset. See [Relationship rules](/api-reference/concepts/20230101-beta/3d-contextualization#relationship-rules).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/contextualization/cad","href":"/20230101-beta/3d-contextualization/create-cad-contextualization","autogeneratedByOpenApi":true},{"title":"Delete CAD contextualization","description":"Deletes links between specified CAD nodes and `CogniteAsset` instances.\n\nUse this endpoint to remove existing contextualization links for a specific 3D model revision when links are no longer valid or need to be replaced.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/contextualization/cad/delete","href":"/20230101-beta/3d-contextualization/delete-cad-contextualization","autogeneratedByOpenApi":true},{"title":"Create 360 image contextualization","description":"Links 360 image annotations to `CogniteAsset` instances. Use the `RC` request body. See [Relationship rules](/api-reference/concepts/20230101-beta/3d-contextualization#relationship-rules).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/contextualization/image360","href":"/20230101-beta/3d-contextualization/create-360-image-contextualization","autogeneratedByOpenApi":true},{"title":"Delete 360 image contextualization","description":"Deletes links between 360 image annotations and `CogniteAsset` instances. Use the `RC` request body. See [Relationship rules](/api-reference/concepts/20230101-beta/3d-contextualization#relationship-rules).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/contextualization/image360/delete","href":"/20230101-beta/3d-contextualization/delete-360-image-contextualization","autogeneratedByOpenApi":true},{"title":"Create point cloud volume contextualization","description":"Links point cloud volume references to `CogniteAsset` instances. See [Relationship rules](/api-reference/concepts/20230101-beta/3d-contextualization#relationship-rules).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/contextualization/pointcloud","href":"/20230101-beta/3d-contextualization/create-point-cloud-volume-contextualization","autogeneratedByOpenApi":true},{"title":"Delete point cloud volume contextualization","description":"Deletes links for specified point cloud volume references.\n\nUse this endpoint to remove existing contextualization links for a specific point cloud revision when links are no longer valid or need to be replaced.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/contextualization/pointcloud/delete","href":"/20230101-beta/3d-contextualization/delete-point-cloud-volume-contextualization","autogeneratedByOpenApi":true}]}]}]},{"group":"Cognite AI","icon":"bot","expanded":true,"pages":[{"title":"Cognite AI","sidebarTitle":"Overview","description":"Overview of Cognite AI APIs in Cognite Data Fusion (CDF), including document understanding, agents, skills, and language models.","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/cognite-ai"},{"group":"Agents","pages":[{"title":"AI agents","sidebarTitle":"Overview","description":"Define, list, chat with, and delete AI agents in Cognite Data Fusion (CDF) using the REST API.","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/ai-agents"},{"title":"List agents","description":"List agents defined in the project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /ai/agents","href":"/20230101-beta/agents/list-agents","autogeneratedByOpenApi":true},{"title":"Add or update Atlas AI agents","description":"Add or update (upsert) Atlas AI agents.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /ai/agents","href":"/20230101-beta/agents/add-or-update-atlas-ai-agents","autogeneratedByOpenApi":true},{"title":"Retrieve agents by external ID","description":"Retrieve agents by their external IDs. The response returns the agents in the same order as in the request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /ai/agents/byids","href":"/20230101-beta/agents/retrieve-agents-by-external-id","autogeneratedByOpenApi":true},{"title":"Start a chat session with an agent","description":"Starts or continues an agent chat. Pass `cursor` to continue. Confirm tools before they run. See [Chat turns](/api-reference/concepts/20230101-beta/ai-agents#chat-turns).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /ai/agents/chat","href":"/20230101-beta/agents/start-a-chat-session-with-an-agent","autogeneratedByOpenApi":true},{"title":"Delete agents","description":"Delete agents with specific external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /ai/agents/delete","href":"/20230101-beta/agents/delete-agents","autogeneratedByOpenApi":true}]},{"group":"Document AI","pages":[{"title":"Document AI","sidebarTitle":"Overview","description":"Ask questions about and summarize documents in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/document-ai"},{"title":"Ask questions about one or more documents.","description":"Answers a question from up to 100 PDFs. Each PDF can be at most 400 pages. See [Ask limits](/api-reference/concepts/20230101/document-ai#ask-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /ai/tools/documents/ask","href":"/20230101-beta/document-ai/ask-questions-about-one-or-more-documents","autogeneratedByOpenApi":true},{"title":"Summarize documents.","description":"Generates concise summaries for a list of input documents using a language model.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /ai/tools/documents/summarize","href":"/20230101-beta/document-ai/summarize-documents","autogeneratedByOpenApi":true}]},{"group":"Models","pages":[{"title":"Language models","sidebarTitle":"Overview","description":"List language models available in a Cognite Data Fusion (CDF) project. This beta and alpha operation follows the OpenAI Models API.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/ai-models"},{"title":"List models","description":"Returns a list of language models available in your CDF project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /ai/openai/models","href":"/20230101-beta/models/list-models","autogeneratedByOpenApi":true}]},{"group":"Skills","pages":[{"title":"AI skills","sidebarTitle":"Overview","description":"List, add, upload, download, and delete reusable agent skills in Cognite Data Fusion (CDF).","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/ai-skills"},{"title":"List skills","description":"Return a summary for each Atlas AI project skill (external ID, name, description, and timestamp\n fields). Skill body content is not included; use the by-IDs endpoint to load full skills.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /ai/skills","href":"/20230101-beta/skills/list-skills","autogeneratedByOpenApi":true},{"title":"Add or update Atlas AI project skills","description":"Add or update Atlas AI project skills. A project may have at most 200 skills; exceeding the limit returns **400** with `error.message` e.g. \"Max skill limit of 200 reached.\".","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /ai/skills","href":"/20230101-beta/skills/add-or-update-atlas-ai-project-skills","autogeneratedByOpenApi":true},{"title":"Retrieve skills by external ID","description":"Retrieve skills by their external IDs. The response returns the skills in the same order as in the request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /ai/skills/byids","href":"/20230101-beta/skills/retrieve-skills-by-external-id","autogeneratedByOpenApi":true},{"title":"Upload a skill from a Markdown file","description":"Upload a skill as multipart/form-data with one `file` part: a UTF-8 `.md` file in `SKILL.md` form (YAML frontmatter with `name` and `description`, then a Markdown body). A project may have at most 200 skills; exceeding the limit returns **400** with `error.message` e.g. \"Max skill limit of 200 reached.\".","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /ai/skills/upload","href":"/20230101-beta/skills/upload-a-skill-from-a-markdown-file","autogeneratedByOpenApi":true},{"title":"Download a skill as a zip archive","description":"Return a **.zip** archive containing the skill's `SKILL.md` for the given skill. The ``skill_external_id`` path segment is trimmed of leading and trailing whitespace before validation. Response is raw bytes (not JSON).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /ai/skills/{skill_external_id}/download","href":"/20230101-beta/skills/download-a-skill-as-a-zip-archive","autogeneratedByOpenApi":true},{"title":"Delete skills","description":"Delete skills with specific external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /ai/skills/delete","href":"/20230101-beta/skills/delete-skills","autogeneratedByOpenApi":true}]}]},{"group":"Compute and automation","icon":"cpu","expanded":true,"pages":[{"group":"Functions","pages":[{"title":"Functions","sidebarTitle":"Overview","description":"Deploy and run serverless functions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/functions-overview"},{"group":"Functions","pages":[{"title":"Functions","sidebarTitle":"Overview","description":"Deploy and manage serverless functions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/functions"},{"title":"Activate Functions","description":"\n\n> **Required capabilities:** `functionsAcl:WRITE`\n\nActivate Cognite Functions. This will create the necessary backend infrastructure for Cognite Functions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /functions/status","href":"/20230101-beta/functions/activate-functions","autogeneratedByOpenApi":true},{"title":"Get activation status","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nGet activation status","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /functions/status","href":"/20230101-beta/functions/get-activation-status","autogeneratedByOpenApi":true},{"title":"Create functions","description":"\n\n> **Required capabilities:** `functionsAcl:WRITE`\n\nYou can only create one function per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /functions","href":"/20230101-beta/functions/create-functions","autogeneratedByOpenApi":true},{"title":"Delete functions","description":"\n\n> **Required capabilities:** `functionsAcl:WRITE`\n\nDelete functions. You can delete a maximum of 10 functions per request. Function source files stored in the Files API must be deleted separately.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /functions/delete","href":"/20230101-beta/functions/delete-functions","autogeneratedByOpenApi":true},{"title":"Filter functions","description":"Use advanced filtering options to find functions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /functions/list","href":"/20230101-beta/functions/filter-functions","autogeneratedByOpenApi":true},{"title":"Functions limits","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nService limits for the associated project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /functions/limits","href":"/20230101-beta/functions/functions-limits","autogeneratedByOpenApi":true},{"title":"List functions","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nList functions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /functions","href":"/20230101-beta/functions/list-functions","autogeneratedByOpenApi":true},{"title":"Retrieve a function by its id","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve a function by its id. If you want to retrieve functions by names, use Retrieve functions instead.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /functions/{functionId}","href":"/20230101-beta/functions/retrieve-a-function-by-its-id","autogeneratedByOpenApi":true},{"title":"Retrieve functions","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve functions by ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /functions/byids","href":"/20230101-beta/functions/retrieve-functions","autogeneratedByOpenApi":true}]},{"group":"Function calls","pages":[{"title":"Function calls","sidebarTitle":"Overview","description":"Execute and monitor function calls in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/function-calls"},{"title":"Call a function asynchronously","description":"Calls a function. Pass input in `data`, not secrets. Requires `functionsAcl:RUN`. See [Call input](/api-reference/concepts/20230101/function-calls#call-input).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /functions/{functionId}/call","href":"/20230101-beta/function-calls/call-a-function-asynchronously","autogeneratedByOpenApi":true},{"title":"Filter function calls","description":"Use advanced filtering options to find function calls.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /functions/{functionId}/calls/list","href":"/20230101-beta/function-calls/filter-function-calls","autogeneratedByOpenApi":true},{"title":"List function calls","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nList function calls.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /functions/{functionId}/calls","href":"/20230101-beta/function-calls/list-function-calls","autogeneratedByOpenApi":true},{"title":"Retrieve calls","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve function calls by call ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /functions/{functionId}/calls/byids","href":"/20230101-beta/function-calls/retrieve-calls","autogeneratedByOpenApi":true},{"title":"Retrieve a function call by its id","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve function calls.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /functions/{functionId}/calls/{callId}","href":"/20230101-beta/function-calls/retrieve-a-function-call-by-its-id","autogeneratedByOpenApi":true},{"title":"Retrieve logs for function call","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nGet logs from a function call.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /functions/{functionId}/calls/{callId}/logs","href":"/20230101-beta/function-calls/retrieve-logs-for-function-call","autogeneratedByOpenApi":true},{"title":"Retrieve response for function call","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve response from a function call.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /functions/{functionId}/calls/{callId}/response","href":"/20230101-beta/function-calls/retrieve-response-for-function-call","autogeneratedByOpenApi":true}]},{"group":"Function schedules","pages":[{"title":"Function schedules","sidebarTitle":"Overview","description":"Schedule function executions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/function-schedules"},{"title":"Create schedules","description":"Creates schedules that call a function on a cron expression. A schedule with a `nonce` must use `functionId`. Requires `functionsAcl:WRITE`. See [Sessions](/api-reference/concepts/20230101/function-schedules#sessions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /functions/schedules","href":"/20230101-beta/function-schedules/create-schedules","autogeneratedByOpenApi":true},{"title":"Delete schedules","description":"\n\n> **Required capabilities:** `functionsAcl:WRITE`\n\nDelete function schedules.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /functions/schedules/delete","href":"/20230101-beta/function-schedules/delete-schedules","autogeneratedByOpenApi":true},{"title":"Filter function schedules","description":"Use advanced filtering options to find function schedules. At most one of `FunctionId` or `FunctionExternalId` can be specified.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /functions/schedules/list","href":"/20230101-beta/function-schedules/filter-function-schedules","autogeneratedByOpenApi":true},{"title":"List schedules","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nList function schedules in project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /functions/schedules","href":"/20230101-beta/function-schedules/list-schedules","autogeneratedByOpenApi":true},{"title":"Retrieve a function schedule by its id","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve a function schedule by its id.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /functions/schedules/{scheduleId}","href":"/20230101-beta/function-schedules/retrieve-a-function-schedule-by-its-id","autogeneratedByOpenApi":true},{"title":"Retrieve schedules","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve function schedules by schedule ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /functions/schedules/byids","href":"/20230101-beta/function-schedules/retrieve-schedules","autogeneratedByOpenApi":true},{"title":"Retrieve function input data","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve the input data to the associated function.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /functions/schedules/{scheduleId}/input_data","href":"/20230101-beta/function-schedules/retrieve-function-input-data","autogeneratedByOpenApi":true}]},{"group":"Function Apps","pages":[{"title":"List Function Apps","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nList all functions in the project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /function-apps","href":"/20230101-beta/function-apps/list-function-apps","autogeneratedByOpenApi":true},{"title":"Get Function App","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nGet details of a specific Function App.\n\nReturns metadata about the function including name, status,\nruntime, etc.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /function-apps/{functionExternalId}","href":"/20230101-beta/function-apps/get-function-app","autogeneratedByOpenApi":true},{"title":"Call Function Endpoint","description":"Calls a function app with a request envelope. The HTTP status is 200 when the function finishes. Requires `functionsAcl:WRITE`. See [Function app calls](/api-reference/concepts/20230101/functions-overview#function-app-calls).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /function-apps/{functionExternalId}/calls","href":"/20230101-beta/function-app-calls/call-function-endpoint","autogeneratedByOpenApi":true},{"title":"List Calls","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nList all calls for a function.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /function-apps/{functionExternalId}/calls","href":"/20230101-beta/function-app-calls/list-calls","autogeneratedByOpenApi":true},{"title":"Get Call Logs","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nGet logs from a function call.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /function-apps/{functionExternalId}/calls/{callId}/logs","href":"/20230101-beta/function-app-calls/get-call-logs","autogeneratedByOpenApi":true},{"title":"Get Call Response","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nGet the response from a completed function call.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /function-apps/{functionExternalId}/calls/{callId}/response","href":"/20230101-beta/function-app-calls/get-call-response","autogeneratedByOpenApi":true}]}]}]},{"group":"Connectors","icon":"plug","expanded":true,"pages":[{"group":"PostgreSQL gateway","pages":[{"title":"PostgreSQL gateway","sidebarTitle":"Overview","description":"Ingest data into Cognite Data Fusion (CDF) using the PostgreSQL protocol and SQL clients.","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/postgresql-gateway"},{"group":"Postgres gateway users","pages":[{"title":"Postgres Gateway Users","sidebarTitle":"Overview","description":"Create and manage PostgreSQL gateway users and credentials in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/postgres-gateway-users"},{"title":"Create users","description":"\n\n> **Required capabilities:** `postgresGateway:WRITE`\n\nCreate postgres users.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /postgresgateway","href":"/20230101-beta/postgres-gateway-users/create-users","autogeneratedByOpenApi":true},{"title":"Filter users","description":"List all postgres users for a given project. If more than `limit` users exist, a cursor for pagination will be returned with the response.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /postgresgateway/list","href":"/20230101-beta/postgres-gateway-users/filter-users","autogeneratedByOpenApi":true},{"title":"Retrieve users","description":"\n\n> **Required capabilities:** `postgresGateway:READ`\n\nRetrieve a list of postgres users by their usernames, optionally ignoring unknown usernames","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /postgresgateway/byids","href":"/20230101-beta/postgres-gateway-users/retrieve-users","autogeneratedByOpenApi":true},{"title":"Update users","description":"\n\n> **Required capabilities:** `[object Object]`\n\nUpdate postgres users","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /postgresgateway/update","href":"/20230101-beta/postgres-gateway-users/update-users","autogeneratedByOpenApi":true},{"title":"Delete users","description":"\n\n> **Required capabilities:** `[object Object]`\n\nDelete postgres users","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /postgresgateway/delete","href":"/20230101-beta/postgres-gateway-users/delete-users","autogeneratedByOpenApi":true},{"title":"List users","description":"\n\n> **Required capabilities:** `postgresGateway:READ`\n\nList all users in a given project. If more than `limit` users exist, a cursor for pagination will be returned with the response.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /postgresgateway","href":"/20230101-beta/postgres-gateway-users/list-users","autogeneratedByOpenApi":true}]},{"group":"Postgres gateway tables","pages":[{"title":"Postgres Gateway Tables","sidebarTitle":"Overview","description":"Create and manage PostgreSQL gateway tables that expose Cognite Data Fusion (CDF) resources.","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/postgres-gateway-tables"},{"title":"Create tables","description":"\n\n> **Required capabilities:** `postgresGateway:WRITE`\n\nCreate up to 10 tables.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /postgresgateway/tables/{username}","href":"/20230101-beta/postgres-gateway-tables/create-tables","autogeneratedByOpenApi":true},{"title":"List tables","description":"\n\n> **Required capabilities:** `postgresGateway:READ`\n\nList all tables in a given project. If more than `limit` tables exist, a cursor for pagination will be returned with the response.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /postgresgateway/tables/{username}","href":"/20230101-beta/postgres-gateway-tables/list-tables","autogeneratedByOpenApi":true},{"title":"Retrieve tables","description":"\n\n> **Required capabilities:** `postgresGateway:READ`\n\nRetrieve a list of postgres tables for a user by their table names, optionally ignoring unknown table names","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /postgresgateway/tables/{username}/byids","href":"/20230101-beta/postgres-gateway-tables/retrieve-tables","autogeneratedByOpenApi":true},{"title":"Delete tables","description":"\n\n> **Required capabilities:** `[object Object]`\n\nDelete up to 10 tables","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /postgresgateway/tables/{username}/delete","href":"/20230101-beta/postgres-gateway-tables/delete-tables","autogeneratedByOpenApi":true}]}]},{"group":"SAP writeback","pages":[{"title":"SAP writeback","sidebarTitle":"Overview","description":"Write data from Cognite Data Fusion (CDF) back to SAP systems.","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/sap-writeback"},{"group":"SAP instances","pages":[{"title":"SAP Instances","sidebarTitle":"Overview","description":"Manage SAP instance connections in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/sap-instances"},{"title":"Create SAP Instances","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nCreate up to 100 SAP instances.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /writeback/sap/instances","href":"/20230101-beta/sap-instances/create-sap-instances","autogeneratedByOpenApi":true},{"title":"Retrieve SAP Instances","description":"\n\n> **Required capabilities:** `sapWritebackAcl:READ`\n\nRetrieve a list of up to 100 SAP instances by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /writeback/sap/instances/byids","href":"/20230101-beta/sap-instances/retrieve-sap-instances","autogeneratedByOpenApi":true},{"title":"Delete SAP Instances","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nDelete a list of SAP instance configurations by their external ID. This operation will fail if any destination in the request is associated with an SAP endpoint configuration, unless the `force` query parameter is set to `true`.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /writeback/sap/instances/delete","href":"/20230101-beta/sap-instances/delete-sap-instances","autogeneratedByOpenApi":true}]},{"group":"SAP endpoints","pages":[{"title":"SAP Endpoints","sidebarTitle":"Overview","description":"Manage SAP writeback endpoints in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/sap-endpoints"},{"title":"Create SAP Endpoints","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nCreate up to 100 SAP endpoints.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /writeback/sap/endpoints","href":"/20230101-beta/sap-endpoints/create-sap-endpoints","autogeneratedByOpenApi":true},{"title":"Retrieve SAP Endpoints","description":"\n\n> **Required capabilities:** `sapWritebackAcl:READ`\n\nRetrieve a list of up to 100 SAP endpoints by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /writeback/sap/endpoints/byids","href":"/20230101-beta/sap-endpoints/retrieve-sap-endpoints","autogeneratedByOpenApi":true},{"title":"Delete SAP Endpoints","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nDelete a list of SAP endpoint configurations by their external ID. This operation will fail if any endpoint in the request is associated to a SAP instance configuration.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /writeback/sap/endpoints/delete","href":"/20230101-beta/sap-endpoints/delete-sap-endpoints","autogeneratedByOpenApi":true},{"title":"Verify SAP Endpoint","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nVerify the connectivity between the writeback API, and the SAP endpoint destination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /writeback/sap/endpoints/verify","href":"/20230101-beta/sap-endpoints/verify-sap-endpoint","autogeneratedByOpenApi":true}]},{"group":"Schema mappings","pages":[{"title":"Schema Mappings","sidebarTitle":"Schema Mappings","description":"Map CDF data to SAP schemas for writeback in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/sap-schema-mappings"},{"title":"Create Mappings","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nCreate a maximum of 100 mappings.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /writeback/sap/mappings","href":"/20230101-beta/schema-mappings/create-mappings","autogeneratedByOpenApi":true},{"title":"Retrieve Mappings","description":"\n\n> **Required capabilities:** `sapWritebackAcl:READ`\n\nRetrieve a list of up to 100 mappings by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /writeback/sap/mappings/byids","href":"/20230101-beta/schema-mappings/retrieve-mappings","autogeneratedByOpenApi":true},{"title":"Delete Mappings","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nDelete a list of mappings by their external ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /writeback/sap/mappings/delete","href":"/20230101-beta/schema-mappings/delete-mappings","autogeneratedByOpenApi":true}]},{"group":"Writeback requests","pages":[{"title":"Writeback Requests","sidebarTitle":"Overview","description":"Send data from CDF back to SAP systems.","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/writeback-requests"},{"title":"Create Writeback Requests","description":"\n\n> **Required capabilities:** `sapWritebackRequestsAcl:WRITE`\n\nCreate a writeback request","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /writeback/sap/requests","href":"/20230101-beta/writeback-requests/create-writeback-requests","autogeneratedByOpenApi":true},{"title":"Retrieve Writeback Requests","description":"\n\n> **Required capabilities:** `sapWritebackRequestsAcl:WRITE`\n\nRetrieve a list of up to 100 writeback requests by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /writeback/sap/requests/byids","href":"/20230101-beta/writeback-requests/retrieve-writeback-requests","autogeneratedByOpenApi":true}]}]}]},{"group":"Contextualization","icon":"puzzle","expanded":true,"pages":[{"title":"Contextualization","sidebarTitle":"Overview","description":"Match entities, extract features from engineering diagrams, and analyze images in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/contextualization"},{"group":"Entity matching","pages":[{"title":"Entity matching","sidebarTitle":"Overview","description":"Match entities across data sources in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/entity-matching"},{"title":"Create entity matcher model","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE`\n\nTrain a model that predicts matches between entities (for example, time series names to asset names). This is also known as fuzzy joining. If there are no trueMatches (labeled data), you train a static (unsupervised) model, otherwise a machine learned (supervised) model is trained.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/entitymatching","href":"/20230101-beta/entity-matching/create-entity-matcher-model","autogeneratedByOpenApi":true},{"title":"Delete entity matcher model","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE`\n\nDeletes an entity matching model. Currently, this is a soft delete, and only removes the entry from listing.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/entitymatching/delete","href":"/20230101-beta/entity-matching/delete-entity-matcher-model","autogeneratedByOpenApi":true},{"title":"Filter models","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nUse filtering options to find entity matcher models.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/entitymatching/list","href":"/20230101-beta/entity-matching/filter-models","autogeneratedByOpenApi":true},{"title":"List entity matching models","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nList all available entity matching models, with pagination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /context/entitymatching","href":"/20230101-beta/entity-matching/list-entity-matching-models","autogeneratedByOpenApi":true},{"title":"Retrieve an entity matching model by the ID of the model","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nShows the status of the model. If the status is completed, shows the parameters used to train the model.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /context/entitymatching/{id}","href":"/20230101-beta/entity-matching/retrieve-an-entity-matching-model-by-the-id-of-the-model","autogeneratedByOpenApi":true},{"title":"Predict matches","description":"Predicts matches with a trained model. Requires `entitymatchingAcl:WRITE`. See [Predict and refit](/api-reference/concepts/20230101/entity-matching#predict-and-refit).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/entitymatching/predict","href":"/20230101-beta/entity-matching/predict-matches","autogeneratedByOpenApi":true},{"title":"Re-fit entity matcher model","description":"Trains a new model from confirmed matches. The original model stays unchanged. Requires `entitymatchingAcl:READ` and `entitymatchingAcl:WRITE`. See [Predict and refit](/api-reference/concepts/20230101/entity-matching#predict-and-refit).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/entitymatching/refit","href":"/20230101-beta/entity-matching/re-fit-entity-matcher-model","autogeneratedByOpenApi":true},{"title":"Retrieve entity matcher predict results","description":"\n\n> **Required capabilities:** `assetsAcl:READ` `entitymatchingAcl:WRITE`\n\nGet the results from a predict job. Note: 'assetsAcl:READ' capability is required, unless you specify a valid `X-Job-Token` in the request header. The `X-Job-Token` is provided in the response header of the initial call to `/context/entitymatching/predict`","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /context/entitymatching/jobs/{jobId}","href":"/20230101-beta/entity-matching/retrieve-entity-matcher-predict-results","autogeneratedByOpenApi":true},{"title":"Retrieve entity matching models","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nRetrieve entity matching models by IDs or external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/entitymatching/byids","href":"/20230101-beta/entity-matching/retrieve-entity-matching-models","autogeneratedByOpenApi":true},{"title":"Update entity matching models","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE`\n\nUpdate entity matching models by IDs or external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/entitymatching/update","href":"/20230101-beta/entity-matching/update-entity-matching-models","autogeneratedByOpenApi":true},{"group":"Pipelines","pages":[{"title":"List pipelines","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ` `assetsAcl:READ`\n\nList entity matching pipelines.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /context/entitymatching/pipelines","href":"/20230101-beta/entity-matching-pipelines/list-pipelines","autogeneratedByOpenApi":true},{"title":"Get pipeline","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ` `assetsAcl:READ`\n\nGet entity matching pipeline.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /context/entitymatching/pipelines/{pipelineId}","href":"/20230101-beta/entity-matching-pipelines/get-pipeline","autogeneratedByOpenApi":true},{"title":"List pipeline runs","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ` `assetsAcl:READ`\n\nList runs for an entity matching pipeline.\n\nThis endpoint returns run summaries. If you want to get the complete results for a single run, use\nthe [run results get](#tag/Entity-matching-pipelines/operation/entityMatchingPipelineRunGet) endpoint.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /context/entitymatching/pipelines/{pipelineId}/runs","href":"/20230101-beta/entity-matching-pipelines/list-pipeline-runs","autogeneratedByOpenApi":true},{"title":"Get latest pipeline run results","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ` `assetsAcl:READ`\n\nGet the results of the latest run of an entity matching pipeline.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /context/entitymatching/pipelines/{pipelineId}/runs/latest","href":"/20230101-beta/entity-matching-pipelines/get-latest-pipeline-run-results","autogeneratedByOpenApi":true},{"title":"Get pipeline run results","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ` `assetsAcl:READ`\n\nGet the results of a specific run of an entity matching pipeline.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /context/entitymatching/pipelines/{pipelineId}/runs/{runId}","href":"/20230101-beta/entity-matching-pipelines/get-pipeline-run-results","autogeneratedByOpenApi":true},{"title":"Create pipelines","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE` `assetsAcl:READ` `timeSeriesAcl:READ` `eventsAcl:READ` `sequencesAcl:READ` `filesAcl:READ`\n\nCreate entity matching pipelines.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/entitymatching/pipelines","href":"/20230101-beta/entity-matching-pipelines/create-pipelines","autogeneratedByOpenApi":true},{"title":"Retrieve multiple pipelines","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ` `assetsAcl:READ`\n\nRetrieve multiple entity matching pipelines.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/entitymatching/pipelines/byids","href":"/20230101-beta/entity-matching-pipelines/retrieve-multiple-pipelines","autogeneratedByOpenApi":true},{"title":"Delete pipelines","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE` `assetsAcl:READ`\n\nDelete entity matching pipelines.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/entitymatching/pipelines/delete","href":"/20230101-beta/entity-matching-pipelines/delete-pipelines","autogeneratedByOpenApi":true},{"title":"Update pipelines","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE` `assetsAcl:READ` `timeSeriesAcl:READ` `eventsAcl:READ` `sequencesAcl:READ` `filesAcl:READ`\n\nUpdate entity matching pipelines.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/entitymatching/pipelines/update","href":"/20230101-beta/entity-matching-pipelines/update-pipelines","autogeneratedByOpenApi":true},{"title":"Run pipeline","description":"Runs a pipeline and returns confirmed, rule, or model matches. Requires `entitymatchingAcl:READ` and `assetsAcl:READ`. See [Pipeline runs](/api-reference/concepts/20230101/entity-matching#pipeline-runs).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/entitymatching/pipelines/{pipelineId}/runs","href":"/20230101-beta/entity-matching-pipelines/run-pipeline","autogeneratedByOpenApi":true}]}]},{"group":"Engineering diagrams","pages":[{"title":"Engineering diagrams","sidebarTitle":"Overview","description":"Detect and convert engineering diagrams in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/engineering-diagrams"},{"title":"Convert a diagram to image format","description":"Converts a diagram to PNG or SVG. Only SVG embeds annotations. Requires `assetsAcl:READ` and `filesAcl:READ`. See [Detect and convert](/api-reference/concepts/20230101/engineering-diagrams#detect-and-convert).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/diagram/convert","href":"/20230101-beta/engineering-diagrams/convert-a-diagram-to-image-format","autogeneratedByOpenApi":true},{"title":"Detect annotations in engineering diagrams","description":"Detects annotations in a PDF, JPEG, PNG, or TIFF diagram. Requires `assetsAcl:READ` and `filesAcl:READ`. See [Detect and convert](/api-reference/concepts/20230101/engineering-diagrams#detect-and-convert).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/diagram/detect","href":"/20230101-beta/engineering-diagrams/detect-annotations-in-engineering-diagrams","autogeneratedByOpenApi":true},{"title":"Retrieve OCR text","description":"\n\n> **Required capabilities:** `filesAcl:READ`\n\nProvides ocr annotations for a given file. Currently only files that have been parsed with diagram/detect\nwill yield non-empty results.\n\nIn beta. Available only when the `cdf-version` header with the `beta` suffix value is provided.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/diagram/ocr","href":"/20230101-beta/engineering-diagrams/retrieve-ocr-text","autogeneratedByOpenApi":true},{"title":"Get the results for converting an engineering diagram to an image","description":"\n\n> **Required capabilities:** `assetsAcl:READ` `filesAcl:READ`\n\nGet the results for converting an engineering diagram to SVG and PNG formats.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /context/diagram/convert/{jobId}","href":"/20230101-beta/engineering-diagrams/get-the-results-for-converting-an-engineering-diagram-to-an-image","autogeneratedByOpenApi":true},{"title":"Retrieve engineering diagram detect results","description":"\n\n> **Required capabilities:** `assetsAcl:READ` `filesAcl:READ`\n\nGet the results from an engineering diagram detect job. Providing the `X-Job-Token` header returned by the\n`/context/diagram/detect` endpoint is required unless the caller has read access to all assets. Results are available for 30 days following the completion of the detect job.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /context/diagram/detect/{jobId}","href":"/20230101-beta/engineering-diagrams/retrieve-engineering-diagram-detect-results","autogeneratedByOpenApi":true}]},{"group":"Diagram parsing","pages":[{"group":"Parsing","pages":[{"title":"Run parsing with tag detection for files","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE` `dataModelInstancesAcl:WRITE`\n\nA parsing job will be started on the files to detect their entities and connections and map assets.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /api/v1/projects/{project}/diagram-parsing/parsing/full","href":"/20230101-beta/parsing/run-parsing-with-tag-detection-for-files","autogeneratedByOpenApi":true},{"title":"Run an instant parsing job for a file","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nStart an instant parsing job on a file to detect diagram symbols based on the specified library. Parsed outputs do not persist.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/parsing/instant","href":"/20230101-beta/parsing/run-an-instant-parsing-job-for-a-file","autogeneratedByOpenApi":true},{"title":"Run parsing for files","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nStart a parsing job on files to detect their symbols and connections.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/parsing/symbol-detection","href":"/20230101-beta/parsing/run-parsing-for-files","autogeneratedByOpenApi":true}]},{"group":"Libraries","pages":[{"title":"List libraries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nList all libraries defined in the current project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /diagram-parsing/libraries","href":"/20230101-beta/libraries/list-libraries","autogeneratedByOpenApi":true},{"title":"Get a library with symbols","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nReturns a single library with all its symbols and geometries.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /diagram-parsing/libraries/{libraryId}","href":"/20230101-beta/libraries/get-a-library-with-symbols","autogeneratedByOpenApi":true},{"title":"Create libraries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nCreate libraries.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/libraries","href":"/20230101-beta/libraries/create-libraries","autogeneratedByOpenApi":true},{"title":"Retrieve libraries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nRetrieve up to 100 libraries by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/libraries/byids","href":"/20230101-beta/libraries/retrieve-libraries","autogeneratedByOpenApi":true},{"title":"Delete libraries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nDelete up to 100 libraries by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/libraries/delete","href":"/20230101-beta/libraries/delete-libraries","autogeneratedByOpenApi":true},{"title":"Update libraries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nUpdate the properties of a set of libraries.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/libraries/update","href":"/20230101-beta/libraries/update-libraries","autogeneratedByOpenApi":true},{"title":"Copy library","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nCreates a new library by copying an existing library, including all its symbols and geometries.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/libraries/{libraryId}/copy","href":"/20230101-beta/libraries/copy-library","autogeneratedByOpenApi":true}]},{"group":"Symbols","pages":[{"title":"List symbols","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nList all symbols defined in the current project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /diagram-parsing/symbols","href":"/20230101-beta/symbols/list-symbols","autogeneratedByOpenApi":true},{"title":"Create symbols","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nCreate symbols","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/symbols","href":"/20230101-beta/symbols/create-symbols","autogeneratedByOpenApi":true},{"title":"Retrieve symbols","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nRetrieve up to 100 symbols by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/symbols/byids","href":"/20230101-beta/symbols/retrieve-symbols","autogeneratedByOpenApi":true},{"title":"Delete symbols","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nDelete up to 100 symbols by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/symbols/delete","href":"/20230101-beta/symbols/delete-symbols","autogeneratedByOpenApi":true},{"title":"Update symbols","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nUpdate the properties of a set of symbols","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/symbols/update","href":"/20230101-beta/symbols/update-symbols","autogeneratedByOpenApi":true}]},{"group":"Geometries","pages":[{"title":"List geometries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nList all geometries (also called variants in documentation) defined in the current project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /diagram-parsing/geometries","href":"/20230101-beta/geometries/list-geometries","autogeneratedByOpenApi":true},{"title":"Create geometries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nCreate geometries.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/geometries","href":"/20230101-beta/geometries/create-geometries","autogeneratedByOpenApi":true},{"title":"Retrieve geometries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nRetrieve up to 100 geometries by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/geometries/byids","href":"/20230101-beta/geometries/retrieve-geometries","autogeneratedByOpenApi":true},{"title":"Delete geometries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nDelete up to 100 geometries by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/geometries/delete","href":"/20230101-beta/geometries/delete-geometries","autogeneratedByOpenApi":true},{"title":"Update geometries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nUpdate the properties of a set of geometries","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/geometries/update","href":"/20230101-beta/geometries/update-geometries","autogeneratedByOpenApi":true}]},{"group":"Diagrams","pages":[{"title":"List diagrams","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nList all diagrams defined in the current project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /diagram-parsing/diagrams","href":"/20230101-beta/diagrams/list-diagrams","autogeneratedByOpenApi":true},{"title":"Get an extended diagram by external id","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nGet diagram information and its parsed outputs using the diagram ID. The parsed output includes all diagram entities and their connections extracted during the file parsing process.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /diagram-parsing/diagrams/{diagramId}","href":"/20230101-beta/diagrams/get-an-extended-diagram-by-external-id","autogeneratedByOpenApi":true},{"title":"Get an extended diagram with paths by external id","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nGet a single diagram containing entities, connections, and SVG data by using its external id","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /diagram-parsing/diagrams/{diagramId}/with-paths","href":"/20230101-beta/diagrams/get-an-extended-diagram-with-paths-by-external-id","autogeneratedByOpenApi":true},{"title":"Get an extended diagram by file reference","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nGet diagram information and its parsed outputs using its related fileId and pageNumber. The parsed output includes all diagram entities and their connections extracted during the file parsing process.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /diagram-parsing/diagrams/{fileSpace}/{fileExternalId}/{pageNumber}","href":"/20230101-beta/diagrams/get-an-extended-diagram-by-file-reference","autogeneratedByOpenApi":true},{"title":"Retrieve diagrams","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nRetrieve up to 100 diagrams by specifying their external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/diagrams/byids","href":"/20230101-beta/diagrams/retrieve-diagrams","autogeneratedByOpenApi":true},{"title":"Filter diagrams","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nFilter and retrieve up to 100 diagrams by specifying their properties.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/diagrams/list","href":"/20230101-beta/diagrams/filter-diagrams","autogeneratedByOpenApi":true}]},{"group":"Entities","pages":[{"title":"List diagram entities","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nList all diagram entities defined for the diagram specified by the diagramId parameter.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /diagram-parsing/entities","href":"/20230101-beta/entities/list-diagram-entities","autogeneratedByOpenApi":true},{"title":"Create diagram entities","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nCreate diagram entities.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/entities","href":"/20230101-beta/entities/create-diagram-entities","autogeneratedByOpenApi":true},{"title":"Retrieve diagram entities","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nRetrieve up to 100 diagram entities by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/entities/byids","href":"/20230101-beta/entities/retrieve-diagram-entities","autogeneratedByOpenApi":true},{"title":"Delete diagram entities","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nDelete up to 100 diagram entities by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/entities/delete","href":"/20230101-beta/entities/delete-diagram-entities","autogeneratedByOpenApi":true},{"title":"Update diagram entities","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nUpdate the properties of a set of diagram entities","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/entities/update","href":"/20230101-beta/entities/update-diagram-entities","autogeneratedByOpenApi":true}]},{"group":"Connections","pages":[{"title":"List connections","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nList all connections defined in the current project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /diagram-parsing/connections","href":"/20230101-beta/connections/list-connections","autogeneratedByOpenApi":true},{"title":"Create connections","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nCreate connections between symbols in parsed diagrams.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/connections","href":"/20230101-beta/connections/create-connections","autogeneratedByOpenApi":true},{"title":"Retrieve connections","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nRetrieve up to 100 connections by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/connections/byids","href":"/20230101-beta/connections/retrieve-connections","autogeneratedByOpenApi":true},{"title":"Delete connections","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nDelete up to 100 connections by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /diagram-parsing/connections/delete","href":"/20230101-beta/connections/delete-connections","autogeneratedByOpenApi":true}]},{"group":"SVG Data","pages":[{"title":"Get SVG data by diagramId","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ` `dataModelInstancesAcl:READ`\n\nGet the SVG data of a file by externalId of a diagram.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /diagram-parsing/svg-data/diagram/{diagramId}","href":"/20230101-beta/svg-data/get-svg-data-by-diagramid","autogeneratedByOpenApi":true},{"title":"Get SVG data by file reference","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ` `dataModelInstancesAcl:READ`\n\nGet the SVG data of a file by file instanceId and pageNumber.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /diagram-parsing/svg-data/file/{fileSpace}/{fileExternalId}/{pageNumber}","href":"/20230101-beta/svg-data/get-svg-data-by-file-reference","autogeneratedByOpenApi":true}]}]},{"group":"Vision","pages":[{"title":"Vision","sidebarTitle":"Overview","description":"Extract features from images in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/vision"},{"title":"Extract features from images","description":"Starts an image feature extraction job. A project can run 20 jobs at once. Requires `filesAcl:READ`. See [Extract](/api-reference/concepts/20230101/vision#extract).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/vision/extract","href":"/20230101-beta/vision/extract-features-from-images","autogeneratedByOpenApi":true},{"title":"Retrieve results from a feature extraction job on images","description":"Returns completed extract batches while the job is still running. Requires `filesAcl:READ`. See [Extract](/api-reference/concepts/20230101/vision#extract).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /context/vision/extract/{jobId}","href":"/20230101-beta/vision/retrieve-results-from-a-feature-extraction-job-on-images","autogeneratedByOpenApi":true},{"title":"Segment objects in an image","description":"Starts an image segmentation job from points or a bounding box. Requires `filesAcl:READ`. See [Segment](/api-reference/concepts/20230101/vision#segment).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /context/vision/segment","href":"/20230101-beta/vision/segment-objects-in-an-image","autogeneratedByOpenApi":true},{"title":"Retrieve results from a segmentation job on an image","description":"\n\n> **Required capabilities:** `filesAcl:READ`\n\nRetrieve results from a segmentation job on an image.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /context/vision/segment/{jobId}","href":"/20230101-beta/vision/retrieve-results-from-a-segmentation-job-on-an-image","autogeneratedByOpenApi":true}]}]},{"group":"Data lifecycle","icon":"git-branch","expanded":true,"pages":[{"group":"Data ingestion","pages":[{"title":"Data ingestion","sidebarTitle":"Overview","description":"Ingest data into Cognite Data Fusion (CDF) using Raw, extraction pipelines, extractors, and hosted extractors.","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/data-ingestion"},{"group":"Raw","pages":[{"title":"Raw","sidebarTitle":"Overview","description":"Manage raw NoSQL databases in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/raw"},{"title":"Create databases","description":"\n\n> **Required capabilities:** `rawAcl:WRITE`\n\nCreate databases in a project. It is possible to post a maximum of 1000 databases per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /raw/dbs","href":"/20230101-beta/raw/create-databases","autogeneratedByOpenApi":true},{"title":"Delete databases","description":"\n\n> **Required capabilities:** `rawAcl:WRITE`\n\nIt deletes a database, but fails if the database is not empty and recursive is set to false (default).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /raw/dbs/delete","href":"/20230101-beta/raw/delete-databases","autogeneratedByOpenApi":true},{"title":"Create tables in a database","description":"\n\n> **Required capabilities:** `rawAcl:WRITE`\n\nCreate tables in a database. It is possible to post a maximum of 1000 tables per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /raw/dbs/{dbName}/tables","href":"/20230101-beta/raw/create-tables-in-a-database","autogeneratedByOpenApi":true},{"title":"Delete tables in a database","description":"\n\n> **Required capabilities:** `rawAcl:WRITE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /raw/dbs/{dbName}/tables/delete","href":"/20230101-beta/raw/delete-tables-in-a-database","autogeneratedByOpenApi":true},{"title":"Insert rows into a table","description":"Inserts or replaces up to 10,000 rows. A failed request can leave a partial write. Requires `rawAcl:WRITE`. See [Insert rows](/api-reference/concepts/20230101/raw#insert-rows).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /raw/dbs/{dbName}/tables/{tableName}/rows","href":"/20230101-beta/raw/insert-rows-into-a-table","autogeneratedByOpenApi":true},{"title":"Delete rows in a table","description":"\n\n> **Required capabilities:** `rawAcl:WRITE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /raw/dbs/{dbName}/tables/{tableName}/rows/delete","href":"/20230101-beta/raw/delete-rows-in-a-table","autogeneratedByOpenApi":true},{"title":"List databases","description":"\n\n> **Required capabilities:** `rawAcl:LIST`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /raw/dbs","href":"/20230101-beta/raw/list-databases","autogeneratedByOpenApi":true},{"title":"List tables in a database","description":"\n\n> **Required capabilities:** `rawAcl:LIST`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /raw/dbs/{dbName}/tables","href":"/20230101-beta/raw/list-tables-in-a-database","autogeneratedByOpenApi":true},{"title":"Retrieve cursors for parallel reads","description":"Returns cursors for parallel row reads. Requires `rawAcl:READ`. See [Cursors](/api-reference/concepts/20230101/raw#cursors).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /raw/dbs/{dbName}/tables/{tableName}/cursors","href":"/20230101-beta/raw/retrieve-cursors-for-parallel-reads","autogeneratedByOpenApi":true},{"title":"Retrieve rows from a table","description":"\n\n> **Required capabilities:** `rawAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /raw/dbs/{dbName}/tables/{tableName}/rows","href":"/20230101-beta/raw/retrieve-rows-from-a-table","autogeneratedByOpenApi":true},{"title":"Retrieve row by key","description":"\n\n> **Required capabilities:** `rawAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /raw/dbs/{dbName}/tables/{tableName}/rows/{rowKey}","href":"/20230101-beta/raw/retrieve-row-by-key","autogeneratedByOpenApi":true}]},{"group":"Extraction pipelines","pages":[{"title":"Extraction Pipelines","sidebarTitle":"Overview","description":"Manage extraction pipelines in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/extraction-pipelines"},{"title":"Create extraction pipelines","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:WRITE` `datasetsAcl:READ`\n\nCreates multiple new extraction pipelines. A maximum of 1000 extraction pipelines can be created per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /extpipes","href":"/20230101-beta/extraction-pipelines/create-extraction-pipelines","autogeneratedByOpenApi":true},{"title":"Delete extraction pipelines","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:WRITE` `datasetsAcl:READ`\n\nDelete extraction pipelines for given list of ids and externalIds. When the extraction pipeline is deleted, all extraction pipeline runs related to the extraction pipeline are automatically deleted.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /extpipes/delete","href":"/20230101-beta/extraction-pipelines/delete-extraction-pipelines","autogeneratedByOpenApi":true},{"title":"Filter extraction pipelines","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:READ`\n\nUse advanced filtering options to find extraction pipelines.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /extpipes/list","href":"/20230101-beta/extraction-pipelines/filter-extraction-pipelines","autogeneratedByOpenApi":true},{"title":"Retrieve an extraction pipeline by its ID.","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:READ`\n\nRetrieve an extraction pipeline by its ID. If you want to retrieve extraction pipelines by externalIds, use Retrieve extraction pipelines instead.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /extpipes/{id}","href":"/20230101-beta/extraction-pipelines/retrieve-an-extraction-pipeline-by-its-id","autogeneratedByOpenApi":true},{"title":"Retrieve extraction pipelines","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:READ`\n\nRetrieves information about multiple extraction pipelines in the same project. All ids and externalIds must be unique.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /extpipes/byids","href":"/20230101-beta/extraction-pipelines/retrieve-extraction-pipelines","autogeneratedByOpenApi":true},{"title":"Update extraction pipelines","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:WRITE` `datasetsAcl:READ`\n\nUpdate information for a list of extraction pipelines. Fields that are not included in the request, are not changed.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /extpipes/update","href":"/20230101-beta/extraction-pipelines/update-extraction-pipelines","autogeneratedByOpenApi":true}]},{"group":"Extraction pipelines runs","pages":[{"title":"Extraction Pipelines Runs","sidebarTitle":"Overview","description":"Track extraction pipeline run statuses in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/extraction-pipelines-runs"},{"title":"Create extraction pipeline runs","description":"Creates one extraction pipeline run. Requires `extractionrunsAcl:WRITE` and `datasetsAcl:READ`. See [Run statuses](/api-reference/concepts/20230101/extraction-pipelines-runs#run-statuses).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /extpipes/runs","href":"/20230101-beta/extraction-pipelines-runs/create-extraction-pipeline-runs","autogeneratedByOpenApi":true},{"title":"Filter extraction pipeline runs","description":"\n\n> **Required capabilities:** `extractionrunsAcl:READ`\n\nUse advanced filtering options to find extraction pipeline runs. Sorted by createdTime value with descendant order.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /extpipes/runs/list","href":"/20230101-beta/extraction-pipelines-runs/filter-extraction-pipeline-runs","autogeneratedByOpenApi":true}]},{"group":"Extraction pipelines config","pages":[{"title":"Extraction Pipelines Config","sidebarTitle":"Overview","description":"Manage extraction pipeline configurations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/extraction-pipelines-config"},{"title":"Create extraction configuration revision","description":"\n\n> **Required capabilities:** `extractionconfigsAcl:WRITE`\n\nCreates a configuration revision for the given extraction pipeline.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /extpipes/config","href":"/20230101-beta/extraction-pipelines-config/create-extraction-configuration-revision","autogeneratedByOpenApi":true},{"title":"Get a single configuration revision","description":"\n\n> **Required capabilities:** `extractionconfigsAcl:READ`\n\nRetrieves a single configuration revision. By default, the latest revision is retrieved.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /extpipes/config","href":"/20230101-beta/extraction-pipelines-config/get-a-single-configuration-revision","autogeneratedByOpenApi":true},{"title":"List configuration revisions","description":"\n\n> **Required capabilities:** `extractionconfigsAcl:READ`\n\nLists configuration revisions for the given extraction pipeline.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /extpipes/config/revisions","href":"/20230101-beta/extraction-pipelines-config/list-configuration-revisions","autogeneratedByOpenApi":true},{"title":"Revert configuration revision","description":"\n\n> **Required capabilities:** `extractionconfigsAcl:WRITE`\n\nReverts the latest configuration revision to an older revision. Equivalent to creating a new revision identical to the old revision.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /extpipes/config/revert","href":"/20230101-beta/extraction-pipelines-config/revert-configuration-revision","autogeneratedByOpenApi":true}]},{"group":"Extractors","pages":[{"title":"Extractors","sidebarTitle":"Overview","description":"Discover available extractors in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/extractors"},{"title":"List Extractors","description":"List all available extractors.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /extractors","href":"/20230101-beta/extractors/list-extractors","autogeneratedByOpenApi":true},{"title":"Retrieve Extractors","description":"Retrieve extractors by external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /extractors/byids","href":"/20230101-beta/extractors/retrieve-extractors","autogeneratedByOpenApi":true},{"title":"List releases","description":"List releases for all extractors, or optionally for a single extractor. Results are sorted in descending version order.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /extractors/releases","href":"/20230101-beta/extractors/list-releases","autogeneratedByOpenApi":true},{"title":"Retrieve Releases","description":"Retrieve releases by extractor external ID and version, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /extractors/releases/byids","href":"/20230101-beta/extractors/retrieve-releases","autogeneratedByOpenApi":true},{"title":"List Source Systems","description":"List source systems. Source systems represent sources that extractors may read from. They are tied to extractors through Solutions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /extractors/sources","href":"/20230101-beta/extractors/list-source-systems","autogeneratedByOpenApi":true},{"title":"Retrieve Source Systems","description":"Retrieve source systems. Source systems represent sources that extractors may read from. They are tied to extractors through Solutions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /extractors/sources/byids","href":"/20230101-beta/extractors/retrieve-source-systems","autogeneratedByOpenApi":true},{"title":"List Solutions","description":"List solutions. Solutions connect sources to extractors, documenting how a specific extractor might be used to connect to a source system.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /extractors/solutions","href":"/20230101-beta/extractors/list-solutions","autogeneratedByOpenApi":true},{"title":"Retrieve Solutions","description":"Retrieve solutions by external ID. Solutions connect sources to extractors, documenting how a specific extractor might be used to connect to a source system.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /extractors/solutions/byids","href":"/20230101-beta/extractors/retrieve-solutions","autogeneratedByOpenApi":true},{"title":"Get Config Schema","description":"Retrieve the configuration schema for the specified extractor and release version. The configuration schema is a [JSON Schema](https://json-schema.org/) file.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /extractors/schemas/{extractor}/{version}","href":"/20230101-beta/extractors/get-config-schema","autogeneratedByOpenApi":true}]},{"group":"Hosted extractors","pages":[{"title":"Hosted extractors","sidebarTitle":"Overview","description":"Manage hosted extractor sources, jobs, destinations, and mappings in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/hosted-extractors"},{"group":"Sources","pages":[{"title":"Sources","sidebarTitle":"Sources","description":"Manage hosted extractor sources in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/hosted-extractors-sources"},{"title":"Create Sources","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nCreate up to 100 sources.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/sources","href":"/20230101-beta/sources/create-sources","autogeneratedByOpenApi":true},{"title":"Delete Sources","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nDelete a list of sources by their external ID. This operation will fail if any destination in the request is associated with a job, unless the `force` query parameter is set to `true`.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/sources/delete","href":"/20230101-beta/sources/delete-sources","autogeneratedByOpenApi":true},{"title":"List Sources","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nList all sources in a given project. If more than `limit` sources exist, a cursor for pagination will be returned with the response.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /hostedextractors/sources","href":"/20230101-beta/sources/list-sources","autogeneratedByOpenApi":true},{"title":"Retrieve Sources","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nRetrieve a list of up to 100 sources by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/sources/byIds","href":"/20230101-beta/sources/retrieve-sources","autogeneratedByOpenApi":true},{"title":"Update Sources","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nUpdate up to 100 sources.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/sources/update","href":"/20230101-beta/sources/update-sources","autogeneratedByOpenApi":true}]},{"group":"Jobs","pages":[{"title":"Jobs","sidebarTitle":"Jobs","description":"Manage hosted extractor jobs in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/hosted-extractors-jobs"},{"title":"Create Jobs","description":"\n\n> **Required capabilities:** `hostedExtractors:READ` `hostedExtractors:WRITE`\n\nCreate up to 10 jobs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/jobs","href":"/20230101-beta/jobs/create-jobs","autogeneratedByOpenApi":true},{"title":"Delete Jobs","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nDelete a list of jobs by their external ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/jobs/delete","href":"/20230101-beta/jobs/delete-jobs","autogeneratedByOpenApi":true},{"title":"Get Job Logs","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nList logs, optionally filtering on job, source, or destination. Logs are retrieved in reverse chronological order.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /hostedextractors/jobs/logs","href":"/20230101-beta/jobs/get-job-logs","autogeneratedByOpenApi":true},{"title":"Get Job DLQ Messages","description":"Lists dead letter queue messages for a job. Requires `hostedExtractors:READ` and `rawAcl:READ`. See [Dead letter queue](/api-reference/concepts/20230101/hosted-extractors-jobs#dead-letter-queue).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /hostedextractors/jobs/dlq","href":"/20230101-beta/jobs/get-job-dlq-messages","autogeneratedByOpenApi":true},{"title":"Get Job Metrics","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nList metrics, optionally filtering on job, source, or destination. Logs are retrieved in reverse chronological order.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /hostedextractors/jobs/metrics","href":"/20230101-beta/jobs/get-job-metrics","autogeneratedByOpenApi":true},{"title":"Retrieve Jobs","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nRetrieve a list of up to 100 jobs by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/jobs/byIds","href":"/20230101-beta/jobs/retrieve-jobs","autogeneratedByOpenApi":true},{"title":"Update Jobs","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nUpdate a list of up to 100 jobs. Enabling the dead letter queue for a job, or moving a job that has it enabled to a different destination, requires the job's destination credentials to have write access to CDF RAW, in addition to `hostedExtractors:WRITE`. Before updating, the destination session is refreshed and the DLQ storage for the job is created. The request fails with status 400 if the destination has no session, the session cannot be refreshed, or the session lacks RAW write access. It fails with status 502 if CDF cannot be reached or RAW returns a server error during this check. If the check fails for any job, no jobs in the request are updated. The check is not run for jobs that already have the dead letter queue enabled and keep their destination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/jobs/update","href":"/20230101-beta/jobs/update-jobs","autogeneratedByOpenApi":true}]},{"group":"Destinations","pages":[{"title":"Destinations","sidebarTitle":"Destinations","description":"Manage hosted extractor destinations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/hosted-extractors-destinations"},{"title":"Create Destinations","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nCreate up to 100 destinations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/destinations","href":"/20230101-beta/destinations/create-destinations","autogeneratedByOpenApi":true},{"title":"Delete Destinations","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nDelete a list of destinations by their external ID. This operation will fail if any destination in the request is associated with a job, unless the `force` query parameter is set to `true`.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/destinations/delete","href":"/20230101-beta/destinations/delete-destinations","autogeneratedByOpenApi":true},{"title":"Retrieve Destinations","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nRetrieve a list of up to 100 destinations by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/destinations/byIds","href":"/20230101-beta/destinations/retrieve-destinations","autogeneratedByOpenApi":true},{"title":"Update Destinations","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nUpdate up to 100 destinations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/destinations/update","href":"/20230101-beta/destinations/update-destinations","autogeneratedByOpenApi":true}]},{"group":"Mappings","pages":[{"title":"Mappings","sidebarTitle":"Mappings","description":"Manage hosted extractor mappings in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/hosted-extractors-mappings"},{"title":"Create Mappings","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nCreate up to 100 mappings.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/mappings","href":"/20230101-beta/mappings/create-mappings","autogeneratedByOpenApi":true},{"title":"Delete Mappings","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nDelete a list of mappings by their external ID. This operation will fail if any mapping in the request is associated with a job, unless the `force` query parameter is set to `true`.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/mappings/delete","href":"/20230101-beta/mappings/delete-mappings","autogeneratedByOpenApi":true},{"title":"Retrieve Mappings","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nRetrieve a list of up to 100 mappings by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/mappings/byIds","href":"/20230101-beta/mappings/retrieve-mappings","autogeneratedByOpenApi":true},{"title":"Update Mappings","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nUpdate up to 100 mappings.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /hostedextractors/mappings/update","href":"/20230101-beta/mappings/update-mappings","autogeneratedByOpenApi":true}]}]}]},{"group":"Data organization","pages":[{"title":"Data organization","sidebarTitle":"Overview","description":"Govern ready-for-consumption data with data products in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/data-organization"},{"group":"Data products","pages":[{"title":"Data products","sidebarTitle":"Overview","description":"Govern ready-for-consumption data with data products and versioned views in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/data-products"},{"title":"Create a data product","description":"\n\n> **Required capabilities:** `dataProductsAcl:CREATE`\n\nCreates a new data product. Maximum 100 data products allowed per project. Request body must contain an 'items' array with up to 1 data product definition per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /dataproducts","href":"/20230101-beta/data-products/create-a-data-product","autogeneratedByOpenApi":true},{"title":"List data products","description":"\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nList all data products, with pagination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /dataproducts","href":"/20230101-beta/data-products/list-data-products","autogeneratedByOpenApi":true},{"title":"Get a data product","description":"\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nRetrieves a specific data product by its external identifier.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /dataproducts/{externalId}","href":"/20230101-beta/data-products/get-a-data-product","autogeneratedByOpenApi":true},{"title":"Delete a data product","description":"\n\n> **Required capabilities:** `dataProductsAcl:DELETE`\n\nPermanently removes a data product. A data product can not be deleted if it contains versions. This operation cannot be undone.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /dataproducts/delete","href":"/20230101-beta/data-products/delete-a-data-product","autogeneratedByOpenApi":true},{"title":"Update a data product","description":"\n\n> **Required capabilities:** `dataProductsAcl:UPDATE`\n\nUpdate the attributes of a data product. Fields that aren't included in the request aren't changed.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /dataproducts/update","href":"/20230101-beta/data-products/update-a-data-product","autogeneratedByOpenApi":true},{"title":"Get data products","description":"\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nGet data products by externalId.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /dataproducts/byids","href":"/20230101-beta/data-products/get-data-products","autogeneratedByOpenApi":true},{"title":"Create a data product version","description":"Creates one data product version. A product can have 10 versions. Requires `dataProductsAcl:UPDATE`. See [Limits](/api-reference/concepts/20230101/data-products#limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /dataproducts/{externalId}/versions","href":"/20230101-beta/data-products/create-a-data-product-version","autogeneratedByOpenApi":true},{"title":"List data product versions","description":"\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nList all versions of a data product, with pagination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /dataproducts/{externalId}/versions","href":"/20230101-beta/data-products/list-data-product-versions","autogeneratedByOpenApi":true},{"title":"Get a data product version","description":"\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nRetrieves a specific version of a data product by its semantic version.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /dataproducts/{externalId}/versions/{version}","href":"/20230101-beta/data-products/get-a-data-product-version","autogeneratedByOpenApi":true},{"title":"Delete data product versions","description":"\n\n> **Required capabilities:** `dataProductsAcl:UPDATE`\n\nDeletes one or more versions of a data product. Accepts a list of semantic versions. When a version is deleted, access filter entries for that version are removed from all data product roles of the owning data product. This operation cannot be undone.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /dataproducts/{externalId}/versions/delete","href":"/20230101-beta/data-products/delete-data-product-versions","autogeneratedByOpenApi":true},{"title":"Update data product version","description":"\n\n> **Required capabilities:** `dataProductsAcl:UPDATE`\n\nUpdate the attributes of a data product version. Fields that aren't included in the request aren't changed.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /dataproducts/{externalId}/versions/update","href":"/20230101-beta/data-products/update-data-product-version","autogeneratedByOpenApi":true}]}]},{"group":"Transformations","pages":[{"title":"Transformations","sidebarTitle":"Overview","description":"Process and move data within Cognite Data Fusion (CDF) using SQL-based transformations.","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/transformations-overview"},{"group":"Transformations","pages":[{"title":"Transformations","sidebarTitle":"Overview","description":"Create and manage data transformations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/transformations"},{"title":"Create transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nCreate a maximum of 1000 transformations per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations","href":"/20230101-beta/transformations/create-transformations","autogeneratedByOpenApi":true},{"title":"Cancel a transformation","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/cancel","href":"/20230101-beta/transformations/cancel-a-transformation","autogeneratedByOpenApi":true},{"title":"Delete transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nDelete a maximum of 1000 transformations by ids and externalIds per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/delete","href":"/20230101-beta/transformations/delete-transformations","autogeneratedByOpenApi":true},{"title":"Filter transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nFilter transformations. Use nextCursor to paginate through the results.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/filter","href":"/20230101-beta/transformations/filter-transformations","autogeneratedByOpenApi":true},{"title":"Retrieve transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nRetrieve a maximum of 1000 transformations by ids and externalIds per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/byids","href":"/20230101-beta/transformations/retrieve-transformations","autogeneratedByOpenApi":true},{"title":"Run a transformation","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/run","href":"/20230101-beta/transformations/run-a-transformation","autogeneratedByOpenApi":true},{"title":"Update transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nUpdate the attributes of transformations, maximum 1000 per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/update","href":"/20230101-beta/transformations/update-transformations","autogeneratedByOpenApi":true}]},{"group":"Transformation jobs","pages":[{"title":"Transformation Jobs","sidebarTitle":"Overview","description":"Monitor transformation job executions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/transformation-jobs"},{"title":"List jobs","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /transformations/jobs","href":"/20230101-beta/transformation-jobs/list-jobs","autogeneratedByOpenApi":true},{"title":"Retrieve jobs by ids","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nRetrieve a maximum of 1000 jobs by ids per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/jobs/byids","href":"/20230101-beta/transformation-jobs/retrieve-jobs-by-ids","autogeneratedByOpenApi":true},{"title":"List job metrics by job id","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /transformations/jobs/{id}/metrics","href":"/20230101-beta/transformation-jobs/list-job-metrics-by-job-id","autogeneratedByOpenApi":true}]},{"group":"Transformation schedules","pages":[{"title":"Transformation Schedules","sidebarTitle":"Overview","description":"Schedule transformations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/transformation-schedules"},{"title":"List all schedules","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nList all transformation schedules. Use nextCursor to paginate through the results.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /transformations/schedules","href":"/20230101-beta/transformation-schedules/list-all-schedules","autogeneratedByOpenApi":true},{"title":"Schedule transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nSchedule transformations with the specified configurations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/schedules","href":"/20230101-beta/transformation-schedules/schedule-transformations","autogeneratedByOpenApi":true},{"title":"Retrieve schedules","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nRetrieve transformation schedules by transformation IDs or external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/schedules/byids","href":"/20230101-beta/transformation-schedules/retrieve-schedules","autogeneratedByOpenApi":true},{"title":"Unschedule transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nUnschedule transformations by IDs or externalIds.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/schedules/delete","href":"/20230101-beta/transformation-schedules/unschedule-transformations","autogeneratedByOpenApi":true},{"title":"Update schedules","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/schedules/update","href":"/20230101-beta/transformation-schedules/update-schedules","autogeneratedByOpenApi":true}]},{"group":"Transformation notifications","pages":[{"title":"Transformation Notifications","sidebarTitle":"Overview","description":"Subscribe to transformation notifications in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/transformation-notifications"},{"title":"Subscribe for notifications","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nSubscribe for notifications on the transformation errors.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/notifications","href":"/20230101-beta/transformation-notifications/subscribe-for-notifications","autogeneratedByOpenApi":true},{"title":"Delete notification subscriptions by notification ID","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nDeletes the specified notification subscriptions on the transformation. Requests to delete non-existing subscriptions do nothing, but do not throw an error.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/notifications/delete","href":"/20230101-beta/transformation-notifications/delete-notification-subscriptions-by-notification-id","autogeneratedByOpenApi":true}]},{"group":"Query","pages":[{"title":"Query","sidebarTitle":"Overview","description":"Run SQL queries against CDF resources in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/transformation-query"},{"title":"Run query","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nPreview a SQL query.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/query/run","href":"/20230101-beta/query/run-query","autogeneratedByOpenApi":true}]},{"group":"Schema","pages":[{"title":"Schema","sidebarTitle":"Overview","description":"Retrieve resource schemas for transformations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/transformation-schema"},{"title":"Get Instance schema.","description":"Returns the instance schema for a view or a data model. Requires `transformationsAcl:READ`. See [Instance schema](/api-reference/concepts/20230101/transformations#instance-schema).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /transformations/schema/instances","href":"/20230101-beta/schema/get-instance-schema","autogeneratedByOpenApi":true},{"title":"Get the schema of a sequence","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /transformations/schema/sequence_rows","href":"/20230101-beta/schema/get-the-schema-of-a-sequence","autogeneratedByOpenApi":true},{"title":"Get the schema of resource type","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /transformations/schema/{schemaType}","href":"/20230101-beta/schema/get-the-schema-of-resource-type","autogeneratedByOpenApi":true}]},{"group":"External data sources","pages":[{"title":"Transformation external data sources","sidebarTitle":"Overview","description":"Register and manage external data sources so Transformations can read Microsoft Fabric OneLake (beta REST API).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/transformation-external-data"},{"title":"List external data sources","description":"\n\n> **Required capabilities:** `transformationsExternalDataSourcesAcl:READ`\n\nList the external data sources configured for the project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /transformations/externaldata","href":"/20230101-beta/transformation-external-data-sources/list-external-data-sources","autogeneratedByOpenApi":true},{"title":"Create external data sources","description":"\n\n> **Required capabilities:** `transformationsExternalDataSourcesAcl:WRITE`\n\nCreate external data sources.\n\nIf an item's `externalId` already exists for the project, the whole\nrequest is rejected with a 409 and no items are created. To modify an\nexisting data source, delete it and create a replacement.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/externaldata","href":"/20230101-beta/transformation-external-data-sources/create-external-data-sources","autogeneratedByOpenApi":true},{"title":"Delete external data sources","description":"\n\n> **Required capabilities:** `transformationsExternalDataSourcesAcl:WRITE`\n\nDelete external data sources by external ID.\n\nTransformations that still reference a deleted data source fail when\nthey next run.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/externaldata/delete","href":"/20230101-beta/transformation-external-data-sources/delete-external-data-sources","autogeneratedByOpenApi":true},{"title":"Verify external data source usability","description":"\n\n> **Required capabilities:** `transformationsExternalDataSourcesAcl:USE`\n\nCheck whether an external data source can be used by a transformation.\n\nReturns the external id and the latest `usableVersion` of the data\nsource. If `usableVersion` is not present in the response, the\nresource is missing or inaccessible.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /transformations/externaldata/usability","href":"/20230101-beta/transformation-external-data-sources/verify-external-data-source-usability","autogeneratedByOpenApi":true}]}]}]},{"group":"Documents","icon":"file-text","expanded":true,"pages":[{"group":"Documents","pages":[{"title":"Documents","sidebarTitle":"Overview","description":"Search, manage, and preview documents in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/documents-overview"},{"group":"Documents","pages":[{"title":"Documents","sidebarTitle":"Overview","description":"Search and manage documents in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/documents"},{"title":"Aggregate","description":"Compute aggregated results on documents, such as counts, distinct values, and unique properties.","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/aggregate"},{"title":"Search","description":"Search for documents using advanced filters and free text queries.","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/search"},{"title":"Passages search","description":"Search for relevant passages of PDF documents using semantic and lexical search filters.","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/passages-search"},{"title":"Aggregate documents","description":"Aggregates documents that match a filter or search. Requires `filesAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/documents#aggregates).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /documents/aggregate","href":"/20230101-beta/documents/aggregate-documents","autogeneratedByOpenApi":true},{"title":"List documents","description":"Lists documents. Unlike search, pagination is not capped at 1000 documents. 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-beta.json post /documents/list","href":"/20230101-beta/documents/list-documents","autogeneratedByOpenApi":true},{"title":"Document status","description":"\n\n> **Required capabilities:** `filesAcl:READ`\n\nCheck the index status for set of documents. Useful to check if a document is ready for search.\n\nThis endpoint is in `beta` and is available only when a `cdf-version: YYYYMMDD-beta` header\nis provided.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /documents/status","href":"/20230101-beta/documents/document-status","autogeneratedByOpenApi":true},{"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-beta.json post /documents/content","href":"/20230101-beta/documents/retrieve-document-content","autogeneratedByOpenApi":true},{"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-beta.json post /documents/search","href":"/20230101-beta/documents/search-for-documents","autogeneratedByOpenApi":true},{"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-beta.json post /documents/passages/search","href":"/20230101-beta/documents/semantic-search-for-passages","autogeneratedByOpenApi":true}]},{"group":"Document preview","pages":[{"title":"Document preview","sidebarTitle":"Overview","description":"Preview documents in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/document-preview"},{"title":"Retrieve a image preview of a page from a document","description":"Returns a PNG preview of one page. Set `Accept` to `image/png`. Requires `filesAcl:READ`. See [Rendering limits](/api-reference/concepts/20230101/document-preview#rendering-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /documents/{documentId}/preview/image/pages/{pageNumber}","href":"/20230101-beta/document-preview/retrieve-a-image-preview-of-a-page-from-a-document","autogeneratedByOpenApi":true},{"title":"Retrieve a PDF preview of a document","description":"Returns a PDF preview. Set `Accept` to `application/pdf`. Requires `filesAcl:READ`. See [Rendering limits](/api-reference/concepts/20230101/document-preview#rendering-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /documents/{documentId}/preview/pdf","href":"/20230101-beta/document-preview/retrieve-a-pdf-preview-of-a-document","autogeneratedByOpenApi":true},{"title":"Retrieve a temporary link to a PDF preview of a document","description":"\n\n> **Required capabilities:** `filesAcl:READ`\n\nThis endpoint works similar as the normal preview endpoint except\nit returns a short-lived temporary link to download the rendered preview instead\nof returning the binary data.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /documents/{documentId}/preview/pdf/temporarylink","href":"/20230101-beta/document-preview/retrieve-a-temporary-link-to-a-pdf-preview-of-a-document","autogeneratedByOpenApi":true}]}]}]},{"group":"Integrations","icon":"layers","expanded":true,"pages":[{"title":"Integrations","sidebarTitle":"Overview","description":"Monitor and control extractors and other data integrations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/integrations-overview"},{"group":"Integrations","pages":[{"title":"Integrations resource","sidebarTitle":"Integrations","description":"Register, update, and delete integrations so you can monitor extractors and data pipelines in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/integrations"},{"title":"List Integrations","description":"\n\n> **Required capabilities:** `integrationsAcl:READ`\n\nList integrations, with optional pagination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /integrations","href":"/20230101-beta/integrations/list-integrations","autogeneratedByOpenApi":true},{"title":"Create Integrations","description":"\n\n> **Required capabilities:** `integrationsAcl:WRITE`\n\nCreate integrations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /integrations","href":"/20230101-beta/integrations/create-integrations","autogeneratedByOpenApi":true},{"title":"Retrieve Integrations","description":"\n\n> **Required capabilities:** `integrationsAcl:READ`\n\nRetrieve integrations by ID, optionally ignoring unknown ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /integrations/byids","href":"/20230101-beta/integrations/retrieve-integrations","autogeneratedByOpenApi":true},{"title":"Delete Integrations","description":"\n\n> **Required capabilities:** `integrationsAcl:WRITE`\n\nDelete integrations by ID, optionally ignoring unknown ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /integrations/delete","href":"/20230101-beta/integrations/delete-integrations","autogeneratedByOpenApi":true},{"title":"Update Integrations","description":"\n\n> **Required capabilities:** `integrationsAcl:WRITE`\n\nUpdate up to 20 integrations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /integrations/update","href":"/20230101-beta/integrations/update-integrations","autogeneratedByOpenApi":true},{"title":"Report Extractor Info","description":"\n\n> **Required capabilities:** `integrationsAcl:USE`\n\nReport changes to general information about the extractor, and indicates to the API that the extractor has started. This will close any currently running tasks with an error.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /integrations/startup","href":"/20230101-beta/integrations/report-extractor-info","autogeneratedByOpenApi":true},{"title":"Check in","description":"\n\n> **Required capabilities:** `integrationsAcl:USE`\n\nCheck in with the integrations service. This endpoint is called periodically by extractors to signal that they are still alive, and report any events that may have happened since the last check in.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /integrations/checkin","href":"/20230101-beta/integrations/check-in","autogeneratedByOpenApi":true}]},{"group":"Tasks","pages":[{"title":"Tasks","sidebarTitle":"Tasks","description":"Track integration task run history and sync updates in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/integrations-tasks"},{"title":"Get Task History","description":"\n\n> **Required capabilities:** `integrationsAcl:READ`\n\nList task history with optional filtering and pagination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /integrations/history","href":"/20230101-beta/integration-tasks/get-task-history","autogeneratedByOpenApi":true},{"title":"Sync Integration History","description":"Returns task history and errors since the cursor. Requires `integrationsAcl:READ`. See [Sync](/api-reference/concepts/20230101-beta/integrations-tasks#sync).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /integrations/sync","href":"/20230101-beta/integration-tasks/sync-integration-history","autogeneratedByOpenApi":true}]},{"group":"Actions","pages":[{"title":"Actions","sidebarTitle":"Actions","description":"Trigger and manage remote actions on an integration in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/integrations-actions"},{"title":"Create Actions","description":"\n\n> **Required capabilities:** `integrationActionsAcl:WRITE`\n\nCreate actions for an integration. The extractor is requested to run pending actions the next time it checks in.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /integrations/actions","href":"/20230101-beta/integration-actions/create-actions","autogeneratedByOpenApi":true},{"title":"List Actions","description":"\n\n> **Required capabilities:** `integrationActionsAcl:READ`\n\nList actions, with optional filtering by integration and pagination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /integrations/actions","href":"/20230101-beta/integration-actions/list-actions","autogeneratedByOpenApi":true},{"title":"Retrieve Actions","description":"\n\n> **Required capabilities:** `integrationActionsAcl:READ`\n\nRetrieve actions by ID, optionally ignoring unknown ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /integrations/actions/byids","href":"/20230101-beta/integration-actions/retrieve-actions","autogeneratedByOpenApi":true},{"title":"Cancel Actions","description":"\n\n> **Required capabilities:** `integrationActionsAcl:WRITE`\n\nCancel actions by ID, optionally ignoring unknown ids. Only actions that are pending, running, or already cancel-pending can be cancelled.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /integrations/actions/cancel","href":"/20230101-beta/integration-actions/cancel-actions","autogeneratedByOpenApi":true}]},{"group":"Configuration","pages":[{"title":"Configuration","sidebarTitle":"Configuration","description":"Create and retrieve immutable configuration revisions for an integration in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/integrations-config"},{"title":"Create config revision.","description":"\n\n> **Required capabilities:** `integrationConfigsAcl:WRITE`\n\nCreate a new config revision. The extractor will be notified of this when it next checks in.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /integrations/config","href":"/20230101-beta/integration-configuration/create-config-revision","autogeneratedByOpenApi":true},{"title":"Fetch config revision","description":"\n\n> **Required capabilities:** `integrationConfigsAcl:READ`\n\nFetch a specific config revision.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /integrations/config","href":"/20230101-beta/integration-configuration/fetch-config-revision","autogeneratedByOpenApi":true},{"title":"List config revisions","description":"\n\n> **Required capabilities:** `integrationConfigsAcl:READ`\n\nList config revisions, optionally filtering by a specific integration.\nThis is backwards compatible with extraction pipelines API.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /integrations/config/revisions","href":"/20230101-beta/integration-configuration/list-config-revisions","autogeneratedByOpenApi":true}]},{"group":"Errors","pages":[{"title":"Errors","sidebarTitle":"Errors","description":"List errors reported by an integration, filtered by task or time range, in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/integrations-errors"},{"title":"List Errors","description":"\n\n> **Required capabilities:** `integrationsAcl:READ`\n\nList errors, filtering by tasks and integration. With optional pagination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /integrations/errors","href":"/20230101-beta/integration-errors/list-errors","autogeneratedByOpenApi":true}]}]},{"group":"Signals","icon":"radio","pages":[{"title":"Signals","sidebarTitle":"Overview","description":"Registers signal sinks and subscriptions in Cognite Data Fusion using the beta REST API.","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/signals"},{"group":"Signal sinks","pages":[{"title":"Create sinks","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:WRITE`\n\nCreate one or more sinks in the project. A sink represents a destination for signals, either a user sink (signals sent to the user's e-mail) or an e-mail sink (signals sent to a specified e-mail address).\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /processes/signals/sinks","href":"/20230101-beta/signals/create-sinks","autogeneratedByOpenApi":true},{"title":"List sinks","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:READ`\n\nList all sinks in the project. This will return all sinks the user has access to. If the user only has \"current_user\" scope, it will only return the sink for the user making the request, if it exists.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /processes/signals/sinks","href":"/20230101-beta/signals/list-sinks","autogeneratedByOpenApi":true},{"title":"Retrieve sinks by external IDs","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:READ`\n\nRetrieve one or more sinks by their external IDs.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /processes/signals/sinks/byids","href":"/20230101-beta/signals/retrieve-sinks-by-external-ids","autogeneratedByOpenApi":true},{"title":"Update sinks","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:WRITE`\n\nUpdate one or more sinks in the project.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /processes/signals/sinks/update","href":"/20230101-beta/signals/update-sinks","autogeneratedByOpenApi":true},{"title":"Delete sinks","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:WRITE`\n\nDelete one or more sinks by their external IDs.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /processes/signals/sinks/delete","href":"/20230101-beta/signals/delete-sinks","autogeneratedByOpenApi":true}]},{"group":"Signal subscriptions","pages":[{"title":"Create subscriptions","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:WRITE`\n\nCreate one or more subscriptions in the project. A subscription ties a sink to a topic with a filter that determines which signals will be pushed out to the sink.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /processes/signals/subscriptions","href":"/20230101-beta/signals/create-subscriptions","autogeneratedByOpenApi":true},{"title":"Filter subscriptions","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:READ`\n\nRetrieve subscriptions matching a filter.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /processes/signals/subscriptions/list","href":"/20230101-beta/signals/filter-subscriptions","autogeneratedByOpenApi":true},{"title":"Update subscriptions","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:WRITE`\n\nUpdate one or more subscriptions in the project.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /processes/signals/subscriptions/update","href":"/20230101-beta/signals/update-subscriptions","autogeneratedByOpenApi":true},{"title":"Delete subscriptions","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:WRITE`\n\nDelete one or more subscriptions by their external IDs.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /processes/signals/subscriptions/delete","href":"/20230101-beta/signals/delete-subscriptions","autogeneratedByOpenApi":true}]},{"group":"List signals","pages":[{"title":"List signals.","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:READ`\n\nList all signals for a sink.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /processes/signals/list","href":"/20230101-beta/signals/list-signals","autogeneratedByOpenApi":true}]},{"group":"Sync signals","pages":[{"title":"Sync signals","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:READ`\n\nRetrieve signals for a sink incrementally. Unlike the list endpoint, the returned cursor is persistent and can be stored and reused later to fetch only signals that arrived after the previous sync. The response always includes a `nextCursor`, and `moreData` indicates whether more signals are immediately available.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /processes/signals/sync","href":"/20230101-beta/signals/sync-signals","autogeneratedByOpenApi":true}]},{"group":"Signal topics","pages":[{"title":"List topics","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:READ`\n\nList all topics supported by the signals service. Each topic represents a type of CDF resource that can emit signals, such as integrations or workflows. The response includes the available notification categories for each topic, which can be used when creating subscriptions.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /processes/signals/topics","href":"/20230101-beta/signals/list-topics","autogeneratedByOpenApi":true}]}]},{"group":"Workflows","icon":"workflow","pages":[{"title":"Workflows","sidebarTitle":"Overview","description":"Orchestrate multi-step data processing pipelines in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/workflows-overview"},{"group":"Workflows","pages":[{"title":"Workflows","sidebarTitle":"Overview","description":"Create and manage data workflows in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/workflows"},{"title":"Create or update a workflow","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nCreate or update a workflow. Limited to a single workflow per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /workflows","href":"/20230101-beta/workflows/create-or-update-a-workflow","autogeneratedByOpenApi":true},{"title":"Delete workflows","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nDelete workflows, including all associated workflow versions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /workflows/delete","href":"/20230101-beta/workflows/delete-workflows","autogeneratedByOpenApi":true},{"title":"Retrieve a workflow","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nRetrieve a workflow by its external id.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /workflows/{workflowExternalId}","href":"/20230101-beta/workflows/retrieve-a-workflow","autogeneratedByOpenApi":true}]},{"group":"Workflow versions","pages":[{"title":"Workflow versions","sidebarTitle":"Overview","description":"Manage workflow versions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/workflow-versions"},{"title":"Create or update a workflow version","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nCreate or update a workflow version. Limited to a single workflow version per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /workflows/versions","href":"/20230101-beta/workflow-versions/create-or-update-a-workflow-version","autogeneratedByOpenApi":true},{"title":"Filter workflow versions","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nList workflow versions matching a given filter.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /workflows/versions/list","href":"/20230101-beta/workflow-versions/filter-workflow-versions","autogeneratedByOpenApi":true},{"title":"Retrieve a workflow version","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nRetrieve a version of a given workflow.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /workflows/{workflowExternalId}/versions/{version}","href":"/20230101-beta/workflow-versions/retrieve-a-workflow-version","autogeneratedByOpenApi":true},{"title":"Delete workflow versions","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nDelete specific versions of one or more workflows.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /workflows/versions/delete","href":"/20230101-beta/workflow-versions/delete-workflow-versions","autogeneratedByOpenApi":true}]},{"group":"Workflow executions","pages":[{"title":"Workflow executions","sidebarTitle":"Overview","description":"Run and monitor workflow executions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/workflow-executions"},{"title":"Run a workflow","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nStart an execution of a specific version of a workflow.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /workflows/{workflowExternalId}/versions/{version}/run","href":"/20230101-beta/workflow-executions/run-a-workflow","autogeneratedByOpenApi":true},{"title":"Filter workflow executions","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nList workflow executions matching a given filter.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /workflows/executions/list","href":"/20230101-beta/workflow-executions/filter-workflow-executions","autogeneratedByOpenApi":true},{"title":"Retrieve workflow execution details","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nRetrieve detailed information about a specific workflow execution.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /workflows/executions/{executionId}","href":"/20230101-beta/workflow-executions/retrieve-workflow-execution-details","autogeneratedByOpenApi":true},{"title":"Cancel a workflow execution","description":"Stops an execution from starting new tasks and sets it to `TERMINATED`. Requires `workflowOrchestrationACL:WRITE`. See [Canceling executions](/api-reference/concepts/20230101/workflow-executions#canceling-executions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /workflows/executions/{executionId}/cancel","href":"/20230101-beta/workflow-executions/cancel-a-workflow-execution","autogeneratedByOpenApi":true},{"title":"Retry workflow execution","description":"Retries tasks that did not finish in a failed, timed out, or terminated execution. Requires `workflowOrchestrationACL:WRITE`. See [Retrying executions](/api-reference/concepts/20230101/workflow-executions#retrying-executions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /workflows/executions/{executionId}/retry","href":"/20230101-beta/workflow-executions/retry-workflow-execution","autogeneratedByOpenApi":true}]},{"group":"Workflow triggers","pages":[{"title":"Workflow triggers","sidebarTitle":"Overview","description":"Schedule and manage workflow triggers in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/workflow-triggers"},{"title":"Create or update triggers","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nCreate or update a trigger.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /workflows/triggers","href":"/20230101-beta/workflow-triggers/create-or-update-triggers","autogeneratedByOpenApi":true},{"title":"Delete triggers","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nDelete a trigger.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /workflows/triggers/delete","href":"/20230101-beta/workflow-triggers/delete-triggers","autogeneratedByOpenApi":true},{"title":"Get the run history of a trigger","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nGet information about every run of a trigger. This includes timing information and a reference to the started execution (or an explanation as to why it failed). The returned items are sorted by `fireTime` in descending order (newest first), followed by `externalId` in ascending order.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /workflows/triggers/{triggerExternalId}/history","href":"/20230101-beta/workflow-triggers/get-the-run-history-of-a-trigger","autogeneratedByOpenApi":true},{"title":"Pause a trigger","description":"Pauses a trigger so it does not fire. Stream triggers resume from the cursor at pause time. Requires `workflowOrchestrationACL:WRITE`. See [Pause and resume](/api-reference/concepts/20230101/workflow-triggers#pause-and-resume).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /workflows/triggers/{triggerExternalId}/pause","href":"/20230101-beta/workflow-triggers/pause-a-trigger","autogeneratedByOpenApi":true},{"title":"Resume a trigger","description":"Resumes a paused trigger. Stream triggers continue from the cursor at pause time. Requires `workflowOrchestrationACL:WRITE`. See [Pause and resume](/api-reference/concepts/20230101/workflow-triggers#pause-and-resume).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /workflows/triggers/{triggerExternalId}/resume","href":"/20230101-beta/workflow-triggers/resume-a-trigger","autogeneratedByOpenApi":true}]},{"group":"Tasks","pages":[{"title":"Tasks","sidebarTitle":"Tasks","description":"Update workflow task statuses in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/workflow-tasks"},{"title":"Update task status","description":"Sets the status of an asynchronous task to completed or failed. Requires `workflowOrchestrationACL:WRITE`. See [Complete an async task](/api-reference/concepts/20230101/workflow-executions#complete-an-async-task).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /workflows/tasks/{taskId}/update","href":"/20230101-beta/tasks/update-task-status","autogeneratedByOpenApi":true}]}]},{"group":"Specialized","icon":"sparkles","expanded":true,"pages":[{"group":"Simulators","pages":[{"title":"Simulators","sidebarTitle":"Overview","description":"Integrate simulation software with Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/simulators-overview"},{"group":"Simulators","pages":[{"title":"Simulators","sidebarTitle":"Overview","description":"Manage simulators in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/simulators"},{"title":"Filter Simulators","description":"List simulators.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/list","href":"/20230101-beta/simulators/filter-simulators","autogeneratedByOpenApi":true}]},{"group":"Simulator integrations","pages":[{"title":"Simulator Integrations","sidebarTitle":"Overview","description":"Manage simulator integrations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/simulator-integrations"},{"title":"Delete Simulator Integrations","description":"Delete a simulator integration. This will also delete all associated simulator resources (e.g. routines, runs).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/integrations/delete","href":"/20230101-beta/simulator-integrations/delete-simulator-integrations","autogeneratedByOpenApi":true},{"title":"Filter Simulator Integrations","description":"Retrieves a list of simulator integrations that match the given criteria.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/integrations/list","href":"/20230101-beta/simulator-integrations/filter-simulator-integrations","autogeneratedByOpenApi":true}]},{"group":"Simulator models","pages":[{"title":"Simulator Models","sidebarTitle":"Overview","description":"Manage simulator models in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/simulator-models"},{"title":"Create Simulator Model","description":"Create a simulator model.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/models","href":"/20230101-beta/simulator-models/create-simulator-model","autogeneratedByOpenApi":true},{"title":"Filter Simulator Models","description":"Retrieves a list of simulator models that match the given criteria.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/models/list","href":"/20230101-beta/simulator-models/filter-simulator-models","autogeneratedByOpenApi":true},{"title":"Aggregate Simulator Models","description":"Calculate aggregates for simulator models, considering the optional filter specification.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/models/aggregate","href":"/20230101-beta/simulator-models/aggregate-simulator-models","autogeneratedByOpenApi":true},{"title":"Delete Simulator Model","description":"Delete a simulator model. This will also delete all associated simulator resources (e.g. revisions, routines, runs).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/models/delete","href":"/20230101-beta/simulator-models/delete-simulator-model","autogeneratedByOpenApi":true},{"title":"Update Simulator Model","description":"Update a simulator model.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/models/update","href":"/20230101-beta/simulator-models/update-simulator-model","autogeneratedByOpenApi":true},{"title":"Retrieve Simulator Model","description":"Retrieve a simulator model by ID or external ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/models/byids","href":"/20230101-beta/simulator-models/retrieve-simulator-model","autogeneratedByOpenApi":true},{"title":"Create Simulator Model Revision","description":"Create a simulator model revision.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/models/revisions","href":"/20230101-beta/simulator-models/create-simulator-model-revision","autogeneratedByOpenApi":true},{"title":"Filter Simulator Model Revisions","description":"Retrieves a list of simulator model revisions that match the given criteria.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/models/revisions/list","href":"/20230101-beta/simulator-models/filter-simulator-model-revisions","autogeneratedByOpenApi":true},{"title":"Retrieve Simulator Model Revisions","description":"Retrieve one or more simulator model revisions by IDs or external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/models/revisions/byids","href":"/20230101-beta/simulator-models/retrieve-simulator-model-revisions","autogeneratedByOpenApi":true}]},{"group":"Simulator routines","pages":[{"title":"Simulator Routines","sidebarTitle":"Overview","description":"Manage simulator routines in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/simulator-routines"},{"title":"Create Simulator Routine","description":"Create a simulator routine.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/routines","href":"/20230101-beta/simulator-routines/create-simulator-routine","autogeneratedByOpenApi":true},{"title":"Filter Simulator Routines","description":"Retrieves a list of simulator routines that match the given criteria.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/routines/list","href":"/20230101-beta/simulator-routines/filter-simulator-routines","autogeneratedByOpenApi":true},{"title":"Delete Simulator Routine","description":"Delete a simulator routine. This will also delete all associated simulator resources (e.g. revisions, runs, data).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/routines/delete","href":"/20230101-beta/simulator-routines/delete-simulator-routine","autogeneratedByOpenApi":true},{"title":"Aggregate Simulator Routines","description":"Calculate aggregates for simulator routines, considering the optional filter specification.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/routines/aggregate","href":"/20230101-beta/simulator-routines/aggregate-simulator-routines","autogeneratedByOpenApi":true},{"title":"Create Simulator Routine Revision","description":"Creates a routine revision. The body can be at most 50 KB. See [Revision size](/api-reference/concepts/20230101/simulator-routines#revision-size).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/routines/revisions","href":"/20230101-beta/simulator-routines/create-simulator-routine-revision","autogeneratedByOpenApi":true},{"title":"Filter Simulator Routine Revisions","description":"Retrieves a list of simulator routine revisions that match the given criteria.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/routines/revisions/list","href":"/20230101-beta/simulator-routines/filter-simulator-routine-revisions","autogeneratedByOpenApi":true},{"title":"Retrieve Simulator Routine Revisions","description":"Retrieve one or more simulator routine revisions by IDs or external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/routines/revisions/byids","href":"/20230101-beta/simulator-routines/retrieve-simulator-routine-revisions","autogeneratedByOpenApi":true}]},{"group":"Simulation runs","pages":[{"title":"Simulation Runs","sidebarTitle":"Overview","description":"Execute and monitor simulation runs in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/simulation-runs"},{"title":"Run Simulation","description":"Request to run a simulator routine asynchronously.\n\nThe total size of the request body can be a maximum of 50.00 KB.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/run","href":"/20230101-beta/simulation-runs/run-simulation","autogeneratedByOpenApi":true},{"title":"Filter Simulation Runs","description":"Retrieves a list of simulation runs that match the given criteria.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/runs/list","href":"/20230101-beta/simulation-runs/filter-simulation-runs","autogeneratedByOpenApi":true},{"title":"Retrieve Simulation","description":"Retrieve a simulation run by ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/runs/byids","href":"/20230101-beta/simulation-runs/retrieve-simulation","autogeneratedByOpenApi":true},{"title":"Retrieve Simulation Data","description":"Retrieve data associated with a simulation run by ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/runs/data/list","href":"/20230101-beta/simulation-runs/retrieve-simulation-data","autogeneratedByOpenApi":true}]},{"group":"Simulator logs","pages":[{"title":"Simulator Logs","sidebarTitle":"Overview","description":"Retrieve simulator logs in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/simulator-logs"},{"title":"Retrieve Simulator Logs","description":"Retrieve one or more simulator logs by IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /simulators/logs/byids","href":"/20230101-beta/simulator-logs/retrieve-simulator-logs","autogeneratedByOpenApi":true}]}]},{"group":"Units","pages":[{"title":"Units","sidebarTitle":"Overview","description":"Access the units catalog and unit systems in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/units-overview"},{"group":"Units","pages":[{"title":"Units","sidebarTitle":"Overview","description":"Access the units catalog in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/units"},{"title":"List all units","description":"List all units.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /units","href":"/20230101-beta/units/list-all-units","autogeneratedByOpenApi":true},{"title":"Retrieve unit by external ID","description":"Retrieve a single unit by its external ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /units/{externalId}","href":"/20230101-beta/units/retrieve-unit-by-external-id","autogeneratedByOpenApi":true},{"title":"Retrieve units by external IDs","description":"Retrieves one or more units by external ID. The response returns the units in the same order as in the request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /units/byids","href":"/20230101-beta/units/retrieve-units-by-external-ids","autogeneratedByOpenApi":true}]},{"group":"Unit systems","pages":[{"title":"Unit Systems","sidebarTitle":"Overview","description":"Access unit systems in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/unit-systems"},{"title":"List all unit systems","description":"List all unit systems.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /units/systems","href":"/20230101-beta/unit-systems/list-all-unit-systems","autogeneratedByOpenApi":true}]}]}]},{"group":"Legacy","icon":"archive","expanded":true,"pages":[{"group":"Legacy data modeling","pages":[{"title":"Asset-centric data modeling (legacy)","sidebarTitle":"Overview","description":"This is the original CDF approach, where data is organized around a hierarchy of physical equipment (assets). While fully supported for existing solutions, it lacks the flexibility of data modeling for the knowledge graph.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","applicable-to":["asset-centric"],"article-type":"article","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/asset-centric"},{"group":"Assets","pages":[{"title":"Assets","sidebarTitle":"Overview","description":"Manage assets in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/assets"},{"title":"Aggregate assets","description":"Aggregates assets. Requires `assetsAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/assets#aggregates).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /assets/aggregate","href":"/20230101-beta/assets/aggregate-assets","autogeneratedByOpenApi":true},{"title":"Create assets","description":"Creates assets. Requires `assetsAcl:WRITE`. See [Assets](/api-reference/concepts/20230101/assets).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /assets","href":"/20230101-beta/assets/create-assets","autogeneratedByOpenApi":true},{"title":"Delete assets","description":"Deletes assets. Set `recursive` to true to delete descendants. Requires `assetsAcl:WRITE`. See [Delete assets](/api-reference/concepts/20230101/assets#delete-assets).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /assets/delete","href":"/20230101-beta/assets/delete-assets","autogeneratedByOpenApi":true},{"title":"Filter assets","description":"Lists assets that match a filter. This endpoint is for exploration. Requires `assetsAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/assets#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /assets/list","href":"/20230101-beta/assets/filter-assets","autogeneratedByOpenApi":true},{"title":"List assets","description":"Lists assets in the project. This endpoint is for exploration. Requires `assetsAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/assets#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /assets","href":"/20230101-beta/assets/list-assets","autogeneratedByOpenApi":true},{"title":"Retrieve an asset by its ID","description":"Retrieves an asset by internal ID. Requires `assetsAcl:READ`. See [Assets](/api-reference/concepts/20230101/assets).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /assets/{id}","href":"/20230101-beta/assets/retrieve-an-asset-by-its-id","autogeneratedByOpenApi":true},{"title":"Retrieve assets","description":"Retrieves assets by internal or external ID. Requires `assetsAcl:READ`. See [Assets](/api-reference/concepts/20230101/assets).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /assets/byids","href":"/20230101-beta/assets/retrieve-assets","autogeneratedByOpenApi":true},{"title":"Search assets","description":"Searches assets by relevance. Matching and order can change, and the operation does not paginate. Requires `assetsAcl:READ`. See [Sorting](/api-reference/concepts/20230101/assets#sorting).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /assets/search","href":"/20230101-beta/assets/search-assets","autogeneratedByOpenApi":true},{"title":"Update assets","description":"\n\n> **Required capabilities:** `assetsAcl:WRITE`\n\nUpdate the attributes of assets.\n\n### Request throttling\nThis endpoint is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Assets resource description](../../) for more information.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /assets/update","href":"/20230101-beta/assets/update-assets","autogeneratedByOpenApi":true}]},{"group":"Time series metadata","pages":[{"title":"Time series","sidebarTitle":"Overview","description":"Manage time series data in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["asset-centric"],"api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/time-series"},{"title":"Aggregate time series","description":"Aggregates time series. Requires `timeSeriesAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/time-series#aggregates).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/aggregate","href":"/20230101-beta/time-series/aggregate-time-series","autogeneratedByOpenApi":true},{"title":"Create time series","description":"\n\n> **Required capabilities:** `timeSeriesAcl:WRITE`\n\nCreates one or more time series.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries","href":"/20230101-beta/time-series/create-time-series","autogeneratedByOpenApi":true},{"title":"Delete time series","description":"\n\n> **Required capabilities:** `timeSeriesAcl:WRITE`\n\nDeletes the time series with the specified IDs and their data points.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/delete","href":"/20230101-beta/time-series/delete-time-series","autogeneratedByOpenApi":true},{"title":"Filter time series","description":"Lists time series that match a filter. This endpoint is for exploration. Requires `timeSeriesAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/time-series#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/list","href":"/20230101-beta/time-series/filter-time-series","autogeneratedByOpenApi":true},{"title":"List time series","description":"\n\n> **Required capabilities:** `timeSeriesAcl:READ`\n\nList time series. Use `nextCursor` to paginate through the results.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /timeseries","href":"/20230101-beta/time-series/list-time-series","autogeneratedByOpenApi":true},{"title":"Retrieve time series","description":"\n\n> **Required capabilities:** `timeSeriesAcl:READ`\n\nRetrieves one or more time series by ID or external ID. The response returns the time series in the same order as in the request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/byids","href":"/20230101-beta/time-series/retrieve-time-series","autogeneratedByOpenApi":true},{"title":"Search time series","description":"Searches time series by relevance. Requires `timeSeriesAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/time-series#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/search","href":"/20230101-beta/time-series/search-time-series","autogeneratedByOpenApi":true},{"title":"Update time series","description":"Updates time series. Requires `timeSeriesAcl:WRITE`. See [Time series](/api-reference/concepts/20230101/time-series).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /timeseries/update","href":"/20230101-beta/time-series/update-time-series","autogeneratedByOpenApi":true}]},{"group":"Events","pages":[{"title":"Events","sidebarTitle":"Overview","description":"Manage events in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/events"},{"title":"Aggregate events","description":"Aggregates events. Requires `eventsAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/events#aggregates).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /events/aggregate","href":"/20230101-beta/events/aggregate-events","autogeneratedByOpenApi":true},{"title":"Create events","description":"Creates events. Requires `eventsAcl:WRITE`. See [Events](/api-reference/concepts/20230101/events).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /events","href":"/20230101-beta/events/create-events","autogeneratedByOpenApi":true},{"title":"Delete events","description":"Deletes up to 1000 events. Requires `eventsAcl:WRITE`. See [Delete events](/api-reference/concepts/20230101/events#delete-events).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /events/delete","href":"/20230101-beta/events/delete-events","autogeneratedByOpenApi":true},{"title":"Filter events","description":"Lists events that match a filter. This endpoint is for exploration. Requires `eventsAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/events#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /events/list","href":"/20230101-beta/events/filter-events","autogeneratedByOpenApi":true},{"title":"List events","description":"\n\n> **Required capabilities:** `eventsAcl:READ`\n\nList events optionally filtered on query parameters\n\n### Request throttling\nThis endpoint is meant for data analytics/exploration usage and is not suitable for high load data retrieval usage.\nIt is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Events resource description](../../) for more information.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /events","href":"/20230101-beta/events/list-events","autogeneratedByOpenApi":true},{"title":"Receive an event by its ID","description":"\n\n> **Required capabilities:** `eventsAcl:READ`\n\nRetrieves an event by its internal (service-generated) ID.\n\n### Request throttling\nThis endpoint is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Events resource description](../../) for more information.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /events/{id}","href":"/20230101-beta/events/receive-an-event-by-its-id","autogeneratedByOpenApi":true},{"title":"Retrieve events","description":"Retrieves events by internal or external ID. Requires `eventsAcl:READ`. See [Events](/api-reference/concepts/20230101/events).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /events/byids","href":"/20230101-beta/events/retrieve-events","autogeneratedByOpenApi":true},{"title":"Search events","description":"Searches events by relevance. Matching and order can change, and the operation does not paginate. Requires `eventsAcl:READ`. See [Sorting](/api-reference/concepts/20230101/events#sorting).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /events/search","href":"/20230101-beta/events/search-events","autogeneratedByOpenApi":true},{"title":"Update events","description":"Partially updates up to 1000 events. Requires `eventsAcl:WRITE`. See [Update events](/api-reference/concepts/20230101/events#update-events).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /events/update","href":"/20230101-beta/events/update-events","autogeneratedByOpenApi":true}]},{"group":"File metadata","pages":[{"title":"Files","sidebarTitle":"Overview","description":"Manage files in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["asset-centric"],"api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/files"},{"title":"Aggregate files","description":"Counts files that match a filter. Requires `filesAcl:READ`. See [Files](/api-reference/concepts/20230101/files).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /files/aggregate","href":"/20230101-beta/files/aggregate-files","autogeneratedByOpenApi":true},{"title":"Upload file","description":"Creates file metadata and returns an upload URL. Requires `filesAcl:WRITE`. See [Upload limits](/api-reference/concepts/20230101/file-content#upload-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /files","href":"/20230101-beta/files/upload-file","autogeneratedByOpenApi":true},{"title":"Delete files","description":"Deletes up to 1000 files. Requires `filesAcl:WRITE`. See [Delete files](/api-reference/concepts/20230101/files#delete-files).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /files/delete","href":"/20230101-beta/files/delete-files","autogeneratedByOpenApi":true},{"title":"Filter files","description":"Lists files that match a filter. This endpoint is for exploration. Requires `filesAcl:READ`. See [Files](/api-reference/concepts/20230101/files).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /files/list","href":"/20230101-beta/files/filter-files","autogeneratedByOpenApi":true},{"title":"List files","description":"Lists files in the project. This endpoint is for exploration. Requires `filesAcl:READ`. See [Files](/api-reference/concepts/20230101/files).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /files","href":"/20230101-beta/files/list-files","autogeneratedByOpenApi":true},{"title":"Retrieve a file by its ID","description":"Retrieves file metadata by internal ID. Requires `filesAcl:READ`, or data modeling read. See [Files](/api-reference/concepts/20230101/files).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /files/{id}","href":"/20230101-beta/files/retrieve-a-file-by-its-id","autogeneratedByOpenApi":true},{"title":"Retrieve files","description":"Retrieves file metadata for the requested IDs, in request order. Requires `filesAcl:READ`, or data modeling read. See [Files](/api-reference/concepts/20230101/files).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /files/byids","href":"/20230101-beta/files/retrieve-files","autogeneratedByOpenApi":true},{"title":"Search files","description":"Searches files by relevance and returns at most 1000 matches. Requires `filesAcl:READ`. See [Search](/api-reference/concepts/20230101/files#search).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /files/search","href":"/20230101-beta/files/search-files","autogeneratedByOpenApi":true},{"title":"Update files","description":"Updates file metadata. Replace content with init upload and `overwrite=true`. Requires `filesAcl:WRITE`. See [Update metadata](/api-reference/concepts/20230101/files#update-metadata).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /files/update","href":"/20230101-beta/files/update-files","autogeneratedByOpenApi":true}]},{"group":"Sequences","pages":[{"title":"Sequences","sidebarTitle":"Overview","description":"Manage sequences in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/sequences"},{"title":"Aggregate sequences","description":"Aggregates sequences. Requires `sequencesAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/sequences#aggregates).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /sequences/aggregate","href":"/20230101-beta/sequences/aggregate-sequences","autogeneratedByOpenApi":true},{"title":"Create sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nCreate one or more sequences.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /sequences","href":"/20230101-beta/sequences/create-sequences","autogeneratedByOpenApi":true},{"title":"Delete rows","description":"\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nDeletes the given rows of the sequence. All columns are affected.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /sequences/data/delete","href":"/20230101-beta/sequences/delete-rows","autogeneratedByOpenApi":true},{"title":"Delete sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nDeletes the sequences with the specified IDs. If one or more of the sequences do not exist, the `ignoreUnknownIds` parameter controls what will happen: if it is `true`, the sequences that do exist will be deleted, and the request succeeds; if it is `false` or absent, nothing will be deleted, and the request fails.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /sequences/delete","href":"/20230101-beta/sequences/delete-sequences","autogeneratedByOpenApi":true},{"title":"Filter sequences","description":"Lists sequences that match a filter. This endpoint is for exploration. Requires `sequencesAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/sequences#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /sequences/list","href":"/20230101-beta/sequences/filter-sequences","autogeneratedByOpenApi":true},{"title":"Insert rows","description":"\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nInserts rows into a sequence. This overwrites data in rows and columns that exist.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /sequences/data","href":"/20230101-beta/sequences/insert-rows","autogeneratedByOpenApi":true},{"title":"List sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nList sequences. Use `nextCursor` to paginate through the results.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /sequences","href":"/20230101-beta/sequences/list-sequences","autogeneratedByOpenApi":true},{"title":"Retrieve last row","description":"\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nRetrieves the last row in one or more sequences. Note that the last row in a sequence is the\none with the highest row number, which is not necessarily the one that was ingested most\nrecently.\n","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /sequences/data/latest","href":"/20230101-beta/sequences/retrieve-last-row","autogeneratedByOpenApi":true},{"title":"Retrieve rows","description":"\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nProcesses data requests and returns the result. Note that this operation uses a dynamic limit on the number of rows returned based on the number and type of columns; use the provided cursor to paginate and retrieve all data.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /sequences/data/list","href":"/20230101-beta/sequences/retrieve-rows","autogeneratedByOpenApi":true},{"title":"Retrieve sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nRetrieves one or more sequences by ID or external ID. The response returns the sequences in the same order as in the request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /sequences/byids","href":"/20230101-beta/sequences/retrieve-sequences","autogeneratedByOpenApi":true},{"title":"Search sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nRetrieves a list of sequences matching the given criteria. This operation doesn't support pagination.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /sequences/search","href":"/20230101-beta/sequences/search-sequences","autogeneratedByOpenApi":true},{"title":"Update sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nUpdates one or more sequences. Fields outside of the request remain unchanged.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /sequences/update","href":"/20230101-beta/sequences/update-sequences","autogeneratedByOpenApi":true}]},{"group":"Data sets","pages":[{"title":"Data sets","sidebarTitle":"Overview","description":"Organize and govern data with data sets in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/data-sets"},{"title":"Create data sets","description":"\n\n> **Required capabilities:** `datasetsAcl:WRITE`\n\nYou can create a maximum of 10 data sets per request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /datasets","href":"/20230101-beta/data-sets/create-data-sets","autogeneratedByOpenApi":true},{"title":"Aggregate data sets","description":"\n\n> **Required capabilities:** `datasetsAcl:READ`\n\nAggregate data sets in the same project. Criteria can be applied to select a subset of data sets.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /datasets/aggregate","href":"/20230101-beta/data-sets/aggregate-data-sets","autogeneratedByOpenApi":true},{"title":"Filter data sets","description":"\n\n> **Required capabilities:** `datasetsAcl:READ`\n\nUse advanced filtering options to find data sets.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /datasets/list","href":"/20230101-beta/data-sets/filter-data-sets","autogeneratedByOpenApi":true},{"title":"Retrieve data sets","description":"\n\n> **Required capabilities:** `datasetsAcl:READ`\n\nRetrieve data sets by IDs or external IDs.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /datasets/byids","href":"/20230101-beta/data-sets/retrieve-data-sets","autogeneratedByOpenApi":true},{"title":"Update data sets.","description":"\n\n> **Required capabilities:** `datasetsAcl:WRITE`\n","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /datasets/update","href":"/20230101-beta/data-sets/update-data-sets","autogeneratedByOpenApi":true}]},{"group":"Labels","pages":[{"title":"Labels","sidebarTitle":"Overview","description":"Create and manage labels in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/labels"},{"title":"Create label definitions.","description":"\n\n> **Required capabilities:** `labelsAcl:WRITE`\n\nCreates label definitions that can be used across different resource types. The label definitions are uniquely identified by their external id.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /labels","href":"/20230101-beta/labels/create-label-definitions","autogeneratedByOpenApi":true},{"title":"Filter labels","description":"\n\n> **Required capabilities:** `labelsAcl:READ`\n\nUse advanced filtering options to find label definitions.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /labels/list","href":"/20230101-beta/labels/filter-labels","autogeneratedByOpenApi":true},{"title":"Retrieve labels","description":"\n\n> **Required capabilities:** `labelsAcl:READ`\n\nRetrieve labels using their external ids","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /labels/byids","href":"/20230101-beta/labels/retrieve-labels","autogeneratedByOpenApi":true},{"title":"Delete label definitions.","description":"\n\n> **Required capabilities:** `labelsAcl:WRITE`\n\nDelete all the label definitions specified by their external ids. The resource items that have the corresponding label attached remain unmodified. It is up to the client to clean up the resource items from their attached labels if necessary.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /labels/delete","href":"/20230101-beta/labels/delete-label-definitions","autogeneratedByOpenApi":true}]},{"group":"Relationships","pages":[{"title":"Relationships","sidebarTitle":"Overview","description":"Create and manage relationships between resources in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/relationships"},{"title":"Create relationships","description":"Creates up to 1000 relationships. `externalId` must be unique. Requires `relationshipsAcl:WRITE`. See [Create and update](/api-reference/concepts/20230101/relationships#create-and-update).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /relationships","href":"/20230101-beta/relationships/create-relationships","autogeneratedByOpenApi":true},{"title":"Delete relationships","description":"\n\n> **Required capabilities:** `relationshipsAcl:WRITE`\n\nDelete the relationships between resources identified by the external IDs in the request. You can delete a maximum of 1000 relationships per request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /relationships/delete","href":"/20230101-beta/relationships/delete-relationships","autogeneratedByOpenApi":true},{"title":"Filter relationships","description":"\n\n> **Required capabilities:** `relationshipsAcl:READ`\n\nLists relationships matching the query filter in the request. You can retrieve a maximum of 1000 relationships per request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /relationships/list","href":"/20230101-beta/relationships/filter-relationships","autogeneratedByOpenApi":true},{"title":"List relationships","description":"\n\n> **Required capabilities:** `relationshipsAcl:READ`\n\nLists all relationships. The order of retrieved objects may change for two calls with the same parameters.\nThe endpoint supports pagination. The initial call to this endpoint should not contain a cursor, but the cursor parameter should be used to retrieve further pages of results.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /relationships","href":"/20230101-beta/relationships/list-relationships","autogeneratedByOpenApi":true},{"title":"Retrieve relationships","description":"\n\n> **Required capabilities:** `relationshipsAcl:READ`\n\nRetrieve relationships by external IDs. You can retrieve a maximum of 1000 relationships per request.\nThe order of the relationships in the response equals the order in the request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /relationships/byids","href":"/20230101-beta/relationships/retrieve-relationships","autogeneratedByOpenApi":true},{"title":"Update relationships","description":"Partially updates up to 1000 relationships. Requires `relationshipsAcl:WRITE` and `relationshipsAcl:READ`. See [Create and update](/api-reference/concepts/20230101/relationships#create-and-update).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /relationships/update","href":"/20230101-beta/relationships/update-relationships","autogeneratedByOpenApi":true}]},{"group":"Annotations","pages":[{"title":"Annotations","sidebarTitle":"Overview","description":"Create and manage annotations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/annotations"},{"title":"Create annotations","description":"Creates annotations on resources you can read. Requires `annotationsAcl:WRITE`. See [Create annotations](/api-reference/concepts/20230101/annotations#create-annotations).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /annotations","href":"/20230101-beta/annotations/create-annotations","autogeneratedByOpenApi":true},{"title":"Suggest annotations","description":"Creates annotations with status `suggested`. Requires `annotationsAcl:SUGGEST`. See [Create annotations](/api-reference/concepts/20230101/annotations#create-annotations).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /annotations/suggest","href":"/20230101-beta/annotations/suggest-annotations","autogeneratedByOpenApi":true},{"title":"Get an annotation","description":"Retrieves the referenced annotation.\n\nThe caller _must_ have read-access on the **annotated resource**, otherwise the call will fail.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /annotations/{annotationId}","href":"/20230101-beta/annotations/get-an-annotation","autogeneratedByOpenApi":true},{"title":"Filter annotations","description":"Lists the annotations the caller has access to, based on a filter.\n\nThe caller _must_ have read-access on the **annotated resources** listed in the filter, otherwise the call will\nfail.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /annotations/list","href":"/20230101-beta/annotations/filter-annotations","autogeneratedByOpenApi":true},{"title":"Reverse lookup","description":"Returns annotated files or 3D resources that match a filter. Requires `annotationsAcl:WRITE`. See [Reverse lookup](/api-reference/concepts/20230101/annotations#reverse-lookup).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /annotations/reverselookup","href":"/20230101-beta/annotations/reverse-lookup","autogeneratedByOpenApi":true},{"title":"Retrieve annotations","description":"Retrieves the referenced annotations.\n\nThe caller _must_ have read-access on all the **annotated resources**, otherwise the call will fail.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /annotations/byids","href":"/20230101-beta/annotations/retrieve-annotations","autogeneratedByOpenApi":true},{"title":"Delete annotations","description":"\n\n> **Required capabilities:** `annotationsAcl:WRITE`\n\nDeletes the referenced annotations completely.\n\nThe caller _must_ have read-access on all the **annotated resources**, otherwise the call will fail.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /annotations/delete","href":"/20230101-beta/annotations/delete-annotations","autogeneratedByOpenApi":true},{"title":"Update annotations","description":"\n\n> **Required capabilities:** `annotationsAcl:WRITE`\n\nUpdates the referenced annotations.\n\nThe caller _must_ have read-access on all the **annotated resources**, otherwise the call will fail.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /annotations/update","href":"/20230101-beta/annotations/update-annotations","autogeneratedByOpenApi":true}]},{"group":"Geospatial","pages":[{"title":"Geospatial","sidebarTitle":"Overview","description":"Manage geospatial data in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-beta","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-beta/geospatial"},{"title":"Aggregate features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nSearch for features based on the feature property filter and perform requested aggregations on a given property. Aggregations are supported for all filters that do not contain `stWithin`, `stWithinProperly`, `stContains` and `stContainsProperly` search in 3D geometries.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/featuretypes/{featureTypeExternalId}/features/aggregate","href":"/20230101-beta/geospatial/aggregate-features","autogeneratedByOpenApi":true},{"title":"Compute","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialCrsAcl:READ`\n\nCompute custom json output structures or well known binary format responses based on calculation or selection of feature properties or direct values given in the request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/compute","href":"/20230101-beta/geospatial/compute","autogeneratedByOpenApi":true},{"title":"Create Coordinate Reference Systems","description":"\n\n> **Required capabilities:** `geospatialCrsAcl:WRITE`\n\nCreates custom Coordinate Reference Systems.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/crs","href":"/20230101-beta/geospatial/create-coordinate-reference-systems","autogeneratedByOpenApi":true},{"title":"Create feature types","description":"\n\n> **Required capabilities:** `geospatialAcl:WRITE`\n\nCreates feature types. Each tenant can have up to 100 feature types.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/featuretypes","href":"/20230101-beta/geospatial/create-feature-types","autogeneratedByOpenApi":true},{"title":"Create features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nCreate features","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/featuretypes/{featureTypeExternalId}/features","href":"/20230101-beta/geospatial/create-features","autogeneratedByOpenApi":true},{"title":"Delete Coordinate Reference Systems","description":"\n\n> **Required capabilities:** `geospatialCrsAcl:WRITE`\n\nDelete custom Coordinate Reference Systems.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/crs/delete","href":"/20230101-beta/geospatial/delete-coordinate-reference-systems","autogeneratedByOpenApi":true},{"title":"Delete feature types","description":"\n\n> **Required capabilities:** `geospatialAcl:WRITE`\n\nDelete feature types.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/featuretypes/delete","href":"/20230101-beta/geospatial/delete-feature-types","autogeneratedByOpenApi":true},{"title":"Delete features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nDelete features.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/featuretypes/{featureTypeExternalId}/features/delete","href":"/20230101-beta/geospatial/delete-features","autogeneratedByOpenApi":true},{"title":"Delete a raster from a feature property","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nDelete a raster from a feature property. If there is no raster already, the operation is a no-op.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/featuretypes/{featureTypeExternalId}/features/{featureExternalId}/rasters/{rasterPropertyName}/delete","href":"/20230101-beta/geospatial/delete-a-raster-from-a-feature-property","autogeneratedByOpenApi":true},{"title":"Get Coordinate Reference Systems","description":"\n\n> **Required capabilities:** `geospatialCrsAcl:READ`\n\nGet Coordinate Reference Systems by their Spatial Reference IDs","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/crs/byids","href":"/20230101-beta/geospatial/get-coordinate-reference-systems","autogeneratedByOpenApi":true},{"title":"Get features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nGet features with paging support","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json get /geospatial/featuretypes/{featureTypeExternalId}/features","href":"/20230101-beta/geospatial/get-features","autogeneratedByOpenApi":true},{"title":"List feature types","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nList all feature types","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/featuretypes/list","href":"/20230101-beta/geospatial/list-feature-types","autogeneratedByOpenApi":true},{"title":"Put a raster into a feature property","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nPut a raster into a feature property. The feature property must be of type RASTER.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json put /geospatial/featuretypes/{featureTypeExternalId}/features/{featureExternalId}/rasters/{rasterPropertyName}","href":"/20230101-beta/geospatial/put-a-raster-into-a-feature-property","autogeneratedByOpenApi":true},{"title":"Get a raster from a feature property","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nGet a raster from a feature property. The feature property must be of type RASTER.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/featuretypes/{featureTypeExternalId}/features/{featureExternalId}/rasters/{rasterPropertyName}","href":"/20230101-beta/geospatial/get-a-raster-from-a-feature-property","autogeneratedByOpenApi":true},{"title":"Retrieve feature types","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nRetrieves feature types by external ids. It is possible to retrieve up to 100 items per request, i.e. the maximum number of feature types for a tenant.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/featuretypes/byids","href":"/20230101-beta/geospatial/retrieve-feature-types","autogeneratedByOpenApi":true},{"title":"Retrieve features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nRetrieves features by external ids. It is possible to retrieve up to 1000 items per request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/featuretypes/{featureTypeExternalId}/features/byids","href":"/20230101-beta/geospatial/retrieve-features","autogeneratedByOpenApi":true},{"title":"Search and stream features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nSearch for features based on the feature property filter passed in the body of the request. The streaming response format can be length prefixed, new line delimited, record separator delimited or concatenated depending on requested output (see https://en.wikipedia.org/wiki/JSON_streaming).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/featuretypes/{featureTypeExternalId}/features/search-streaming","href":"/20230101-beta/geospatial/search-and-stream-features","autogeneratedByOpenApi":true},{"title":"Search features","description":"Searches features. The response contains at most 1000 items. Requires `geospatialAcl:READ`. See [Search results](/api-reference/concepts/20230101/geospatial#search-results).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/featuretypes/{featureTypeExternalId}/features/search","href":"/20230101-beta/geospatial/search-features","autogeneratedByOpenApi":true},{"title":"Update feature types","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nUpdate one or more feature types","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/featuretypes/update","href":"/20230101-beta/geospatial/update-feature-types","autogeneratedByOpenApi":true},{"title":"Update features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nUpdate features. This is a replace operation, i.e., all feature properties have to be sent in the request body even if their values do not change.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/featuretypes/{featureTypeExternalId}/features/update","href":"/20230101-beta/geospatial/update-features","autogeneratedByOpenApi":true},{"title":"Filter all features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nList features based on the feature property filter passed in the body of the request. This operation supports pagination by cursor.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /geospatial/featuretypes/{featureTypeExternalId}/features/list","href":"/20230101-beta/geospatial/filter-all-features","autogeneratedByOpenApi":true}]}]}]}]}]},{"item":"Alpha (20230101-alpha)","description":"Experimental API operations","groups":[{"group":"API reference (20230101-alpha)","boost":0.25,"pages":[{"group":"Foundation","icon":"building-2","expanded":true,"pages":[{"group":"Introduction","icon":"book","expanded":true,"pages":[{"title":"Cognite API introduction","sidebarTitle":"Introduction","description":"How to call the Cognite Data Fusion REST API: URLs, calendar versioning, Postman, pagination, and throttling.","content-type":"reference","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/api-description"},{"title":"API rate limits","sidebarTitle":"Rate limits","description":"Rate and concurrency limits for Cognite Data Fusion (CDF) API endpoints.","content-type":"reference","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/rate-limits"},{"title":"Cognite API changelog","sidebarTitle":"Changelog","description":"Track all notable changes, updates, and deprecations for the Cognite Data Fusion (CDF) API v1, organized by release date and API area.","content-type":"reference","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/changelog"}]},{"group":"Metering","pages":[{"title":"Metering","sidebarTitle":"Overview","description":"List meters and retrieve meter metadata or consumption data for a project in the alpha Cognite Data Fusion API.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/metering"},{"title":"List all meters","description":"\n\n> **Required capabilities:** `projectsAcl:LIST`\n\nLists all available meter IDs for a specific project.\n\n- Without `start` and `numberOfDatapoints`: Returns meter metadata.\n- With `start` and `numberOfDatapoints`: Returns historical time-series data with averaged values.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /metering/meters","href":"/20230101-alpha/metering/list-all-meters","autogeneratedByOpenApi":true},{"title":"Retrieve multiple consumption data by their ids","description":"\n\n> **Required capabilities:** `projectsAcl:LIST`\n\nRetrieves multiple consumption data items by their IDs.\n\n- Without `start` and `numberOfDatapoints`: Returns meter metadata.\n- With `start` and `numberOfDatapoints`: Returns historical time-series data with averaged values.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /metering/meters/byids","href":"/20230101-alpha/metering/retrieve-multiple-consumption-data-by-their-ids","autogeneratedByOpenApi":true},{"title":"Filter meters","description":"\n\n> **Required capabilities:** `projectsAcl:LIST`\n\nLists meter IDs using a filter.\n\n- Without `start` and `numberOfDatapoints`: Returns meter metadata.\n- With `start` and `numberOfDatapoints`: Returns historical time-series data with averaged values.\n\nOnly the `prefix` filter operator is supported.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /metering/meters/list","href":"/20230101-alpha/metering/filter-meters","autogeneratedByOpenApi":true},{"title":"Retrieve consumption data by its id","description":"\n\n> **Required capabilities:** `projectsAcl:LIST`\n\nRetrieves consumption data by its `meterId`.\n\n- Without `start` and `numberOfDatapoints`: Returns meter metadata.\n- With `start` and `numberOfDatapoints`: Returns historical time-series data with averaged values.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /metering/meters/{meterId}","href":"/20230101-alpha/metering/retrieve-consumption-data-by-its-id","autogeneratedByOpenApi":true}]},{"group":"Limits","pages":[{"title":"Limits API","sidebarTitle":"Overview","description":"List and retrieve limit value resources in Cognite Data Fusion, distinct from HTTP request rate limits and throttling.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/limits-api"},{"title":"List all limit values","description":"\n\n> **Required capabilities:** `projectsAcl:LIST`\n\nRetrieves all limit values for a specific project.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /limits/values","href":"/20230101-alpha/limits/list-all-limit-values","autogeneratedByOpenApi":true},{"title":"Advanced list of limit values.","description":"\n\n> **Required capabilities:** `projectsAcl:LIST`\n\nRetrieves limit values using a filter.\n\nOnly the `prefix` operator is supported.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /limits/values/list","href":"/20230101-alpha/limits/advanced-list-of-limit-values","autogeneratedByOpenApi":true},{"title":"Retrieve a limit value by its id","description":"\n\n> **Required capabilities:** `projectsAcl:LIST`\n\nRetrieves a limit value by its `limitId`.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /limits/values/{limitId}","href":"/20230101-alpha/limits/retrieve-a-limit-value-by-its-id","autogeneratedByOpenApi":true}]},{"group":"Organizations and projects","pages":[{"title":"Organizations and projects","sidebarTitle":"Overview","description":"Manage organizations and projects in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/organizations-and-projects"},{"group":"Organizations","pages":[{"title":"Organizations","sidebarTitle":"Overview","description":"Manage organizations, projects, and external identity providers (IdPs).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/organizations"},{"title":"Create an organization","description":"Creates a child organization. Requires an admin and `adminsCanCreateOrgsInSubtree`. See [Create a child organization](/api-reference/concepts/20230101/organizations#create-a-child-organization).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /api/v1/orgs/{org}/orgs","href":"/20230101-alpha/organizations/create-an-organization","autogeneratedByOpenApi":true},{"title":"Delete an organization","description":"Soft-deletes an organization with no children and no projects. Requires an admin of the organization or an ancestor. See [Delete an organization](/api-reference/concepts/20230101/organizations#delete-an-organization).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /api/v1/orgs/{org}/delete","href":"/20230101-alpha/organizations/delete-an-organization","autogeneratedByOpenApi":true},{"title":"List child organizations","description":"Lists child organizations. Requires an admin of the parent or an ancestor. See [Create a child organization](/api-reference/concepts/20230101/organizations#create-a-child-organization).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /api/v1/orgs/{org}/orgs","href":"/20230101-alpha/organizations/list-child-organizations","autogeneratedByOpenApi":true},{"title":"Retrieve an organization","description":"Retrieves an organization. Requires an admin of the organization or an ancestor. See [Organizations](/api-reference/concepts/20230101/organizations).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /api/v1/orgs/{org}","href":"/20230101-alpha/organizations/retrieve-an-organization","autogeneratedByOpenApi":true}]},{"group":"Projects","pages":[{"title":"Projects","sidebarTitle":"Overview","description":"Manage projects in an organization.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/projects"},{"title":"Create a project","description":"Creates a project on an allowed cluster. Requires an admin and `adminsCanCreateProjectsInSubtree`. See [Create a project](/api-reference/concepts/20230101/projects#create-a-project).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /api/v1/orgs/{org}/projects","href":"/20230101-alpha/projects/create-a-project","autogeneratedByOpenApi":true},{"title":"List projects in an organization","description":"Lists projects in an organization. Admin properties require an admin. See [List projects](/api-reference/concepts/20230101/projects#list-projects).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /api/v1/orgs/{org}/projects","href":"/20230101-alpha/projects/list-projects-in-an-organization","autogeneratedByOpenApi":true}]}]},{"group":"Identity and access management","pages":[{"title":"Identity and access management","sidebarTitle":"Overview","description":"Manage principals, groups, security categories, sessions, and tokens in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/identity-and-access-management"},{"group":"Principals","pages":[{"title":"Principals","sidebarTitle":"Overview","description":"Understanding user accounts and service accounts.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/principals"},{"title":"Get the current caller's information","description":"Retrieves the information of the principal issuing the request.\n\nThis endpoint is useful for clients to verify their own identity.\nAll authenticated principals can call this endpoint.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /api/v1/principals/me","href":"/20230101-alpha/principals/get-the-current-callers-information","autogeneratedByOpenApi":true},{"title":"List login sessions","description":"Lists login sessions for a user. Requires an admin of that organization. See [Login sessions](/api-reference/concepts/20230101/principals#login-sessions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /api/v1/orgs/{org}/principals/{principal}/sessions","href":"/20230101-alpha/principals/list-login-sessions","autogeneratedByOpenApi":true},{"title":"List principals","description":"List principals in an organization.\n\nAll principal types are supported.\n\n#### Access control\nRequires the caller to be logged into the target organization, or\nto be an admin in any of its the ancestor organizations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /api/v1/orgs/{org}/principals","href":"/20230101-alpha/principals/list-principals","autogeneratedByOpenApi":true},{"title":"Retrieve principals by reference","description":"Retrieves principals by ID. Service accounts can also be retrieved by external ID. See [Retrieve principals](/api-reference/concepts/20230101/principals#retrieve-principals).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /api/v1/orgs/{org}/principals/byids","href":"/20230101-alpha/principals/retrieve-principals-by-reference","autogeneratedByOpenApi":true},{"title":"Revoke login sessions","description":"Revokes login sessions for a user. The call is atomic and can take up to one hour. See [Login sessions](/api-reference/concepts/20230101/principals#login-sessions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /api/v1/orgs/{org}/principals/{principal}/sessions/revoke","href":"/20230101-alpha/principals/revoke-login-sessions","autogeneratedByOpenApi":true}]},{"group":"Groups","pages":[{"title":"Groups","sidebarTitle":"Overview","description":"Manage groups and group membership in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/groups"},{"title":"Create groups","description":"Creates groups and their capabilities. Members receive `userProfilesAcl:READ`. Requires `groupsAcl:CREATE`. See [Capabilities](/api-reference/concepts/20230101/groups#capabilities).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /groups","href":"/20230101-alpha/groups/create-groups","autogeneratedByOpenApi":true},{"title":"Delete groups","description":"\n\n> **Required capabilities:** `groupsAcl:DELETE`\n\nDeletes the groups with the given IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /groups/delete","href":"/20230101-alpha/groups/delete-groups","autogeneratedByOpenApi":true},{"title":"List groups","description":"\n\n> **Required capabilities:** `groupsAcl:LIST`\n\nRetrieves a list of groups the asking principal a member of. Principals with groups:list capability can optionally ask for all groups in a project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /groups","href":"/20230101-alpha/groups/list-groups","autogeneratedByOpenApi":true}]},{"group":"Security categories","pages":[{"title":"Security categories","sidebarTitle":"Overview","description":"Manage security categories in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/security-categories"},{"title":"Create security categories","description":"\n\n> **Required capabilities:** `securityCategoriesAcl:CREATE`\n\nCreates security categories with the given names. Duplicate names in the request are ignored.\nIf a security category with one of the provided names exists already, then the request will fail and no security categories are created.\n","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /securitycategories","href":"/20230101-alpha/security-categories/create-security-categories","autogeneratedByOpenApi":true},{"title":"Delete security categories","description":"\n\n> **Required capabilities:** `securityCategoriesAcl:DELETE`\n\nDeletes the security categories that match the provided IDs.\nIf any of the provided IDs does not belong to an existing security category, then the request will fail and no security categories are deleted.\n","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /securitycategories/delete","href":"/20230101-alpha/security-categories/delete-security-categories","autogeneratedByOpenApi":true},{"title":"List security categories","description":"\n\n> **Required capabilities:** `securityCategoriesAcl:LIST`\n\nRetrieves a list of all security categories for a project.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /securitycategories","href":"/20230101-alpha/security-categories/list-security-categories","autogeneratedByOpenApi":true}]},{"group":"Sessions","pages":[{"title":"Sessions","sidebarTitle":"Overview","description":"Manage sessions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/sessions"},{"title":"Create sessions","description":"\n\n> **Required capabilities:** `sessionsAcl:CREATE`\n\nCreate sessions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /sessions","href":"/20230101-alpha/sessions/create-sessions","autogeneratedByOpenApi":true},{"title":"List sessions","description":"\n\n> **Required capabilities:** `sessionsAcl:LIST`\n\nList all sessions in the current project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /sessions","href":"/20230101-alpha/sessions/list-sessions","autogeneratedByOpenApi":true},{"title":"Retrieve sessions with given IDs","description":"\n\n> **Required capabilities:** `sessionsAcl:LIST`\n\nRetrieves sessions with given IDs. The request will fail if any of the IDs does not belong to an existing session.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /sessions/byids","href":"/20230101-alpha/sessions/retrieve-sessions-with-given-ids","autogeneratedByOpenApi":true},{"title":"Revoke sessions","description":"\n\n> **Required capabilities:** `sessionsAcl:DELETE`\n\nRevoke access to a session. Revocation is idempotent.\nRevocation of a session may in some cases take up to 1 hour to take effect.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /sessions/revoke","href":"/20230101-alpha/sessions/revoke-sessions","autogeneratedByOpenApi":true}]},{"group":"Token","pages":[{"title":"Tokens","sidebarTitle":"Overview","description":"Manage tokens in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/tokens"},{"title":"Inspect","description":"\n\n> **Required capabilities:** `projectsAcl:LIST` `groupsAcl:LIST`\n\nInspect CDF access granted to an IdP issued token","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /token/inspect","href":"/20230101-alpha/token/inspect","autogeneratedByOpenApi":true}]},{"group":"User profiles","tag":"deprecated","pages":[{"title":"User profiles","sidebarTitle":"Overview","description":"Manage user profiles in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/user-profiles"},{"title":"(deprecated) Get the user profile of the principal issuing the request","description":"Returns the caller's profile. A new principal can receive 404 until the profile exists. Requires `userProfilesAcl:READ`. See [User profiles](/api-reference/concepts/20230101/user-profiles).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /profiles/me","href":"/20230101-alpha/user-profiles/deprecated-get-the-user-profile-of-the-principal-issuing-the-request","autogeneratedByOpenApi":true},{"title":"Get the user profile of the principal issuing the request","description":"Deprecated in favor of the new [endpoint](#tag/Principals/operation/getMe).\n\nRetrieves the user profile of the principal issuing the request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /principals/me","href":"/20230101-alpha/user-profiles/get-the-user-profile-of-the-principal-issuing-the-request","autogeneratedByOpenApi":true},{"title":"List all user profiles in the current project","description":"Lists user profiles. Deprecated. Use principals. Requires `userProfilesAcl:READ`. See [User profiles](/api-reference/concepts/20230101/user-profiles).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /profiles","href":"/20230101-alpha/user-profiles/list-all-user-profiles-in-the-current-project","autogeneratedByOpenApi":true},{"title":"Retrieve profiles by ID in the current project","description":"\n\n> **Required capabilities:** `userProfilesAcl:READ`\n\nDeprecated in favor of the [Retrieve principals](#tag/Principals/operation/getPrincipalsById) endpoint.\n\nRetrieve one or more user profiles indexed by the user identifier in the same CDF project.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /profiles/byids","href":"/20230101-alpha/user-profiles/retrieve-profiles-by-id-in-the-current-project","autogeneratedByOpenApi":true},{"title":"Search user profiles in the current project","description":"Searches user profiles. Deprecated. Matching can change, and the operation does not paginate. Requires `userProfilesAcl:READ`. See [User profiles](/api-reference/concepts/20230101/user-profiles).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /profiles/search","href":"/20230101-alpha/user-profiles/search-user-profiles-in-the-current-project","autogeneratedByOpenApi":true}]},{"group":"Applications","pages":[{"title":"Applications","sidebarTitle":"Overview","description":"Manage registered applications in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/applications"},{"title":"List applications","description":"List applications owned by an organization.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /api/v1/orgs/{org}/applications","href":"/20230101-alpha/applications/list-applications","autogeneratedByOpenApi":true},{"title":"Create applications","description":"Creates up to 10 applications in the organization. Alpha only. See [Create applications](/api-reference/concepts/20230101-alpha/applications#create-applications).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /api/v1/orgs/{org}/applications","href":"/20230101-alpha/applications/create-applications","autogeneratedByOpenApi":true},{"title":"Get application","description":"Retrieve a single application by ID.\n\nReturns 404 if the application does not exist or does not belong to the target organization.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /api/v1/orgs/{org}/applications/{clientId}","href":"/20230101-alpha/applications/get-application","autogeneratedByOpenApi":true},{"title":"Update applications","description":"Update one or more applications owned by an organization.\n\nReturns 404 if any application does not exist or does not belong to the target\norganization.\n\nUp to 10 applications can be updated per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /api/v1/orgs/{org}/applications/update","href":"/20230101-alpha/applications/update-applications","autogeneratedByOpenApi":true},{"title":"Delete applications","description":"Delete one or more applications.\n\nReturns 404 if any application does not exist or does not belong to the target\norganization.\n\nUp to 10 applications can be deleted per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /api/v1/orgs/{org}/applications/delete","href":"/20230101-alpha/applications/delete-applications","autogeneratedByOpenApi":true}]}]}]},{"group":"Core data","icon":"database","expanded":true,"pages":[{"group":"Data modeling","pages":[{"title":"Data modeling with the industrial knowledge graph","sidebarTitle":"Overview","description":"Use these APIs for all new projects. The data modeling service (DMS) offers the full power of the Cognite Data Fusion (CDF) Knowledge Graph, allowing you to model your industrial reality exactly as it is, connecting physical assets, processes, work orders, and more without rigid hierarchy limits.","keywords":"asset, assets, asset hierarchy, CogniteAsset, knowledge graph, data model","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","applicable-to":["data-modeling"],"article-type":"article","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/data-modeling"},{"group":"Data models","pages":[{"title":"Data models","sidebarTitle":"Overview","description":"Create and manage data models in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/data-models"},{"title":"Create or update data models","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nAdd or update (upsert) data models. For unchanged data model specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for models that remain unchanged.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/datamodels","href":"/20230101-alpha/data-models/create-or-update-data-models","autogeneratedByOpenApi":true},{"title":"Delete data models","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more data models. Currently limited to 100 models at a time. This does not delete the views, nor the containers they reference.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/datamodels/delete","href":"/20230101-alpha/data-models/delete-data-models","autogeneratedByOpenApi":true},{"title":"List data models defined in the project","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nList data models defined in the project. You can filter the returned models by the specified space.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /models/datamodels","href":"/20230101-alpha/data-models/list-data-models-defined-in-the-project","autogeneratedByOpenApi":true},{"title":"Retrieve data models by their external ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 100 data models by their external ids. Views can be auto-expanded when the ```InlineViews``` query parameter is set.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/datamodels/byids","href":"/20230101-alpha/data-models/retrieve-data-models-by-their-external-ids","autogeneratedByOpenApi":true}]},{"group":"Spaces","pages":[{"title":"Spaces","sidebarTitle":"Overview","description":"Manage spaces for organizing data models in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/spaces"},{"title":"Create or update spaces","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nAdd or update (upsert) spaces. For unchanged space specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for spaces that remain unchanged.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/spaces","href":"/20230101-alpha/spaces/create-or-update-spaces","autogeneratedByOpenApi":true},{"title":"Delete spaces","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more spaces, maximum 100 spaces at a time.\n\n\nOnly empty spaces can be deleted. ","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/spaces/delete","href":"/20230101-alpha/spaces/delete-spaces","autogeneratedByOpenApi":true},{"title":"List spaces defined in the project","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nList spaces defined in the current project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /models/spaces","href":"/20230101-alpha/spaces/list-spaces-defined-in-the-project","autogeneratedByOpenApi":true},{"title":"Retrieve spaces by their space-ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 100 spaces by specifying their space-ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/spaces/byids","href":"/20230101-alpha/spaces/retrieve-spaces-by-their-space-ids","autogeneratedByOpenApi":true}]},{"group":"Views","pages":[{"title":"Views","sidebarTitle":"Overview","description":"Define and manage views for data modeling in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/views"},{"title":"Create or update views","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nAdd or update (upsert) views. For unchanged view specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for views that remain unchanged.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/views","href":"/20230101-alpha/views/create-or-update-views","autogeneratedByOpenApi":true},{"title":"Delete views","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more views. Currently limited to 100 views at a time.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/views/delete","href":"/20230101-alpha/views/delete-views","autogeneratedByOpenApi":true},{"title":"List views defined in the project","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nList of views defined in the current project. You can filter the list by specifying a space.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /models/views","href":"/20230101-alpha/views/list-views-defined-in-the-project","autogeneratedByOpenApi":true},{"title":"Retrieve views by their external ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 100 views by their external ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/views/byids","href":"/20230101-alpha/views/retrieve-views-by-their-external-ids","autogeneratedByOpenApi":true}]},{"group":"Containers","pages":[{"title":"Containers","sidebarTitle":"Overview","description":"Create and manage containers for data storage in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/containers"},{"title":"Create or update containers","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nAdd or update (upsert) containers. For unchanged container specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for containers that remain unchanged.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/containers","href":"/20230101-alpha/containers/create-or-update-containers","autogeneratedByOpenApi":true},{"title":"Delete containers","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more containers. Currently limited to 100 containers at a time.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/containers/delete","href":"/20230101-alpha/containers/delete-containers","autogeneratedByOpenApi":true},{"title":"Delete indexes from containers","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more container indexes. Currently limited to 10 indexes at a time.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/containers/indexes/delete","href":"/20230101-alpha/containers/delete-indexes-from-containers","autogeneratedByOpenApi":true},{"title":"Delete constraints from containers","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more container constraints. Currently limited to 10 constraints at a time.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/containers/constraints/delete","href":"/20230101-alpha/containers/delete-constraints-from-containers","autogeneratedByOpenApi":true},{"title":"Inspect containers","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/containers/inspect","href":"/20230101-alpha/containers/inspect-containers","autogeneratedByOpenApi":true},{"title":"List containers defined in the project","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nList of containers defined in the current project. You can filter the list by specifying a space.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /models/containers","href":"/20230101-alpha/containers/list-containers-defined-in-the-project","autogeneratedByOpenApi":true},{"title":"Retrieve containers by their external ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 100 containers by their specified external ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/containers/byids","href":"/20230101-alpha/containers/retrieve-containers-by-their-external-ids","autogeneratedByOpenApi":true},{"title":"Retry failed container constraints","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nTriggers a revalidation of the given failed container constraints. This will usually entail scanning through all the data in the container, so use this sparingly. There are strict limits as to how often a given constraint can be revalidated, and how many schema entities can be in a retrying state simultaneously.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/containers/constraints/retry","href":"/20230101-alpha/containers/retry-failed-container-constraints","autogeneratedByOpenApi":true},{"title":"Retry failed indexes","description":"\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nTriggers a retry of the given failed container indexes. This will usually entail scanning through all the data in the container, so use this sparingly. There are strict limits as to how often a given index can be retried, and how many schema entities can be in a retrying state simultaneously.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/containers/indexes/retry","href":"/20230101-alpha/containers/retry-failed-indexes","autogeneratedByOpenApi":true},{"title":"Retry failed property constraints","description":"Revalidates failed property constraints by scanning the container. Requires `dataModelsAcl:WRITE`. See [Retry property constraints](/api-reference/concepts/20230101/containers#retry-property-constraints).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/containers/properties/retry","href":"/20230101-alpha/containers/retry-failed-property-constraints","autogeneratedByOpenApi":true}]},{"group":"Instances","pages":[{"title":"Instances","sidebarTitle":"Overview","description":"Create and manage nodes and edges in the Cognite Data Fusion (CDF) knowledge graph.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/instances"},{"title":"Aggregate data across nodes/edges","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nAggregate data for nodes or edges in a project. You can use an optional query or filter specification to limit the result.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/instances/aggregate","href":"/20230101-alpha/instances/aggregate-data-across-nodesedges","autogeneratedByOpenApi":true},{"title":"Create or update nodes/edges","description":"Creates, patches, replaces, or deletes nodes and edges in one transaction. Requires `dataModelsAcl:WRITE`. See [Create, patch, and replace](/api-reference/concepts/20230101/instances#create-patch-replace).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/instances","href":"/20230101-alpha/instances/create-or-update-nodesedges","autogeneratedByOpenApi":true},{"title":"Delete nodes/edges","description":"Deletes nodes and edges. Deleting a node also deletes its edges. Requires `dataModelsAcl:WRITE`. See [Delete instances](/api-reference/concepts/20230101/instances#delete-instances).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/instances/delete","href":"/20230101-alpha/instances/delete-nodesedges","autogeneratedByOpenApi":true},{"title":"Filter nodes/edges","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nFilter the instances - nodes and edges - in a project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/instances/list","href":"/20230101-alpha/instances/filter-nodesedges","autogeneratedByOpenApi":true},{"title":"Inspect instances","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/instances/inspect","href":"/20230101-alpha/instances/inspect-instances","autogeneratedByOpenApi":true},{"title":"Query nodes/edges","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nSpecification of query endpoint. For more information, see [Query language](https://docs.cognite.com/cdf/dm/dm_concepts/dm_querying).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/instances/query","href":"/20230101-alpha/instances/query-nodesedges","autogeneratedByOpenApi":true},{"title":"Retrieve nodes/edges by their external ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 1000 nodes or edges by their external ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/instances/byids","href":"/20230101-alpha/instances/retrieve-nodesedges-by-their-external-ids","autogeneratedByOpenApi":true},{"title":"Search for nodes/edges","description":"\n\n> **Required capabilities:** `DataModels:READ`\n\nSearch text fields in views for nodes or edge(s). The service will return up to 1000 results. This operation orders the results by relevance, across the specified spaces.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/instances/search","href":"/20230101-alpha/instances/search-for-nodesedges","autogeneratedByOpenApi":true},{"title":"Sync nodes/edges","description":"Returns changes for nodes and edges that match a filter. Requires `dataModelsAcl:READ`. See [Sync](/api-reference/concepts/20230101/instances#sync).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/instances/sync","href":"/20230101-alpha/instances/sync-nodesedges","autogeneratedByOpenApi":true}]},{"group":"Statistics","pages":[{"title":"Statistics","sidebarTitle":"Statistics","description":"Retrieve data modeling statistics in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/dm-statistics"},{"title":"Retrieve project-wide statistics and limits","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nReturns statistics and limits for data modeling resources across the project. Use this endpoint to monitor your overall data modeling usage and available capacity.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /models/statistics","href":"/20230101-alpha/statistics/retrieve-project-wide-statistics-and-limits","autogeneratedByOpenApi":true},{"title":"Retrieve statistics by space","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nReturns statistics for data modeling resources grouped by each space in the project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /models/statistics/spaces","href":"/20230101-alpha/statistics/retrieve-statistics-by-space","autogeneratedByOpenApi":true},{"title":"Retrieve statistics by space for specific space-ids","description":"\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nReturns statistics for data modeling resources grouped by space for a specified list of spaces.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /models/statistics/spaces/byids","href":"/20230101-alpha/statistics/retrieve-statistics-by-space-for-specific-space-ids","autogeneratedByOpenApi":true}]},{"group":"Streams","pages":[{"title":"Streams","sidebarTitle":"Overview","description":"Manage streams in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/streams"},{"title":"Create stream","description":"Creates a stream from a template. The template sets mutability, limits, and retention. Requires `streamsAcl:CREATE`. See [Stream templates](/api-reference/concepts/20230101/streams#stream-templates).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /streams","href":"/20230101-alpha/streams/create-stream","autogeneratedByOpenApi":true},{"title":"Delete stream","description":"\n\n> **Required capabilities:** `streamsAcl:DELETE`\n\nDelete a stream by its identifier, along with all records stored in the stream.\n\nIf the stream does not exist, the operation succeeds without error (idempotent delete).\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /streams/delete","href":"/20230101-alpha/streams/delete-stream","autogeneratedByOpenApi":true},{"title":"Delete stream (DEPRECATED)","description":"\n\n> **Required capabilities:** `streamsAcl:DELETE`\n\n**DEPRECATED**: This endpoint is no longer supported and returns HTTP 410 Gone.\nPlease use `POST /streams/delete` instead.\n","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json delete /streams/{streamId}","href":"/20230101-alpha/streams/delete-stream-deprecated","autogeneratedByOpenApi":true},{"title":"List streams","description":"\n\n> **Required capabilities:** `streamsAcl:READ`\n\nList all streams available in the project.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /streams","href":"/20230101-alpha/streams/list-streams","autogeneratedByOpenApi":true},{"title":"List stream templates","description":"Lists the stream templates this project can use. Requires `streamsAcl:READ`. See [Stream templates](/api-reference/concepts/20230101-alpha/streams#stream-templates).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /streams/templates","href":"/20230101-alpha/streams/list-stream-templates","autogeneratedByOpenApi":true},{"title":"Retrieve stream","description":"\n\n> **Required capabilities:** `streamsAcl:READ`\n\nRetrieve a stream by its identifier.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /streams/{streamId}","href":"/20230101-alpha/streams/retrieve-stream","autogeneratedByOpenApi":true}]},{"group":"Records","pages":[{"title":"Records","sidebarTitle":"Overview","description":"Manage records in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/records"},{"title":"Aggregate records data from a stream","description":"Aggregates records in a stream. Requires `streamRecordsAcl:READ` and `dataModelsAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/records#aggregates).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /streams/{streamId}/records/aggregate","href":"/20230101-alpha/records/aggregate-records-data-from-a-stream","autogeneratedByOpenApi":true},{"title":"Delete records from a stream","description":"Deletes records from a mutable stream. Requires `streamRecordsAcl:WRITE`. See [Delete records](/api-reference/concepts/20230101/records#delete-records).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /streams/{streamId}/records/delete","href":"/20230101-alpha/records/delete-records-from-a-stream","autogeneratedByOpenApi":true},{"title":"Ingest records into a stream","description":"Ingests a batch of records into a stream. Requires `streamRecordsAcl:WRITE` and `dataModelsAcl:READ`. See [Ingest records](/api-reference/concepts/20230101/records#ingest-records).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /streams/{streamId}/records","href":"/20230101-alpha/records/ingest-records-into-a-stream","autogeneratedByOpenApi":true},{"title":"Retrieve records from a stream","description":"\n\n> **Required capabilities:** `streamRecordsAcl:READ` `dataModelsAcl:READ`\n\nFilter the records from the ```stream```.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /streams/{streamId}/records/filter","href":"/20230101-alpha/records/retrieve-records-from-a-stream","autogeneratedByOpenApi":true},{"title":"Sync records from a stream","description":"\n\n> **Required capabilities:** `streamRecordsAcl:READ` `dataModelsAcl:READ`\n\nSubscribe to changes for records from the ```stream```, matching a supplied filter.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /streams/{streamId}/records/sync","href":"/20230101-alpha/records/sync-records-from-a-stream","autogeneratedByOpenApi":true},{"title":"Upsert (create or update) records into a stream","description":"Creates or replaces records in a mutable stream. Requires `streamRecordsAcl:WRITE` and `dataModelsAcl:READ`. See [Upsert records](/api-reference/concepts/20230101/records#upsert-records).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /streams/{streamId}/records/upsert","href":"/20230101-alpha/records/upsert-create-or-update-records-into-a-stream","autogeneratedByOpenApi":true}]}]},{"group":"Time series and datapoints","pages":[{"title":"Time series and datapoints","sidebarTitle":"Overview","description":"Insert, retrieve, and query time series datapoints in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["data-modeling","asset-centric"],"api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/time-series-data"},{"group":"Datapoints","pages":[{"title":"Datapoints","sidebarTitle":"Overview","description":"Insert, retrieve, and delete time series data points in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["data-modeling","asset-centric"],"api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/datapoints"},{"title":"Insert data points","description":"\n\n> **Required capabilities:** `timeSeriesAcl:WRITE`\n\nInsert data points into a time series. You can do this for multiple time series.\nIf you insert a data point with a timestamp that already exists, it will be overwritten with the new value.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/data","href":"/20230101-alpha/time-series/insert-data-points","autogeneratedByOpenApi":true},{"title":"Retrieve data points","description":"Lists data points from multiple time series. If `start` is omitted, it defaults to 1 January 1970. Requires `timeSeriesAcl:READ`. See [List data points](/api-reference/concepts/20230101/time-series#list-data-points).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/data/list","href":"/20230101-alpha/time-series/retrieve-data-points","autogeneratedByOpenApi":true},{"title":"Retrieve latest data point","description":"\n\n> **Required capabilities:** `timeSeriesAcl:READ`\n\nRetrieves the latest data point in one or more time series. Note that the latest data point\nin a time series is the one with the highest timestamp, which is not necessarily the one\nthat was ingested most recently.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/data/latest","href":"/20230101-alpha/time-series/retrieve-latest-data-point","autogeneratedByOpenApi":true},{"title":"Delete data points","description":"\n\n> **Required capabilities:** `timeSeriesAcl:WRITE`\n\nDelete data points from time series.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/data/delete","href":"/20230101-alpha/time-series/delete-data-points","autogeneratedByOpenApi":true}]},{"group":"Synthetic time series","pages":[{"title":"Synthetic time series","sidebarTitle":"Overview","description":"Create synthetic time series queries in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["data-modeling","asset-centric"],"api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/synthetic-time-series"},{"title":"Synthetic query","description":"Execute an on-the-fly synthetic query","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/synthetic/query","href":"/20230101-alpha/synthetic-time-series/synthetic-query","autogeneratedByOpenApi":true}]},{"group":"Data point subscriptions","pages":[{"title":"Data point subscriptions","sidebarTitle":"Overview","description":"Subscribe to changes in time series data points in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["data-modeling","asset-centric"],"api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/data-point-subscriptions"},{"title":"Create subscriptions","description":"\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:WRITE`\n\nCreate one or more subscriptions that can be used to listen for changes in data points for a set of time series.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/subscriptions","href":"/20230101-alpha/data-point-subscriptions/create-subscriptions","autogeneratedByOpenApi":true},{"title":"Delete subscriptions","description":"\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:WRITE`\n\nDelete subscription(s). This operation cannot be undone","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/subscriptions/delete","href":"/20230101-alpha/data-point-subscriptions/delete-subscriptions","autogeneratedByOpenApi":true},{"title":"List subscription data","description":"Returns the next batch of data-point updates for one or more partitions. Requires `timeSeriesSubscriptionsAcl:READ`. See [Partitions](/api-reference/concepts/20230101/data-point-subscriptions#partitions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/subscriptions/data/list","href":"/20230101-alpha/data-point-subscriptions/list-subscription-data","autogeneratedByOpenApi":true},{"title":"List subscription members","description":"Lists the time series in a subscription. A series added by both external ID and instance ID appears twice. Requires `timeSeriesSubscriptionsAcl:READ`. See [Data point subscriptions](/api-reference/concepts/20230101/data-point-subscriptions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /timeseries/subscriptions/members","href":"/20230101-alpha/data-point-subscriptions/list-subscription-members","autogeneratedByOpenApi":true},{"title":"List subscriptions","description":"\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:READ`\n\nList all subscriptions for the tenant. Use nextCursor to paginate through the results.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /timeseries/subscriptions","href":"/20230101-alpha/data-point-subscriptions/list-subscriptions","autogeneratedByOpenApi":true},{"title":"Retrieve subscriptions","description":"\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:READ`\n\nRetrieve one or more subscriptions by external ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/subscriptions/byids","href":"/20230101-alpha/data-point-subscriptions/retrieve-subscriptions","autogeneratedByOpenApi":true},{"title":"Update subscriptions","description":"\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:WRITE`\n\nUpdates one or more subscriptions. Fields that are not included in the request, are not changed.\n\nIf both `instanceIds` and `timeSeriesIds` are set, they must either both be add/remove or\nboth be set operations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/subscriptions/update","href":"/20230101-alpha/data-point-subscriptions/update-subscriptions","autogeneratedByOpenApi":true}]}]},{"group":"File content","pages":[{"title":"File content","sidebarTitle":"Overview","description":"Upload and download file content in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["data-modeling","asset-centric"],"api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/file-content"},{"title":"Get upload file link","description":"Returns an upload URL for an existing file. Requires `filesAcl:WRITE`, or data modeling read and write. See [Upload limits](/api-reference/concepts/20230101/file-content#upload-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /files/uploadlink","href":"/20230101-alpha/files/get-upload-file-link","autogeneratedByOpenApi":true},{"title":"Download files","description":"Returns download URLs. A URL expires after 30 seconds unless you extend it. Requires `filesAcl:READ`, or data modeling read. See [Download links](/api-reference/concepts/20230101/file-content#download-links).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /files/downloadlink","href":"/20230101-alpha/files/download-files","autogeneratedByOpenApi":true},{"title":"Upload multipart file","description":"Creates file metadata and returns multipart upload URLs. Requires `filesAcl:WRITE`. See [Upload limits](/api-reference/concepts/20230101/file-content#upload-limits).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /files/initmultipartupload","href":"/20230101-alpha/files/upload-multipart-file","autogeneratedByOpenApi":true},{"title":"Get multipart file upload link","description":"Returns multipart upload URLs for an existing file. Requires `filesAcl:WRITE`, or data modeling read and write. See [Upload limits](/api-reference/concepts/20230101/file-content#upload-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /files/multiuploadlink","href":"/20230101-alpha/files/get-multipart-file-upload-link","autogeneratedByOpenApi":true},{"title":"Complete multipart upload","description":"Assembles uploaded parts into one file. Requires `filesAcl:WRITE`, or data modeling read and write. See [Upload limits](/api-reference/concepts/20230101/file-content#upload-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /files/completemultipartupload","href":"/20230101-alpha/files/complete-multipart-upload","autogeneratedByOpenApi":true},{"title":"Get icon","description":"Returns an icon for a JPEG or PNG file. Requires `filesAcl:READ`, or data modeling read. See [File icons](/api-reference/concepts/20230101/file-content#file-icons).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /files/icon","href":"/20230101-alpha/files/get-icon","autogeneratedByOpenApi":true}]},{"group":"3D","pages":[{"title":"3D","sidebarTitle":"Overview","description":"Manage 3D models, revisions, files, asset mappings, and processing jobs in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/3d"},{"group":"3D models","pages":[{"title":"3D Models","sidebarTitle":"Overview","description":"Manage 3D models in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/3d-models"},{"title":"List 3D models","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nRetrieves a list of all models in a project. This operation supports pagination. You can filter out all models without a published revision.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /3d/models","href":"/20230101-alpha/3d-models/list-3d-models","autogeneratedByOpenApi":true},{"title":"Create 3D models","description":"\n\n> **Required capabilities:** `threedAcl:CREATE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/models","href":"/20230101-alpha/3d-models/create-3d-models","autogeneratedByOpenApi":true},{"title":"Update 3D models","description":"\n\n> **Required capabilities:** `threedAcl:UPDATE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/models/update","href":"/20230101-alpha/3d-models/update-3d-models","autogeneratedByOpenApi":true},{"title":"Delete 3D models","description":"\n\n> **Required capabilities:** `threedAcl:DELETE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/models/delete","href":"/20230101-alpha/3d-models/delete-3d-models","autogeneratedByOpenApi":true},{"title":"Retrieve a 3D model","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /3d/models/{modelId}","href":"/20230101-alpha/3d-models/retrieve-a-3d-model","autogeneratedByOpenApi":true}]},{"group":"3D model revisions","pages":[{"title":"3D Model Revisions","sidebarTitle":"Overview","description":"Manage 3D model revisions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/3d-model-revisions"},{"title":"List 3D revisions","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nRetrieves a list of all revisions of a model. This operation supports pagination. You can also filter revisions if they are marked as published or not by using the query param published.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /3d/models/{modelId}/revisions","href":"/20230101-alpha/3d-model-revisions/list-3d-revisions","autogeneratedByOpenApi":true},{"title":"Create 3D revisions","description":"Creates revisions and starts processing. Data modeling only projects use 3D jobs. Requires `threedAcl:CREATE`. See [Create revisions](/api-reference/concepts/20230101/3d-model-revisions#create-revisions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/models/{modelId}/revisions","href":"/20230101-alpha/3d-model-revisions/create-3d-revisions","autogeneratedByOpenApi":true},{"title":"Update 3D revisions","description":"\n\n> **Required capabilities:** `threedAcl:UPDATE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/models/{modelId}/revisions/update","href":"/20230101-alpha/3d-model-revisions/update-3d-revisions","autogeneratedByOpenApi":true},{"title":"Delete 3D revisions","description":"\n\n> **Required capabilities:** `threedAcl:DELETE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/models/{modelId}/revisions/delete","href":"/20230101-alpha/3d-model-revisions/delete-3d-revisions","autogeneratedByOpenApi":true},{"title":"Retrieve a 3D revision","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /3d/models/{modelId}/revisions/{revisionId}","href":"/20230101-alpha/3d-model-revisions/retrieve-a-3d-revision","autogeneratedByOpenApi":true},{"title":"List 3D revision logs","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nList log entries for the revision","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /3d/models/{modelId}/revisions/{revisionId}/logs","href":"/20230101-alpha/3d-model-revisions/list-3d-revision-logs","autogeneratedByOpenApi":true},{"title":"Update 3D revision thumbnail","description":"\n\n> **Required capabilities:** `threedAcl:UPDATE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/models/{modelId}/revisions/{revisionId}/thumbnail","href":"/20230101-alpha/3d-model-revisions/update-3d-revision-thumbnail","autogeneratedByOpenApi":true},{"title":"List available outputs","description":"Lists outputs for a processed revision. Requires `threedAcl:READ`. See [Outputs](/api-reference/concepts/20230101/3d-model-revisions#outputs).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /3d/models/{modelId}/revisions/{revisionId}/outputs","href":"/20230101-alpha/3d-model-revisions/list-available-outputs","autogeneratedByOpenApi":true},{"title":"List 3D nodes","description":"Lists nodes in a revision. Wait until the revision status is `Done`. Requires `threedAcl:READ`. See [Nodes](/api-reference/concepts/20230101/3d-model-revisions#nodes).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /3d/models/{modelId}/revisions/{revisionId}/nodes","href":"/20230101-alpha/3d-model-revisions/list-3d-nodes","autogeneratedByOpenApi":true},{"title":"Filter 3D nodes","description":"Filters nodes by name or property. Wait until the revision status is `Done`. Requires `threedAcl:READ`. See [Nodes](/api-reference/concepts/20230101/3d-model-revisions#nodes).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/models/{modelId}/revisions/{revisionId}/nodes/list","href":"/20230101-alpha/3d-model-revisions/filter-3d-nodes","autogeneratedByOpenApi":true},{"title":"Get 3D nodes by ID","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nRetrieves specific nodes given by a list of IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/models/{modelId}/revisions/{revisionId}/nodes/byids","href":"/20230101-alpha/3d-model-revisions/get-3d-nodes-by-id","autogeneratedByOpenApi":true},{"title":"List 3D ancestor nodes","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nRetrieves a list of ancestor nodes of a given node, including itself, in the hierarchy of the 3D model. This operation supports pagination. Will return error 400 if the revision is still being processed.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}/ancestors","href":"/20230101-alpha/3d-model-revisions/list-3d-ancestor-nodes","autogeneratedByOpenApi":true}]},{"group":"3D files","pages":[{"title":"3D Files","sidebarTitle":"Overview","description":"Retrieve 3D files from Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/3d-files"},{"title":"Retrieve a single 3D file","description":"Returns a processed 3D file by ID. Requires `threedAcl:READ`. See [Output types](/api-reference/concepts/20230101/3d-files#output-types).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /3d/files/{threedFileId}","href":"/20230101-alpha/3d-files/retrieve-a-single-3d-file","autogeneratedByOpenApi":true},{"title":"Retrieve a 3D directory file","description":"Returns one file inside a 3D directory output. Requires `threedAcl:READ`. See [Output types](/api-reference/concepts/20230101/3d-files#output-types).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /3d/files/{threedFileId}/{subPath}","href":"/20230101-alpha/3d-files/retrieve-a-3d-directory-file","autogeneratedByOpenApi":true}]},{"group":"3D asset mapping","pages":[{"title":"3D Asset Mapping","sidebarTitle":"Overview","description":"Map 3D model nodes to assets in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/3d-asset-mapping"},{"title":"List 3D asset mappings","description":"Lists mappings for one filter. Not available in data modeling only projects. Requires `threedAcl:READ`. See [Mapping rules](/api-reference/concepts/20230101/3d-asset-mapping#mapping-rules).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /3d/models/{modelId}/revisions/{revisionId}/mappings","href":"/20230101-alpha/3d-asset-mapping/list-3d-asset-mappings","autogeneratedByOpenApi":true},{"title":"Create 3D asset mappings","description":"Creates mappings between assets and 3D nodes. Requires `threedAcl:UPDATE`. See [Mapping rules](/api-reference/concepts/20230101/3d-asset-mapping#mapping-rules).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/models/{modelId}/revisions/{revisionId}/mappings","href":"/20230101-alpha/3d-asset-mapping/create-3d-asset-mappings","autogeneratedByOpenApi":true},{"title":"Delete 3D asset mappings","description":"\n\n> **Required capabilities:** `threedAcl:DELETE`\n\nDelete a list of asset mappings.\n\nIn Hybrid CDF projects: The delete request items requires a `nodeId`, and either an `assetId` or an `assetInstanceId`.\n\nIn DataModelingOnly CDF projects: The delete request items requires a `nodeId` and an `assetInstanceId` (with space and externalId).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/models/{modelId}/revisions/{revisionId}/mappings/delete","href":"/20230101-alpha/3d-asset-mapping/delete-3d-asset-mappings","autogeneratedByOpenApi":true},{"title":"Filter 3D asset mappings","description":"Lists mappings for one filter. Not available in data modeling only projects. Requires `threedAcl:READ`. See [Mapping rules](/api-reference/concepts/20230101/3d-asset-mapping#mapping-rules).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/models/{modelId}/revisions/{revisionId}/mappings/list","href":"/20230101-alpha/3d-asset-mapping/filter-3d-asset-mappings","autogeneratedByOpenApi":true},{"title":"Filter which nodes are within a boundingbox for a revision.","description":"This endpoint is only supported in dm-only projects.\nThe nodeIds can be found as part of a CogniteCadNode in the field `cadNodeReference`.\nSimilar functionality is supported in classic through:\n- list 3D asset mappings endpoint + intersectsBoundingBox","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/nodes/list","href":"/20230101-alpha/3d-asset-mapping/filter-which-nodes-are-within-a-boundingbox-for-a-revision","autogeneratedByOpenApi":true},{"title":"List mappings for one assetID across all 3D models","description":"Lists node IDs mapped to an asset across models. Requires `threedAcl:READ`. See [Mapping rules](/api-reference/concepts/20230101/3d-asset-mapping#mapping-rules).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /3d/mappings/{assetId}/modelnodes","href":"/20230101-alpha/3d-asset-mapping/list-mappings-for-one-assetid-across-all-3d-models","autogeneratedByOpenApi":true},{"title":"Filter 3D assetInstanceId mappings across all 3D models","description":"\n\n> **Required capabilities:** `threedAcl:READ`\n\nFilters the mappings for a specific assetInstanceId across all 3D models in the project.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/mappings/modelnodes/filter","href":"/20230101-alpha/3d-asset-mapping/filter-3d-assetinstanceid-mappings-across-all-3d-models","autogeneratedByOpenApi":true}]},{"group":"3D jobs","pages":[{"title":"3D Jobs","sidebarTitle":"Overview","description":"Manage 3D processing jobs in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/3d-jobs"},{"title":"Create a job using 3D source data","description":"Creates a 3D job in a data modeling project. Requires a session nonce. See [Job sources](/api-reference/concepts/20230101/3d-jobs#job-sources).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/jobs","href":"/20230101-alpha/3d-jobs/create-a-job-using-3d-source-data","autogeneratedByOpenApi":true},{"title":"List jobs","description":"\n\n> **Required capabilities:** `datamodels:READ(cdf_cdm, cdf_cdm_3d)` `datamodelinstances:READ`\n\nList jobs for your project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/jobs/list","href":"/20230101-alpha/3d-jobs/list-jobs","autogeneratedByOpenApi":true},{"title":"Delete jobs","description":"\n\n> **Required capabilities:** `datamodels:READ(cdf_cdm, cdf_cdm_3d)` `datamodelinstances:WRITE`\n\nDelete jobs in your project. The job instance results won't be deleted by this operation.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/jobs/delete","href":"/20230101-alpha/3d-jobs/delete-jobs","autogeneratedByOpenApi":true},{"title":"List Job Results","description":"List the results of a job","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/job/results/list","href":"/20230101-alpha/3d-jobs/list-job-results","autogeneratedByOpenApi":true},{"title":"Update Job Result Rejections","description":"Job Instance Results have internal unique keys you can reject\nto allow yourself to filter away job results items you are no longer\ninterested in","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/job/result/rejections","href":"/20230101-alpha/3d-jobs/update-job-result-rejections","autogeneratedByOpenApi":true},{"title":"List Job Result Rejections","description":"A list of internal keys that are to be considered rejected","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/job/result/rejections/list","href":"/20230101-alpha/3d-jobs/list-job-result-rejections","autogeneratedByOpenApi":true}]},{"group":"3D contextualization","pages":[{"title":"Create CAD contextualization","description":"Links CAD nodes to `CogniteAsset` instances. One node links to one asset. See [Relationship rules](/api-reference/concepts/20230101-beta/3d-contextualization#relationship-rules).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/contextualization/cad","href":"/20230101-alpha/3d-contextualization/create-cad-contextualization","autogeneratedByOpenApi":true},{"title":"Delete CAD contextualization","description":"Deletes links between specified CAD nodes and `CogniteAsset` instances.\n\nUse this endpoint to remove existing contextualization links for a specific 3D model revision when links are no longer valid or need to be replaced.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/contextualization/cad/delete","href":"/20230101-alpha/3d-contextualization/delete-cad-contextualization","autogeneratedByOpenApi":true},{"title":"Create 360 image contextualization","description":"Links 360 image annotations to `CogniteAsset` instances. Use the `RC` request body. See [Relationship rules](/api-reference/concepts/20230101-beta/3d-contextualization#relationship-rules).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/contextualization/image360","href":"/20230101-alpha/3d-contextualization/create-360-image-contextualization","autogeneratedByOpenApi":true},{"title":"Delete 360 image contextualization","description":"Deletes links between 360 image annotations and `CogniteAsset` instances. Use the `RC` request body. See [Relationship rules](/api-reference/concepts/20230101-beta/3d-contextualization#relationship-rules).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/contextualization/image360/delete","href":"/20230101-alpha/3d-contextualization/delete-360-image-contextualization","autogeneratedByOpenApi":true},{"title":"Create point cloud volume contextualization","description":"Links point cloud volume references to `CogniteAsset` instances. See [Relationship rules](/api-reference/concepts/20230101-beta/3d-contextualization#relationship-rules).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/contextualization/pointcloud","href":"/20230101-alpha/3d-contextualization/create-point-cloud-volume-contextualization","autogeneratedByOpenApi":true},{"title":"Delete point cloud volume contextualization","description":"Deletes links for specified point cloud volume references.\n\nUse this endpoint to remove existing contextualization links for a specific point cloud revision when links are no longer valid or need to be replaced.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/contextualization/pointcloud/delete","href":"/20230101-alpha/3d-contextualization/delete-point-cloud-volume-contextualization","autogeneratedByOpenApi":true}]}]}]},{"group":"Cognite AI","icon":"bot","expanded":true,"pages":[{"title":"Cognite AI","sidebarTitle":"Overview","description":"Overview of Cognite AI APIs in Cognite Data Fusion (CDF), including document understanding, agents, skills, and language models.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/cognite-ai"},{"group":"Agents","pages":[{"title":"AI agents","sidebarTitle":"Overview","description":"Define, list, chat with, and delete AI agents in Cognite Data Fusion (CDF) using the REST API.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/ai-agents"},{"title":"List agents","description":"List agents defined in the project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /ai/agents","href":"/20230101-alpha/agents/list-agents","autogeneratedByOpenApi":true},{"title":"Add or update Atlas AI agents","description":"Add or update (upsert) Atlas AI agents.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /ai/agents","href":"/20230101-alpha/agents/add-or-update-atlas-ai-agents","autogeneratedByOpenApi":true},{"title":"Retrieve agents by external ID","description":"Retrieve agents by their external IDs. The response returns the agents in the same order as in the request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /ai/agents/byids","href":"/20230101-alpha/agents/retrieve-agents-by-external-id","autogeneratedByOpenApi":true},{"title":"Start a chat session with an agent","description":"Starts or continues an agent chat. Pass `cursor` to continue. Confirm tools before they run. See [Chat turns](/api-reference/concepts/20230101-beta/ai-agents#chat-turns).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /ai/agents/chat","href":"/20230101-alpha/agents/start-a-chat-session-with-an-agent","autogeneratedByOpenApi":true},{"title":"Delete agents","description":"Delete agents with specific external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /ai/agents/delete","href":"/20230101-alpha/agents/delete-agents","autogeneratedByOpenApi":true}]},{"group":"Chat completions","pages":[{"title":"Chat completions","sidebarTitle":"Overview","description":"Create chat completions with language models in a Cognite Data Fusion (CDF) project. This alpha endpoint follows the OpenAI Chat Completions API.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/ai-chat-completions"},{"title":"Create chat completions","description":"Generates chat completions from messages.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /ai/openai/chat/completions","href":"/20230101-alpha/chat-completions/create-chat-completions","autogeneratedByOpenApi":true}]},{"group":"Document AI","pages":[{"title":"Document AI","sidebarTitle":"Overview","description":"Ask questions about and summarize documents in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/document-ai"},{"title":"Ask questions about one or more documents.","description":"Answers a question from up to 100 PDFs. Each PDF can be at most 400 pages. See [Ask limits](/api-reference/concepts/20230101/document-ai#ask-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /ai/tools/documents/ask","href":"/20230101-alpha/document-ai/ask-questions-about-one-or-more-documents","autogeneratedByOpenApi":true},{"title":"Summarize documents.","description":"Generates concise summaries for a list of input documents using a language model.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /ai/tools/documents/summarize","href":"/20230101-alpha/document-ai/summarize-documents","autogeneratedByOpenApi":true}]},{"group":"Models","pages":[{"title":"Language models","sidebarTitle":"Overview","description":"List language models available in a Cognite Data Fusion (CDF) project. This beta and alpha operation follows the OpenAI Models API.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/ai-models"},{"title":"List models","description":"Returns a list of language models available in your CDF project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /ai/openai/models","href":"/20230101-alpha/models/list-models","autogeneratedByOpenApi":true}]},{"group":"Skills","pages":[{"title":"AI skills","sidebarTitle":"Overview","description":"List, add, upload, download, and delete reusable agent skills in Cognite Data Fusion (CDF).","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","article-type":"article","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/ai-skills"},{"title":"List skills","description":"Return a summary for each Atlas AI project skill (external ID, name, description, and timestamp\n fields). Skill body content is not included; use the by-IDs endpoint to load full skills.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /ai/skills","href":"/20230101-alpha/skills/list-skills","autogeneratedByOpenApi":true},{"title":"Add or update Atlas AI project skills","description":"Add or update Atlas AI project skills. A project may have at most 200 skills; exceeding the limit returns **400** with `error.message` e.g. \"Max skill limit of 200 reached.\".","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /ai/skills","href":"/20230101-alpha/skills/add-or-update-atlas-ai-project-skills","autogeneratedByOpenApi":true},{"title":"Retrieve skills by external ID","description":"Retrieve skills by their external IDs. The response returns the skills in the same order as in the request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /ai/skills/byids","href":"/20230101-alpha/skills/retrieve-skills-by-external-id","autogeneratedByOpenApi":true},{"title":"Upload a skill from a Markdown file","description":"Upload a skill as multipart/form-data with one `file` part: a UTF-8 `.md` file in `SKILL.md` form (YAML frontmatter with `name` and `description`, then a Markdown body). A project may have at most 200 skills; exceeding the limit returns **400** with `error.message` e.g. \"Max skill limit of 200 reached.\".","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /ai/skills/upload","href":"/20230101-alpha/skills/upload-a-skill-from-a-markdown-file","autogeneratedByOpenApi":true},{"title":"Download a skill as a zip archive","description":"Return a **.zip** archive containing the skill's `SKILL.md` for the given skill. The ``skill_external_id`` path segment is trimmed of leading and trailing whitespace before validation. Response is raw bytes (not JSON).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /ai/skills/{skill_external_id}/download","href":"/20230101-alpha/skills/download-a-skill-as-a-zip-archive","autogeneratedByOpenApi":true},{"title":"Delete skills","description":"Delete skills with specific external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /ai/skills/delete","href":"/20230101-alpha/skills/delete-skills","autogeneratedByOpenApi":true}]}]},{"group":"Compute and automation","icon":"cpu","expanded":true,"pages":[{"group":"Functions","pages":[{"title":"Functions","sidebarTitle":"Overview","description":"Deploy and run serverless functions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/functions-overview"},{"group":"Functions","pages":[{"title":"Functions","sidebarTitle":"Overview","description":"Deploy and manage serverless functions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/functions"},{"title":"Activate Functions","description":"\n\n> **Required capabilities:** `functionsAcl:WRITE`\n\nActivate Cognite Functions. This will create the necessary backend infrastructure for Cognite Functions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /functions/status","href":"/20230101-alpha/functions/activate-functions","autogeneratedByOpenApi":true},{"title":"Get activation status","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nGet activation status","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /functions/status","href":"/20230101-alpha/functions/get-activation-status","autogeneratedByOpenApi":true},{"title":"Create functions","description":"\n\n> **Required capabilities:** `functionsAcl:WRITE`\n\nYou can only create one function per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /functions","href":"/20230101-alpha/functions/create-functions","autogeneratedByOpenApi":true},{"title":"Delete functions","description":"\n\n> **Required capabilities:** `functionsAcl:WRITE`\n\nDelete functions. You can delete a maximum of 10 functions per request. Function source files stored in the Files API must be deleted separately.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /functions/delete","href":"/20230101-alpha/functions/delete-functions","autogeneratedByOpenApi":true},{"title":"Filter functions","description":"Use advanced filtering options to find functions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /functions/list","href":"/20230101-alpha/functions/filter-functions","autogeneratedByOpenApi":true},{"title":"Functions limits","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nService limits for the associated project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /functions/limits","href":"/20230101-alpha/functions/functions-limits","autogeneratedByOpenApi":true},{"title":"List functions","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nList functions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /functions","href":"/20230101-alpha/functions/list-functions","autogeneratedByOpenApi":true},{"title":"Retrieve a function by its id","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve a function by its id. If you want to retrieve functions by names, use Retrieve functions instead.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /functions/{functionId}","href":"/20230101-alpha/functions/retrieve-a-function-by-its-id","autogeneratedByOpenApi":true},{"title":"Retrieve functions","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve functions by ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /functions/byids","href":"/20230101-alpha/functions/retrieve-functions","autogeneratedByOpenApi":true}]},{"group":"Function calls","pages":[{"title":"Function calls","sidebarTitle":"Overview","description":"Execute and monitor function calls in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/function-calls"},{"title":"Call a function asynchronously","description":"Calls a function. Pass input in `data`, not secrets. Requires `functionsAcl:RUN`. See [Call input](/api-reference/concepts/20230101/function-calls#call-input).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /functions/{functionId}/call","href":"/20230101-alpha/function-calls/call-a-function-asynchronously","autogeneratedByOpenApi":true},{"title":"Filter function calls","description":"Use advanced filtering options to find function calls.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /functions/{functionId}/calls/list","href":"/20230101-alpha/function-calls/filter-function-calls","autogeneratedByOpenApi":true},{"title":"List function calls","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nList function calls.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /functions/{functionId}/calls","href":"/20230101-alpha/function-calls/list-function-calls","autogeneratedByOpenApi":true},{"title":"Retrieve calls","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve function calls by call ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /functions/{functionId}/calls/byids","href":"/20230101-alpha/function-calls/retrieve-calls","autogeneratedByOpenApi":true},{"title":"Retrieve a function call by its id","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve function calls.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /functions/{functionId}/calls/{callId}","href":"/20230101-alpha/function-calls/retrieve-a-function-call-by-its-id","autogeneratedByOpenApi":true},{"title":"Retrieve logs for function call","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nGet logs from a function call.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /functions/{functionId}/calls/{callId}/logs","href":"/20230101-alpha/function-calls/retrieve-logs-for-function-call","autogeneratedByOpenApi":true},{"title":"Retrieve response for function call","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve response from a function call.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /functions/{functionId}/calls/{callId}/response","href":"/20230101-alpha/function-calls/retrieve-response-for-function-call","autogeneratedByOpenApi":true}]},{"group":"Function schedules","pages":[{"title":"Function schedules","sidebarTitle":"Overview","description":"Schedule function executions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/function-schedules"},{"title":"Create schedules","description":"Creates schedules that call a function on a cron expression. A schedule with a `nonce` must use `functionId`. Requires `functionsAcl:WRITE`. See [Sessions](/api-reference/concepts/20230101/function-schedules#sessions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /functions/schedules","href":"/20230101-alpha/function-schedules/create-schedules","autogeneratedByOpenApi":true},{"title":"Delete schedules","description":"\n\n> **Required capabilities:** `functionsAcl:WRITE`\n\nDelete function schedules.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /functions/schedules/delete","href":"/20230101-alpha/function-schedules/delete-schedules","autogeneratedByOpenApi":true},{"title":"Filter function schedules","description":"Use advanced filtering options to find function schedules. At most one of `FunctionId` or `FunctionExternalId` can be specified.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /functions/schedules/list","href":"/20230101-alpha/function-schedules/filter-function-schedules","autogeneratedByOpenApi":true},{"title":"List schedules","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nList function schedules in project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /functions/schedules","href":"/20230101-alpha/function-schedules/list-schedules","autogeneratedByOpenApi":true},{"title":"Retrieve a function schedule by its id","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve a function schedule by its id.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /functions/schedules/{scheduleId}","href":"/20230101-alpha/function-schedules/retrieve-a-function-schedule-by-its-id","autogeneratedByOpenApi":true},{"title":"Retrieve schedules","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve function schedules by schedule ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /functions/schedules/byids","href":"/20230101-alpha/function-schedules/retrieve-schedules","autogeneratedByOpenApi":true},{"title":"Retrieve function input data","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nRetrieve the input data to the associated function.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /functions/schedules/{scheduleId}/input_data","href":"/20230101-alpha/function-schedules/retrieve-function-input-data","autogeneratedByOpenApi":true}]},{"group":"Function Apps","pages":[{"title":"List Function Apps","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nList all functions in the project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /function-apps","href":"/20230101-alpha/function-apps/list-function-apps","autogeneratedByOpenApi":true},{"title":"Get Function App","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nGet details of a specific Function App.\n\nReturns metadata about the function including name, status,\nruntime, etc.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /function-apps/{functionExternalId}","href":"/20230101-alpha/function-apps/get-function-app","autogeneratedByOpenApi":true},{"title":"Call Function Endpoint","description":"Calls a function app with a request envelope. The HTTP status is 200 when the function finishes. Requires `functionsAcl:WRITE`. See [Function app calls](/api-reference/concepts/20230101/functions-overview#function-app-calls).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /function-apps/{functionExternalId}/calls","href":"/20230101-alpha/function-app-calls/call-function-endpoint","autogeneratedByOpenApi":true},{"title":"List Calls","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nList all calls for a function.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /function-apps/{functionExternalId}/calls","href":"/20230101-alpha/function-app-calls/list-calls","autogeneratedByOpenApi":true},{"title":"Get Call Logs","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nGet logs from a function call.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /function-apps/{functionExternalId}/calls/{callId}/logs","href":"/20230101-alpha/function-app-calls/get-call-logs","autogeneratedByOpenApi":true},{"title":"Get Call Response","description":"\n\n> **Required capabilities:** `functionsAcl:READ`\n\nGet the response from a completed function call.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /function-apps/{functionExternalId}/calls/{callId}/response","href":"/20230101-alpha/function-app-calls/get-call-response","autogeneratedByOpenApi":true}]}]}]},{"group":"Connectors","icon":"plug","expanded":true,"pages":[{"group":"PostgreSQL gateway","pages":[{"title":"PostgreSQL gateway","sidebarTitle":"Overview","description":"Ingest data into Cognite Data Fusion (CDF) using the PostgreSQL protocol and SQL clients.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/postgresql-gateway"},{"group":"Postgres gateway users","pages":[{"title":"Postgres Gateway Users","sidebarTitle":"Overview","description":"Create and manage PostgreSQL gateway users and credentials in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/postgres-gateway-users"},{"title":"Create users","description":"\n\n> **Required capabilities:** `postgresGateway:WRITE`\n\nCreate postgres users.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /postgresgateway","href":"/20230101-alpha/postgres-gateway-users/create-users","autogeneratedByOpenApi":true},{"title":"Filter users","description":"List all postgres users for a given project. If more than `limit` users exist, a cursor for pagination will be returned with the response.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /postgresgateway/list","href":"/20230101-alpha/postgres-gateway-users/filter-users","autogeneratedByOpenApi":true},{"title":"Retrieve users","description":"\n\n> **Required capabilities:** `postgresGateway:READ`\n\nRetrieve a list of postgres users by their usernames, optionally ignoring unknown usernames","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /postgresgateway/byids","href":"/20230101-alpha/postgres-gateway-users/retrieve-users","autogeneratedByOpenApi":true},{"title":"Update users","description":"\n\n> **Required capabilities:** `[object Object]`\n\nUpdate postgres users","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /postgresgateway/update","href":"/20230101-alpha/postgres-gateway-users/update-users","autogeneratedByOpenApi":true},{"title":"Delete users","description":"\n\n> **Required capabilities:** `[object Object]`\n\nDelete postgres users","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /postgresgateway/delete","href":"/20230101-alpha/postgres-gateway-users/delete-users","autogeneratedByOpenApi":true},{"title":"List users","description":"\n\n> **Required capabilities:** `postgresGateway:READ`\n\nList all users in a given project. If more than `limit` users exist, a cursor for pagination will be returned with the response.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /postgresgateway","href":"/20230101-alpha/postgres-gateway-users/list-users","autogeneratedByOpenApi":true}]},{"group":"Postgres gateway tables","pages":[{"title":"Postgres Gateway Tables","sidebarTitle":"Overview","description":"Create and manage PostgreSQL gateway tables that expose Cognite Data Fusion (CDF) resources.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/postgres-gateway-tables"},{"title":"Create tables","description":"\n\n> **Required capabilities:** `postgresGateway:WRITE`\n\nCreate up to 10 tables.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /postgresgateway/tables/{username}","href":"/20230101-alpha/postgres-gateway-tables/create-tables","autogeneratedByOpenApi":true},{"title":"List tables","description":"\n\n> **Required capabilities:** `postgresGateway:READ`\n\nList all tables in a given project. If more than `limit` tables exist, a cursor for pagination will be returned with the response.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /postgresgateway/tables/{username}","href":"/20230101-alpha/postgres-gateway-tables/list-tables","autogeneratedByOpenApi":true},{"title":"Retrieve tables","description":"\n\n> **Required capabilities:** `postgresGateway:READ`\n\nRetrieve a list of postgres tables for a user by their table names, optionally ignoring unknown table names","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /postgresgateway/tables/{username}/byids","href":"/20230101-alpha/postgres-gateway-tables/retrieve-tables","autogeneratedByOpenApi":true},{"title":"Delete tables","description":"\n\n> **Required capabilities:** `[object Object]`\n\nDelete up to 10 tables","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /postgresgateway/tables/{username}/delete","href":"/20230101-alpha/postgres-gateway-tables/delete-tables","autogeneratedByOpenApi":true}]}]},{"group":"SAP writeback","pages":[{"title":"SAP writeback","sidebarTitle":"Overview","description":"Write data from Cognite Data Fusion (CDF) back to SAP systems.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/sap-writeback"},{"group":"SAP instances","pages":[{"title":"SAP Instances","sidebarTitle":"Overview","description":"Manage SAP instance connections in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/sap-instances"},{"title":"Create SAP Instances","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nCreate up to 100 SAP instances.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /writeback/sap/instances","href":"/20230101-alpha/sap-instances/create-sap-instances","autogeneratedByOpenApi":true},{"title":"Retrieve SAP Instances","description":"\n\n> **Required capabilities:** `sapWritebackAcl:READ`\n\nRetrieve a list of up to 100 SAP instances by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /writeback/sap/instances/byids","href":"/20230101-alpha/sap-instances/retrieve-sap-instances","autogeneratedByOpenApi":true},{"title":"Delete SAP Instances","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nDelete a list of SAP instance configurations by their external ID. This operation will fail if any destination in the request is associated with an SAP endpoint configuration, unless the `force` query parameter is set to `true`.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /writeback/sap/instances/delete","href":"/20230101-alpha/sap-instances/delete-sap-instances","autogeneratedByOpenApi":true}]},{"group":"SAP endpoints","pages":[{"title":"SAP Endpoints","sidebarTitle":"Overview","description":"Manage SAP writeback endpoints in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/sap-endpoints"},{"title":"Create SAP Endpoints","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nCreate up to 100 SAP endpoints.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /writeback/sap/endpoints","href":"/20230101-alpha/sap-endpoints/create-sap-endpoints","autogeneratedByOpenApi":true},{"title":"Retrieve SAP Endpoints","description":"\n\n> **Required capabilities:** `sapWritebackAcl:READ`\n\nRetrieve a list of up to 100 SAP endpoints by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /writeback/sap/endpoints/byids","href":"/20230101-alpha/sap-endpoints/retrieve-sap-endpoints","autogeneratedByOpenApi":true},{"title":"Delete SAP Endpoints","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nDelete a list of SAP endpoint configurations by their external ID. This operation will fail if any endpoint in the request is associated to a SAP instance configuration.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /writeback/sap/endpoints/delete","href":"/20230101-alpha/sap-endpoints/delete-sap-endpoints","autogeneratedByOpenApi":true},{"title":"Verify SAP Endpoint","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nVerify the connectivity between the writeback API, and the SAP endpoint destination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /writeback/sap/endpoints/verify","href":"/20230101-alpha/sap-endpoints/verify-sap-endpoint","autogeneratedByOpenApi":true}]},{"group":"Schema mappings","pages":[{"title":"Schema Mappings","sidebarTitle":"Schema Mappings","description":"Map CDF data to SAP schemas for writeback in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/sap-schema-mappings"},{"title":"Create Mappings","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nCreate a maximum of 100 mappings.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /writeback/sap/mappings","href":"/20230101-alpha/schema-mappings/create-mappings","autogeneratedByOpenApi":true},{"title":"Retrieve Mappings","description":"\n\n> **Required capabilities:** `sapWritebackAcl:READ`\n\nRetrieve a list of up to 100 mappings by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /writeback/sap/mappings/byids","href":"/20230101-alpha/schema-mappings/retrieve-mappings","autogeneratedByOpenApi":true},{"title":"Delete Mappings","description":"\n\n> **Required capabilities:** `sapWritebackAcl:WRITE`\n\nDelete a list of mappings by their external ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /writeback/sap/mappings/delete","href":"/20230101-alpha/schema-mappings/delete-mappings","autogeneratedByOpenApi":true}]},{"group":"Writeback requests","pages":[{"title":"Writeback Requests","sidebarTitle":"Overview","description":"Send data from CDF back to SAP systems.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/writeback-requests"},{"title":"Create Writeback Requests","description":"\n\n> **Required capabilities:** `sapWritebackRequestsAcl:WRITE`\n\nCreate a writeback request","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /writeback/sap/requests","href":"/20230101-alpha/writeback-requests/create-writeback-requests","autogeneratedByOpenApi":true},{"title":"Retrieve Writeback Requests","description":"\n\n> **Required capabilities:** `sapWritebackRequestsAcl:WRITE`\n\nRetrieve a list of up to 100 writeback requests by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /writeback/sap/requests/byids","href":"/20230101-alpha/writeback-requests/retrieve-writeback-requests","autogeneratedByOpenApi":true}]}]}]},{"group":"Contextualization","icon":"puzzle","expanded":true,"pages":[{"title":"Contextualization","sidebarTitle":"Overview","description":"Match entities, extract features from engineering diagrams, and analyze images in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/contextualization"},{"group":"Entity matching","pages":[{"title":"Entity matching","sidebarTitle":"Overview","description":"Match entities across data sources in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/entity-matching"},{"title":"Create entity matcher model","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE`\n\nTrain a model that predicts matches between entities (for example, time series names to asset names). This is also known as fuzzy joining. If there are no trueMatches (labeled data), you train a static (unsupervised) model, otherwise a machine learned (supervised) model is trained.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/entitymatching","href":"/20230101-alpha/entity-matching/create-entity-matcher-model","autogeneratedByOpenApi":true},{"title":"Delete entity matcher model","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE`\n\nDeletes an entity matching model. Currently, this is a soft delete, and only removes the entry from listing.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/entitymatching/delete","href":"/20230101-alpha/entity-matching/delete-entity-matcher-model","autogeneratedByOpenApi":true},{"title":"Filter models","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nUse filtering options to find entity matcher models.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/entitymatching/list","href":"/20230101-alpha/entity-matching/filter-models","autogeneratedByOpenApi":true},{"title":"List entity matching models","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nList all available entity matching models, with pagination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/entitymatching","href":"/20230101-alpha/entity-matching/list-entity-matching-models","autogeneratedByOpenApi":true},{"title":"Retrieve an entity matching model by the ID of the model","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nShows the status of the model. If the status is completed, shows the parameters used to train the model.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/entitymatching/{id}","href":"/20230101-alpha/entity-matching/retrieve-an-entity-matching-model-by-the-id-of-the-model","autogeneratedByOpenApi":true},{"title":"Predict matches","description":"Predicts matches with a trained model. Requires `entitymatchingAcl:WRITE`. See [Predict and refit](/api-reference/concepts/20230101/entity-matching#predict-and-refit).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/entitymatching/predict","href":"/20230101-alpha/entity-matching/predict-matches","autogeneratedByOpenApi":true},{"title":"Re-fit entity matcher model","description":"Trains a new model from confirmed matches. The original model stays unchanged. Requires `entitymatchingAcl:READ` and `entitymatchingAcl:WRITE`. See [Predict and refit](/api-reference/concepts/20230101/entity-matching#predict-and-refit).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/entitymatching/refit","href":"/20230101-alpha/entity-matching/re-fit-entity-matcher-model","autogeneratedByOpenApi":true},{"title":"Retrieve entity matcher predict results","description":"\n\n> **Required capabilities:** `assetsAcl:READ` `entitymatchingAcl:WRITE`\n\nGet the results from a predict job. Note: 'assetsAcl:READ' capability is required, unless you specify a valid `X-Job-Token` in the request header. The `X-Job-Token` is provided in the response header of the initial call to `/context/entitymatching/predict`","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/entitymatching/jobs/{jobId}","href":"/20230101-alpha/entity-matching/retrieve-entity-matcher-predict-results","autogeneratedByOpenApi":true},{"title":"Retrieve entity matching models","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nRetrieve entity matching models by IDs or external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/entitymatching/byids","href":"/20230101-alpha/entity-matching/retrieve-entity-matching-models","autogeneratedByOpenApi":true},{"title":"Update entity matching models","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE`\n\nUpdate entity matching models by IDs or external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/entitymatching/update","href":"/20230101-alpha/entity-matching/update-entity-matching-models","autogeneratedByOpenApi":true},{"group":"Pipelines","pages":[{"title":"List pipelines","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ` `assetsAcl:READ`\n\nList entity matching pipelines.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/entitymatching/pipelines","href":"/20230101-alpha/entity-matching-pipelines/list-pipelines","autogeneratedByOpenApi":true},{"title":"Get pipeline","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ` `assetsAcl:READ`\n\nGet entity matching pipeline.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/entitymatching/pipelines/{pipelineId}","href":"/20230101-alpha/entity-matching-pipelines/get-pipeline","autogeneratedByOpenApi":true},{"title":"List pipeline runs","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ` `assetsAcl:READ`\n\nList runs for an entity matching pipeline.\n\nThis endpoint returns run summaries. If you want to get the complete results for a single run, use\nthe [run results get](#tag/Entity-matching-pipelines/operation/entityMatchingPipelineRunGet) endpoint.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/entitymatching/pipelines/{pipelineId}/runs","href":"/20230101-alpha/entity-matching-pipelines/list-pipeline-runs","autogeneratedByOpenApi":true},{"title":"Get latest pipeline run results","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ` `assetsAcl:READ`\n\nGet the results of the latest run of an entity matching pipeline.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/entitymatching/pipelines/{pipelineId}/runs/latest","href":"/20230101-alpha/entity-matching-pipelines/get-latest-pipeline-run-results","autogeneratedByOpenApi":true},{"title":"Get pipeline run results","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ` `assetsAcl:READ`\n\nGet the results of a specific run of an entity matching pipeline.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/entitymatching/pipelines/{pipelineId}/runs/{runId}","href":"/20230101-alpha/entity-matching-pipelines/get-pipeline-run-results","autogeneratedByOpenApi":true},{"title":"Create pipelines","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE` `assetsAcl:READ` `timeSeriesAcl:READ` `eventsAcl:READ` `sequencesAcl:READ` `filesAcl:READ`\n\nCreate entity matching pipelines.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/entitymatching/pipelines","href":"/20230101-alpha/entity-matching-pipelines/create-pipelines","autogeneratedByOpenApi":true},{"title":"Retrieve multiple pipelines","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ` `assetsAcl:READ`\n\nRetrieve multiple entity matching pipelines.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/entitymatching/pipelines/byids","href":"/20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines","autogeneratedByOpenApi":true},{"title":"Delete pipelines","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE` `assetsAcl:READ`\n\nDelete entity matching pipelines.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/entitymatching/pipelines/delete","href":"/20230101-alpha/entity-matching-pipelines/delete-pipelines","autogeneratedByOpenApi":true},{"title":"Update pipelines","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE` `assetsAcl:READ` `timeSeriesAcl:READ` `eventsAcl:READ` `sequencesAcl:READ` `filesAcl:READ`\n\nUpdate entity matching pipelines.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/entitymatching/pipelines/update","href":"/20230101-alpha/entity-matching-pipelines/update-pipelines","autogeneratedByOpenApi":true},{"title":"Run pipeline","description":"Runs a pipeline and returns confirmed, rule, or model matches. Requires `entitymatchingAcl:READ` and `assetsAcl:READ`. See [Pipeline runs](/api-reference/concepts/20230101/entity-matching#pipeline-runs).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/entitymatching/pipelines/{pipelineId}/runs","href":"/20230101-alpha/entity-matching-pipelines/run-pipeline","autogeneratedByOpenApi":true}]}]},{"group":"Engineering diagrams","pages":[{"title":"Engineering diagrams","sidebarTitle":"Overview","description":"Detect and convert engineering diagrams in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/engineering-diagrams"},{"title":"Convert a diagram to image format","description":"Converts a diagram to PNG or SVG. Only SVG embeds annotations. Requires `assetsAcl:READ` and `filesAcl:READ`. See [Detect and convert](/api-reference/concepts/20230101/engineering-diagrams#detect-and-convert).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/diagram/convert","href":"/20230101-alpha/engineering-diagrams/convert-a-diagram-to-image-format","autogeneratedByOpenApi":true},{"title":"Detect annotations in engineering diagrams","description":"Detects annotations in a PDF, JPEG, PNG, or TIFF diagram. Requires `assetsAcl:READ` and `filesAcl:READ`. See [Detect and convert](/api-reference/concepts/20230101/engineering-diagrams#detect-and-convert).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/diagram/detect","href":"/20230101-alpha/engineering-diagrams/detect-annotations-in-engineering-diagrams","autogeneratedByOpenApi":true},{"title":"Retrieve OCR text","description":"\n\n> **Required capabilities:** `filesAcl:READ`\n\nProvides ocr annotations for a given file. Currently only files that have been parsed with diagram/detect\nwill yield non-empty results.\n\nIn beta. Available only when the `cdf-version` header with the `beta` suffix value is provided.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/diagram/ocr","href":"/20230101-alpha/engineering-diagrams/retrieve-ocr-text","autogeneratedByOpenApi":true},{"title":"Get the results for converting an engineering diagram to an image","description":"\n\n> **Required capabilities:** `assetsAcl:READ` `filesAcl:READ`\n\nGet the results for converting an engineering diagram to SVG and PNG formats.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/diagram/convert/{jobId}","href":"/20230101-alpha/engineering-diagrams/get-the-results-for-converting-an-engineering-diagram-to-an-image","autogeneratedByOpenApi":true},{"title":"Retrieve engineering diagram detect results","description":"\n\n> **Required capabilities:** `assetsAcl:READ` `filesAcl:READ`\n\nGet the results from an engineering diagram detect job. Providing the `X-Job-Token` header returned by the\n`/context/diagram/detect` endpoint is required unless the caller has read access to all assets. Results are available for 30 days following the completion of the detect job.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/diagram/detect/{jobId}","href":"/20230101-alpha/engineering-diagrams/retrieve-engineering-diagram-detect-results","autogeneratedByOpenApi":true}]},{"group":"Diagram parsing","pages":[{"group":"Parsing","pages":[{"title":"Run parsing with tag detection for files","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE` `dataModelInstancesAcl:WRITE`\n\nA parsing job will be started on the files to detect their entities and connections and map assets.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /api/v1/projects/{project}/diagram-parsing/parsing/full","href":"/20230101-alpha/parsing/run-parsing-with-tag-detection-for-files","autogeneratedByOpenApi":true},{"title":"Run an instant parsing job for a file","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nStart an instant parsing job on a file to detect diagram symbols based on the specified library. Parsed outputs do not persist.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/parsing/instant","href":"/20230101-alpha/parsing/run-an-instant-parsing-job-for-a-file","autogeneratedByOpenApi":true},{"title":"Run parsing for files","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nStart a parsing job on files to detect their symbols and connections.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/parsing/symbol-detection","href":"/20230101-alpha/parsing/run-parsing-for-files","autogeneratedByOpenApi":true}]},{"group":"Libraries","pages":[{"title":"List libraries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nList all libraries defined in the current project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /diagram-parsing/libraries","href":"/20230101-alpha/libraries/list-libraries","autogeneratedByOpenApi":true},{"title":"Get a library with symbols","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nReturns a single library with all its symbols and geometries.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /diagram-parsing/libraries/{libraryId}","href":"/20230101-alpha/libraries/get-a-library-with-symbols","autogeneratedByOpenApi":true},{"title":"Create libraries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nCreate libraries.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/libraries","href":"/20230101-alpha/libraries/create-libraries","autogeneratedByOpenApi":true},{"title":"Retrieve libraries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nRetrieve up to 100 libraries by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/libraries/byids","href":"/20230101-alpha/libraries/retrieve-libraries","autogeneratedByOpenApi":true},{"title":"Delete libraries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nDelete up to 100 libraries by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/libraries/delete","href":"/20230101-alpha/libraries/delete-libraries","autogeneratedByOpenApi":true},{"title":"Update libraries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nUpdate the properties of a set of libraries.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/libraries/update","href":"/20230101-alpha/libraries/update-libraries","autogeneratedByOpenApi":true},{"title":"Copy library","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nCreates a new library by copying an existing library, including all its symbols and geometries.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/libraries/{libraryId}/copy","href":"/20230101-alpha/libraries/copy-library","autogeneratedByOpenApi":true}]},{"group":"Symbols","pages":[{"title":"List symbols","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nList all symbols defined in the current project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /diagram-parsing/symbols","href":"/20230101-alpha/symbols/list-symbols","autogeneratedByOpenApi":true},{"title":"Create symbols","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nCreate symbols","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/symbols","href":"/20230101-alpha/symbols/create-symbols","autogeneratedByOpenApi":true},{"title":"Retrieve symbols","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nRetrieve up to 100 symbols by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/symbols/byids","href":"/20230101-alpha/symbols/retrieve-symbols","autogeneratedByOpenApi":true},{"title":"Delete symbols","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nDelete up to 100 symbols by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/symbols/delete","href":"/20230101-alpha/symbols/delete-symbols","autogeneratedByOpenApi":true},{"title":"Update symbols","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nUpdate the properties of a set of symbols","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/symbols/update","href":"/20230101-alpha/symbols/update-symbols","autogeneratedByOpenApi":true}]},{"group":"Geometries","pages":[{"title":"List geometries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nList all geometries (also called variants in documentation) defined in the current project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /diagram-parsing/geometries","href":"/20230101-alpha/geometries/list-geometries","autogeneratedByOpenApi":true},{"title":"Create geometries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nCreate geometries.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/geometries","href":"/20230101-alpha/geometries/create-geometries","autogeneratedByOpenApi":true},{"title":"Retrieve geometries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nRetrieve up to 100 geometries by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/geometries/byids","href":"/20230101-alpha/geometries/retrieve-geometries","autogeneratedByOpenApi":true},{"title":"Delete geometries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nDelete up to 100 geometries by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/geometries/delete","href":"/20230101-alpha/geometries/delete-geometries","autogeneratedByOpenApi":true},{"title":"Update geometries","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nUpdate the properties of a set of geometries","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/geometries/update","href":"/20230101-alpha/geometries/update-geometries","autogeneratedByOpenApi":true}]},{"group":"Diagrams","pages":[{"title":"List diagrams","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nList all diagrams defined in the current project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /diagram-parsing/diagrams","href":"/20230101-alpha/diagrams/list-diagrams","autogeneratedByOpenApi":true},{"title":"Get an extended diagram by external id","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nGet diagram information and its parsed outputs using the diagram ID. The parsed output includes all diagram entities and their connections extracted during the file parsing process.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /diagram-parsing/diagrams/{diagramId}","href":"/20230101-alpha/diagrams/get-an-extended-diagram-by-external-id","autogeneratedByOpenApi":true},{"title":"Get an extended diagram with paths by external id","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nGet a single diagram containing entities, connections, and SVG data by using its external id","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /diagram-parsing/diagrams/{diagramId}/with-paths","href":"/20230101-alpha/diagrams/get-an-extended-diagram-with-paths-by-external-id","autogeneratedByOpenApi":true},{"title":"Get an extended diagram by file reference","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nGet diagram information and its parsed outputs using its related fileId and pageNumber. The parsed output includes all diagram entities and their connections extracted during the file parsing process.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /diagram-parsing/diagrams/{fileSpace}/{fileExternalId}/{pageNumber}","href":"/20230101-alpha/diagrams/get-an-extended-diagram-by-file-reference","autogeneratedByOpenApi":true},{"title":"Retrieve diagrams","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nRetrieve up to 100 diagrams by specifying their external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/diagrams/byids","href":"/20230101-alpha/diagrams/retrieve-diagrams","autogeneratedByOpenApi":true},{"title":"Filter diagrams","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nFilter and retrieve up to 100 diagrams by specifying their properties.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/diagrams/list","href":"/20230101-alpha/diagrams/filter-diagrams","autogeneratedByOpenApi":true}]},{"group":"Entities","pages":[{"title":"List diagram entities","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nList all diagram entities defined for the diagram specified by the diagramId parameter.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /diagram-parsing/entities","href":"/20230101-alpha/entities/list-diagram-entities","autogeneratedByOpenApi":true},{"title":"Create diagram entities","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nCreate diagram entities.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/entities","href":"/20230101-alpha/entities/create-diagram-entities","autogeneratedByOpenApi":true},{"title":"Retrieve diagram entities","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nRetrieve up to 100 diagram entities by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/entities/byids","href":"/20230101-alpha/entities/retrieve-diagram-entities","autogeneratedByOpenApi":true},{"title":"Delete diagram entities","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nDelete up to 100 diagram entities by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/entities/delete","href":"/20230101-alpha/entities/delete-diagram-entities","autogeneratedByOpenApi":true},{"title":"Update diagram entities","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nUpdate the properties of a set of diagram entities","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/entities/update","href":"/20230101-alpha/entities/update-diagram-entities","autogeneratedByOpenApi":true}]},{"group":"Connections","pages":[{"title":"List connections","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nList all connections defined in the current project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /diagram-parsing/connections","href":"/20230101-alpha/connections/list-connections","autogeneratedByOpenApi":true},{"title":"Create connections","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nCreate connections between symbols in parsed diagrams.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/connections","href":"/20230101-alpha/connections/create-connections","autogeneratedByOpenApi":true},{"title":"Retrieve connections","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ`\n\nRetrieve up to 100 connections by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/connections/byids","href":"/20230101-alpha/connections/retrieve-connections","autogeneratedByOpenApi":true},{"title":"Delete connections","description":"\n\n> **Required capabilities:** `diagramParsingAcl:WRITE`\n\nDelete up to 100 connections by specifying their IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /diagram-parsing/connections/delete","href":"/20230101-alpha/connections/delete-connections","autogeneratedByOpenApi":true}]},{"group":"SVG Data","pages":[{"title":"Get SVG data by diagramId","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ` `dataModelInstancesAcl:READ`\n\nGet the SVG data of a file by externalId of a diagram.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /diagram-parsing/svg-data/diagram/{diagramId}","href":"/20230101-alpha/svg-data/get-svg-data-by-diagramid","autogeneratedByOpenApi":true},{"title":"Get SVG data by file reference","description":"\n\n> **Required capabilities:** `diagramParsingAcl:READ` `dataModelInstancesAcl:READ`\n\nGet the SVG data of a file by file instanceId and pageNumber.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /diagram-parsing/svg-data/file/{fileSpace}/{fileExternalId}/{pageNumber}","href":"/20230101-alpha/svg-data/get-svg-data-by-file-reference","autogeneratedByOpenApi":true}]}]},{"group":"Vision","pages":[{"title":"Vision","sidebarTitle":"Overview","description":"Extract features from images in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/vision"},{"title":"Extract features from images","description":"Starts an image feature extraction job. A project can run 20 jobs at once. Requires `filesAcl:READ`. See [Extract](/api-reference/concepts/20230101/vision#extract).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/vision/extract","href":"/20230101-alpha/vision/extract-features-from-images","autogeneratedByOpenApi":true},{"title":"Retrieve results from a feature extraction job on images","description":"Returns completed extract batches while the job is still running. Requires `filesAcl:READ`. See [Extract](/api-reference/concepts/20230101/vision#extract).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/vision/extract/{jobId}","href":"/20230101-alpha/vision/retrieve-results-from-a-feature-extraction-job-on-images","autogeneratedByOpenApi":true},{"title":"Segment objects in an image","description":"Starts an image segmentation job from points or a bounding box. Requires `filesAcl:READ`. See [Segment](/api-reference/concepts/20230101/vision#segment).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/vision/segment","href":"/20230101-alpha/vision/segment-objects-in-an-image","autogeneratedByOpenApi":true},{"title":"Retrieve results from a segmentation job on an image","description":"\n\n> **Required capabilities:** `filesAcl:READ`\n\nRetrieve results from a segmentation job on an image.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/vision/segment/{jobId}","href":"/20230101-alpha/vision/retrieve-results-from-a-segmentation-job-on-an-image","autogeneratedByOpenApi":true}]},{"group":"Advanced joins","pages":[{"title":"List advanced joins","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nList advanced join objects.\n\nYou can use the query parameters to add filters to the query.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /advancedjoins","href":"/20230101-alpha/advanced-joins/list-advanced-joins","autogeneratedByOpenApi":true},{"title":"Retrieve estimate quality status","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nGet the status of an estimate quality job.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /advancedjoins/estimatequality/{jobId}","href":"/20230101-alpha/advanced-joins/retrieve-estimate-quality-status","autogeneratedByOpenApi":true},{"title":"List matches","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nList matches","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /advancedjoins/matches","href":"/20230101-alpha/advanced-joins/list-matches","autogeneratedByOpenApi":true},{"title":"Retrieve mapped percentage status","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nGet the status of an job to measure mapped percentages.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /advancedjoins/measuremappedpercentage/{jobId}","href":"/20230101-alpha/advanced-joins/retrieve-mapped-percentage-status","autogeneratedByOpenApi":true},{"title":"Retrieve advanced join run status","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nGet the status of an advanced join run job.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /advancedjoins/run/{jobId}","href":"/20230101-alpha/advanced-joins/retrieve-advanced-join-run-status","autogeneratedByOpenApi":true},{"title":"Retrieve suggested improvements","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nRetrieve the output of a suggest improvements job.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /advancedjoins/suggestimprovements/{jobId}","href":"/20230101-alpha/advanced-joins/retrieve-suggested-improvements","autogeneratedByOpenApi":true},{"title":"Create advanced joins","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE`\n\nCreate new advanced join objects.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /advancedjoins","href":"/20230101-alpha/advanced-joins/create-advanced-joins","autogeneratedByOpenApi":true},{"title":"Delete advanced joins","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE`\n\nDelete advanced join objects.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /advancedjoins/delete","href":"/20230101-alpha/advanced-joins/delete-advanced-joins","autogeneratedByOpenApi":true},{"title":"Estimate contextualization quality","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nEstimate the contextualization quality of an advanced join using the matches (truth values) as reference.\n\nThe caller needs to have read access to the view they are querying.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /advancedjoins/estimatequality","href":"/20230101-alpha/advanced-joins/estimate-contextualization-quality","autogeneratedByOpenApi":true},{"title":"Create matches","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE`\n\nCreate matches","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /advancedjoins/matches","href":"/20230101-alpha/advanced-joins/create-matches","autogeneratedByOpenApi":true},{"title":"Delete matches","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE`\n\nDelete matches","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /advancedjoins/matches/delete","href":"/20230101-alpha/advanced-joins/delete-matches","autogeneratedByOpenApi":true},{"title":"Measure mapped percentages","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nMeasure the proportion of mapped instances in the advanced join's view, for each property.\n\nThe caller needs to have read access to the view they are querying.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /advancedjoins/measuremappedpercentage","href":"/20230101-alpha/advanced-joins/measure-mapped-percentages","autogeneratedByOpenApi":true},{"title":"Run an advanced join","description":"Writes matcher results onto a direct relation. Alpha only. Requires `entitymatchingAcl:WRITE`. See [Advanced joins](/api-reference/concepts/20230101-alpha/entity-matching#advanced-joins).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /advancedjoins/run","href":"/20230101-alpha/advanced-joins/run-an-advanced-join","autogeneratedByOpenApi":true},{"title":"Suggest improvements","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ`\n\nPredicts which unmatched instances are most likely to increase data quality if matched.\n\nThe caller needs to have read access to the view they are querying.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /advancedjoins/suggestimprovements","href":"/20230101-alpha/advanced-joins/suggest-improvements","autogeneratedByOpenApi":true},{"title":"Update advanced joins","description":"\n\n> **Required capabilities:** `entitymatchingAcl:WRITE`\n\nUpdate advanced join objects.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /advancedjoins/update","href":"/20230101-alpha/advanced-joins/update-advanced-joins","autogeneratedByOpenApi":true}]}]},{"group":"Data lifecycle","icon":"git-branch","expanded":true,"pages":[{"group":"Data ingestion","pages":[{"title":"Data ingestion","sidebarTitle":"Overview","description":"Ingest data into Cognite Data Fusion (CDF) using Raw, extraction pipelines, extractors, and hosted extractors.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/data-ingestion"},{"group":"Raw","pages":[{"title":"Raw","sidebarTitle":"Overview","description":"Manage raw NoSQL databases in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/raw"},{"title":"Create databases","description":"\n\n> **Required capabilities:** `rawAcl:WRITE`\n\nCreate databases in a project. It is possible to post a maximum of 1000 databases per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /raw/dbs","href":"/20230101-alpha/raw/create-databases","autogeneratedByOpenApi":true},{"title":"Delete databases","description":"\n\n> **Required capabilities:** `rawAcl:WRITE`\n\nIt deletes a database, but fails if the database is not empty and recursive is set to false (default).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /raw/dbs/delete","href":"/20230101-alpha/raw/delete-databases","autogeneratedByOpenApi":true},{"title":"Create tables in a database","description":"\n\n> **Required capabilities:** `rawAcl:WRITE`\n\nCreate tables in a database. It is possible to post a maximum of 1000 tables per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /raw/dbs/{dbName}/tables","href":"/20230101-alpha/raw/create-tables-in-a-database","autogeneratedByOpenApi":true},{"title":"Delete tables in a database","description":"\n\n> **Required capabilities:** `rawAcl:WRITE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /raw/dbs/{dbName}/tables/delete","href":"/20230101-alpha/raw/delete-tables-in-a-database","autogeneratedByOpenApi":true},{"title":"Insert rows into a table","description":"Inserts or replaces up to 10,000 rows. A failed request can leave a partial write. Requires `rawAcl:WRITE`. See [Insert rows](/api-reference/concepts/20230101/raw#insert-rows).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /raw/dbs/{dbName}/tables/{tableName}/rows","href":"/20230101-alpha/raw/insert-rows-into-a-table","autogeneratedByOpenApi":true},{"title":"Delete rows in a table","description":"\n\n> **Required capabilities:** `rawAcl:WRITE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /raw/dbs/{dbName}/tables/{tableName}/rows/delete","href":"/20230101-alpha/raw/delete-rows-in-a-table","autogeneratedByOpenApi":true},{"title":"List databases","description":"\n\n> **Required capabilities:** `rawAcl:LIST`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /raw/dbs","href":"/20230101-alpha/raw/list-databases","autogeneratedByOpenApi":true},{"title":"List tables in a database","description":"\n\n> **Required capabilities:** `rawAcl:LIST`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /raw/dbs/{dbName}/tables","href":"/20230101-alpha/raw/list-tables-in-a-database","autogeneratedByOpenApi":true},{"title":"Retrieve cursors for parallel reads","description":"Returns cursors for parallel row reads. Requires `rawAcl:READ`. See [Cursors](/api-reference/concepts/20230101/raw#cursors).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /raw/dbs/{dbName}/tables/{tableName}/cursors","href":"/20230101-alpha/raw/retrieve-cursors-for-parallel-reads","autogeneratedByOpenApi":true},{"title":"Retrieve rows from a table","description":"\n\n> **Required capabilities:** `rawAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /raw/dbs/{dbName}/tables/{tableName}/rows","href":"/20230101-alpha/raw/retrieve-rows-from-a-table","autogeneratedByOpenApi":true},{"title":"Retrieve row by key","description":"\n\n> **Required capabilities:** `rawAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /raw/dbs/{dbName}/tables/{tableName}/rows/{rowKey}","href":"/20230101-alpha/raw/retrieve-row-by-key","autogeneratedByOpenApi":true}]},{"group":"Extraction pipelines","pages":[{"title":"Extraction Pipelines","sidebarTitle":"Overview","description":"Manage extraction pipelines in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/extraction-pipelines"},{"title":"Create extraction pipelines","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:WRITE` `datasetsAcl:READ`\n\nCreates multiple new extraction pipelines. A maximum of 1000 extraction pipelines can be created per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /extpipes","href":"/20230101-alpha/extraction-pipelines/create-extraction-pipelines","autogeneratedByOpenApi":true},{"title":"Delete extraction pipelines","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:WRITE` `datasetsAcl:READ`\n\nDelete extraction pipelines for given list of ids and externalIds. When the extraction pipeline is deleted, all extraction pipeline runs related to the extraction pipeline are automatically deleted.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /extpipes/delete","href":"/20230101-alpha/extraction-pipelines/delete-extraction-pipelines","autogeneratedByOpenApi":true},{"title":"Filter extraction pipelines","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:READ`\n\nUse advanced filtering options to find extraction pipelines.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /extpipes/list","href":"/20230101-alpha/extraction-pipelines/filter-extraction-pipelines","autogeneratedByOpenApi":true},{"title":"Retrieve an extraction pipeline by its ID.","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:READ`\n\nRetrieve an extraction pipeline by its ID. If you want to retrieve extraction pipelines by externalIds, use Retrieve extraction pipelines instead.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /extpipes/{id}","href":"/20230101-alpha/extraction-pipelines/retrieve-an-extraction-pipeline-by-its-id","autogeneratedByOpenApi":true},{"title":"Retrieve extraction pipelines","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:READ`\n\nRetrieves information about multiple extraction pipelines in the same project. All ids and externalIds must be unique.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /extpipes/byids","href":"/20230101-alpha/extraction-pipelines/retrieve-extraction-pipelines","autogeneratedByOpenApi":true},{"title":"Update extraction pipelines","description":"\n\n> **Required capabilities:** `extractionpipelinesAcl:WRITE` `datasetsAcl:READ`\n\nUpdate information for a list of extraction pipelines. Fields that are not included in the request, are not changed.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /extpipes/update","href":"/20230101-alpha/extraction-pipelines/update-extraction-pipelines","autogeneratedByOpenApi":true}]},{"group":"Extraction pipelines runs","pages":[{"title":"Extraction Pipelines Runs","sidebarTitle":"Overview","description":"Track extraction pipeline run statuses in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/extraction-pipelines-runs"},{"title":"Create extraction pipeline runs","description":"Creates one extraction pipeline run. Requires `extractionrunsAcl:WRITE` and `datasetsAcl:READ`. See [Run statuses](/api-reference/concepts/20230101/extraction-pipelines-runs#run-statuses).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /extpipes/runs","href":"/20230101-alpha/extraction-pipelines-runs/create-extraction-pipeline-runs","autogeneratedByOpenApi":true},{"title":"Filter extraction pipeline runs","description":"\n\n> **Required capabilities:** `extractionrunsAcl:READ`\n\nUse advanced filtering options to find extraction pipeline runs. Sorted by createdTime value with descendant order.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /extpipes/runs/list","href":"/20230101-alpha/extraction-pipelines-runs/filter-extraction-pipeline-runs","autogeneratedByOpenApi":true}]},{"group":"Extraction pipelines config","pages":[{"title":"Extraction Pipelines Config","sidebarTitle":"Overview","description":"Manage extraction pipeline configurations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/extraction-pipelines-config"},{"title":"Create extraction configuration revision","description":"\n\n> **Required capabilities:** `extractionconfigsAcl:WRITE`\n\nCreates a configuration revision for the given extraction pipeline.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /extpipes/config","href":"/20230101-alpha/extraction-pipelines-config/create-extraction-configuration-revision","autogeneratedByOpenApi":true},{"title":"Get a single configuration revision","description":"\n\n> **Required capabilities:** `extractionconfigsAcl:READ`\n\nRetrieves a single configuration revision. By default, the latest revision is retrieved.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /extpipes/config","href":"/20230101-alpha/extraction-pipelines-config/get-a-single-configuration-revision","autogeneratedByOpenApi":true},{"title":"List configuration revisions","description":"\n\n> **Required capabilities:** `extractionconfigsAcl:READ`\n\nLists configuration revisions for the given extraction pipeline.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /extpipes/config/revisions","href":"/20230101-alpha/extraction-pipelines-config/list-configuration-revisions","autogeneratedByOpenApi":true},{"title":"Revert configuration revision","description":"\n\n> **Required capabilities:** `extractionconfigsAcl:WRITE`\n\nReverts the latest configuration revision to an older revision. Equivalent to creating a new revision identical to the old revision.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /extpipes/config/revert","href":"/20230101-alpha/extraction-pipelines-config/revert-configuration-revision","autogeneratedByOpenApi":true}]},{"group":"Extractors","pages":[{"title":"Extractors","sidebarTitle":"Overview","description":"Discover available extractors in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/extractors"},{"title":"List Extractors","description":"List all available extractors.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /extractors","href":"/20230101-alpha/extractors/list-extractors","autogeneratedByOpenApi":true},{"title":"Retrieve Extractors","description":"Retrieve extractors by external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /extractors/byids","href":"/20230101-alpha/extractors/retrieve-extractors","autogeneratedByOpenApi":true},{"title":"List releases","description":"List releases for all extractors, or optionally for a single extractor. Results are sorted in descending version order.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /extractors/releases","href":"/20230101-alpha/extractors/list-releases","autogeneratedByOpenApi":true},{"title":"Retrieve Releases","description":"Retrieve releases by extractor external ID and version, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /extractors/releases/byids","href":"/20230101-alpha/extractors/retrieve-releases","autogeneratedByOpenApi":true},{"title":"List Source Systems","description":"List source systems. Source systems represent sources that extractors may read from. They are tied to extractors through Solutions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /extractors/sources","href":"/20230101-alpha/extractors/list-source-systems","autogeneratedByOpenApi":true},{"title":"Retrieve Source Systems","description":"Retrieve source systems. Source systems represent sources that extractors may read from. They are tied to extractors through Solutions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /extractors/sources/byids","href":"/20230101-alpha/extractors/retrieve-source-systems","autogeneratedByOpenApi":true},{"title":"List Solutions","description":"List solutions. Solutions connect sources to extractors, documenting how a specific extractor might be used to connect to a source system.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /extractors/solutions","href":"/20230101-alpha/extractors/list-solutions","autogeneratedByOpenApi":true},{"title":"Retrieve Solutions","description":"Retrieve solutions by external ID. Solutions connect sources to extractors, documenting how a specific extractor might be used to connect to a source system.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /extractors/solutions/byids","href":"/20230101-alpha/extractors/retrieve-solutions","autogeneratedByOpenApi":true},{"title":"Get Config Schema","description":"Retrieve the configuration schema for the specified extractor and release version. The configuration schema is a [JSON Schema](https://json-schema.org/) file.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /extractors/schemas/{extractor}/{version}","href":"/20230101-alpha/extractors/get-config-schema","autogeneratedByOpenApi":true}]},{"group":"Hosted extractors","pages":[{"title":"Hosted extractors","sidebarTitle":"Overview","description":"Manage hosted extractor sources, jobs, destinations, and mappings in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/hosted-extractors"},{"group":"Sources","pages":[{"title":"Sources","sidebarTitle":"Sources","description":"Manage hosted extractor sources in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/hosted-extractors-sources"},{"title":"Create Sources","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nCreate up to 100 sources.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/sources","href":"/20230101-alpha/sources/create-sources","autogeneratedByOpenApi":true},{"title":"Delete Sources","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nDelete a list of sources by their external ID. This operation will fail if any destination in the request is associated with a job, unless the `force` query parameter is set to `true`.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/sources/delete","href":"/20230101-alpha/sources/delete-sources","autogeneratedByOpenApi":true},{"title":"List Sources","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nList all sources in a given project. If more than `limit` sources exist, a cursor for pagination will be returned with the response.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /hostedextractors/sources","href":"/20230101-alpha/sources/list-sources","autogeneratedByOpenApi":true},{"title":"Retrieve Sources","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nRetrieve a list of up to 100 sources by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/sources/byIds","href":"/20230101-alpha/sources/retrieve-sources","autogeneratedByOpenApi":true},{"title":"Update Sources","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nUpdate up to 100 sources.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/sources/update","href":"/20230101-alpha/sources/update-sources","autogeneratedByOpenApi":true}]},{"group":"Jobs","pages":[{"title":"Jobs","sidebarTitle":"Jobs","description":"Manage hosted extractor jobs in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/hosted-extractors-jobs"},{"title":"Create Jobs","description":"\n\n> **Required capabilities:** `hostedExtractors:READ` `hostedExtractors:WRITE`\n\nCreate up to 10 jobs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/jobs","href":"/20230101-alpha/jobs/create-jobs","autogeneratedByOpenApi":true},{"title":"Delete Jobs","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nDelete a list of jobs by their external ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/jobs/delete","href":"/20230101-alpha/jobs/delete-jobs","autogeneratedByOpenApi":true},{"title":"Get Job Logs","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nList logs, optionally filtering on job, source, or destination. Logs are retrieved in reverse chronological order.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /hostedextractors/jobs/logs","href":"/20230101-alpha/jobs/get-job-logs","autogeneratedByOpenApi":true},{"title":"Get Job DLQ Messages","description":"Lists dead letter queue messages for a job. Requires `hostedExtractors:READ` and `rawAcl:READ`. See [Dead letter queue](/api-reference/concepts/20230101/hosted-extractors-jobs#dead-letter-queue).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /hostedextractors/jobs/dlq","href":"/20230101-alpha/jobs/get-job-dlq-messages","autogeneratedByOpenApi":true},{"title":"Get Job Metrics","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nList metrics, optionally filtering on job, source, or destination. Logs are retrieved in reverse chronological order.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /hostedextractors/jobs/metrics","href":"/20230101-alpha/jobs/get-job-metrics","autogeneratedByOpenApi":true},{"title":"Retrieve Jobs","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nRetrieve a list of up to 100 jobs by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/jobs/byIds","href":"/20230101-alpha/jobs/retrieve-jobs","autogeneratedByOpenApi":true},{"title":"Update Jobs","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nUpdate a list of up to 100 jobs. Enabling the dead letter queue for a job, or moving a job that has it enabled to a different destination, requires the job's destination credentials to have write access to CDF RAW, in addition to `hostedExtractors:WRITE`. Before updating, the destination session is refreshed and the DLQ storage for the job is created. The request fails with status 400 if the destination has no session, the session cannot be refreshed, or the session lacks RAW write access. It fails with status 502 if CDF cannot be reached or RAW returns a server error during this check. If the check fails for any job, no jobs in the request are updated. The check is not run for jobs that already have the dead letter queue enabled and keep their destination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/jobs/update","href":"/20230101-alpha/jobs/update-jobs","autogeneratedByOpenApi":true}]},{"group":"Destinations","pages":[{"title":"Destinations","sidebarTitle":"Destinations","description":"Manage hosted extractor destinations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/hosted-extractors-destinations"},{"title":"Create Destinations","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nCreate up to 100 destinations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/destinations","href":"/20230101-alpha/destinations/create-destinations","autogeneratedByOpenApi":true},{"title":"Delete Destinations","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nDelete a list of destinations by their external ID. This operation will fail if any destination in the request is associated with a job, unless the `force` query parameter is set to `true`.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/destinations/delete","href":"/20230101-alpha/destinations/delete-destinations","autogeneratedByOpenApi":true},{"title":"Retrieve Destinations","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nRetrieve a list of up to 100 destinations by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/destinations/byIds","href":"/20230101-alpha/destinations/retrieve-destinations","autogeneratedByOpenApi":true},{"title":"Update Destinations","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nUpdate up to 100 destinations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/destinations/update","href":"/20230101-alpha/destinations/update-destinations","autogeneratedByOpenApi":true}]},{"group":"Mappings","pages":[{"title":"Mappings","sidebarTitle":"Mappings","description":"Manage hosted extractor mappings in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/hosted-extractors-mappings"},{"title":"Create Mappings","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nCreate up to 100 mappings.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/mappings","href":"/20230101-alpha/mappings/create-mappings","autogeneratedByOpenApi":true},{"title":"Delete Mappings","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nDelete a list of mappings by their external ID. This operation will fail if any mapping in the request is associated with a job, unless the `force` query parameter is set to `true`.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/mappings/delete","href":"/20230101-alpha/mappings/delete-mappings","autogeneratedByOpenApi":true},{"title":"Retrieve Mappings","description":"\n\n> **Required capabilities:** `hostedExtractors:READ`\n\nRetrieve a list of up to 100 mappings by their external ID, optionally ignoring unknown IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/mappings/byIds","href":"/20230101-alpha/mappings/retrieve-mappings","autogeneratedByOpenApi":true},{"title":"Update Mappings","description":"\n\n> **Required capabilities:** `hostedExtractors:WRITE`\n\nUpdate up to 100 mappings.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/mappings/update","href":"/20230101-alpha/mappings/update-mappings","autogeneratedByOpenApi":true}]},{"group":"Previews","pages":[{"title":"Create Preview","description":"Starts a preview that stores one message from a source. See [Previews](/api-reference/concepts/20230101/hosted-extractors#previews).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/preview","href":"/20230101-alpha/previews/create-preview","autogeneratedByOpenApi":true},{"title":"Download preview result","description":"Downloads the stored preview payload. See [Previews](/api-reference/concepts/20230101/hosted-extractors#previews).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/preview/download","href":"/20230101-alpha/previews/download-preview-result","autogeneratedByOpenApi":true},{"title":"Get preview result","description":"Returns the stored preview result. See [Previews](/api-reference/concepts/20230101/hosted-extractors#previews).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /hostedextractors/preview/result","href":"/20230101-alpha/previews/get-preview-result","autogeneratedByOpenApi":true}]}]}]},{"group":"Data organization","pages":[{"title":"Data organization","sidebarTitle":"Overview","description":"Govern ready-for-consumption data with data products in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/data-organization"},{"group":"Data products","pages":[{"title":"Data products","sidebarTitle":"Overview","description":"Govern ready-for-consumption data with data products and versioned views in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/data-products"},{"title":"Create a data product","description":"\n\n> **Required capabilities:** `dataProductsAcl:CREATE`\n\nCreates a new data product. Maximum 100 data products allowed per project. Request body must contain an 'items' array with up to 1 data product definition per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /dataproducts","href":"/20230101-alpha/data-products/create-a-data-product","autogeneratedByOpenApi":true},{"title":"List data products","description":"\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nList all data products, with pagination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /dataproducts","href":"/20230101-alpha/data-products/list-data-products","autogeneratedByOpenApi":true},{"title":"Get a data product","description":"\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nRetrieves a specific data product by its external identifier.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /dataproducts/{externalId}","href":"/20230101-alpha/data-products/get-a-data-product","autogeneratedByOpenApi":true},{"title":"Delete a data product","description":"\n\n> **Required capabilities:** `dataProductsAcl:DELETE`\n\nPermanently removes a data product. A data product can not be deleted if it contains versions. This operation cannot be undone.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /dataproducts/delete","href":"/20230101-alpha/data-products/delete-a-data-product","autogeneratedByOpenApi":true},{"title":"Update a data product","description":"\n\n> **Required capabilities:** `dataProductsAcl:UPDATE`\n\nUpdate the attributes of a data product. Fields that aren't included in the request aren't changed.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /dataproducts/update","href":"/20230101-alpha/data-products/update-a-data-product","autogeneratedByOpenApi":true},{"title":"Get data products","description":"\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nGet data products by externalId.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /dataproducts/byids","href":"/20230101-alpha/data-products/get-data-products","autogeneratedByOpenApi":true},{"title":"Create a data product version","description":"Creates one data product version. A product can have 10 versions. Requires `dataProductsAcl:UPDATE`. See [Limits](/api-reference/concepts/20230101/data-products#limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /dataproducts/{externalId}/versions","href":"/20230101-alpha/data-products/create-a-data-product-version","autogeneratedByOpenApi":true},{"title":"List data product versions","description":"\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nList all versions of a data product, with pagination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /dataproducts/{externalId}/versions","href":"/20230101-alpha/data-products/list-data-product-versions","autogeneratedByOpenApi":true},{"title":"Get a data product version","description":"\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nRetrieves a specific version of a data product by its semantic version.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /dataproducts/{externalId}/versions/{version}","href":"/20230101-alpha/data-products/get-a-data-product-version","autogeneratedByOpenApi":true},{"title":"Delete data product versions","description":"\n\n> **Required capabilities:** `dataProductsAcl:UPDATE`\n\nDeletes one or more versions of a data product. Accepts a list of semantic versions. When a version is deleted, access filter entries for that version are removed from all data product roles of the owning data product. This operation cannot be undone.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /dataproducts/{externalId}/versions/delete","href":"/20230101-alpha/data-products/delete-data-product-versions","autogeneratedByOpenApi":true},{"title":"Update data product version","description":"\n\n> **Required capabilities:** `dataProductsAcl:UPDATE`\n\nUpdate the attributes of a data product version. Fields that aren't included in the request aren't changed.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /dataproducts/{externalId}/versions/update","href":"/20230101-alpha/data-products/update-data-product-version","autogeneratedByOpenApi":true}]}]},{"group":"Transformations","pages":[{"title":"Transformations","sidebarTitle":"Overview","description":"Process and move data within Cognite Data Fusion (CDF) using SQL-based transformations.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/transformations-overview"},{"group":"Transformations","pages":[{"title":"Transformations","sidebarTitle":"Overview","description":"Create and manage data transformations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/transformations"},{"title":"Create transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nCreate a maximum of 1000 transformations per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations","href":"/20230101-alpha/transformations/create-transformations","autogeneratedByOpenApi":true},{"title":"Cancel a transformation","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/cancel","href":"/20230101-alpha/transformations/cancel-a-transformation","autogeneratedByOpenApi":true},{"title":"Delete transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nDelete a maximum of 1000 transformations by ids and externalIds per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/delete","href":"/20230101-alpha/transformations/delete-transformations","autogeneratedByOpenApi":true},{"title":"Filter transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nFilter transformations. Use nextCursor to paginate through the results.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/filter","href":"/20230101-alpha/transformations/filter-transformations","autogeneratedByOpenApi":true},{"title":"Retrieve transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nRetrieve a maximum of 1000 transformations by ids and externalIds per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/byids","href":"/20230101-alpha/transformations/retrieve-transformations","autogeneratedByOpenApi":true},{"title":"Run a transformation","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/run","href":"/20230101-alpha/transformations/run-a-transformation","autogeneratedByOpenApi":true},{"title":"Update transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nUpdate the attributes of transformations, maximum 1000 per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/update","href":"/20230101-alpha/transformations/update-transformations","autogeneratedByOpenApi":true}]},{"group":"Transformation jobs","pages":[{"title":"Transformation Jobs","sidebarTitle":"Overview","description":"Monitor transformation job executions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/transformation-jobs"},{"title":"List jobs","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /transformations/jobs","href":"/20230101-alpha/transformation-jobs/list-jobs","autogeneratedByOpenApi":true},{"title":"Retrieve jobs by ids","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nRetrieve a maximum of 1000 jobs by ids per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/jobs/byids","href":"/20230101-alpha/transformation-jobs/retrieve-jobs-by-ids","autogeneratedByOpenApi":true},{"title":"List job metrics by job id","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /transformations/jobs/{id}/metrics","href":"/20230101-alpha/transformation-jobs/list-job-metrics-by-job-id","autogeneratedByOpenApi":true}]},{"group":"Transformation schedules","pages":[{"title":"Transformation Schedules","sidebarTitle":"Overview","description":"Schedule transformations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/transformation-schedules"},{"title":"List all schedules","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nList all transformation schedules. Use nextCursor to paginate through the results.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /transformations/schedules","href":"/20230101-alpha/transformation-schedules/list-all-schedules","autogeneratedByOpenApi":true},{"title":"Schedule transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nSchedule transformations with the specified configurations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/schedules","href":"/20230101-alpha/transformation-schedules/schedule-transformations","autogeneratedByOpenApi":true},{"title":"Retrieve schedules","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nRetrieve transformation schedules by transformation IDs or external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/schedules/byids","href":"/20230101-alpha/transformation-schedules/retrieve-schedules","autogeneratedByOpenApi":true},{"title":"Unschedule transformations","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nUnschedule transformations by IDs or externalIds.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/schedules/delete","href":"/20230101-alpha/transformation-schedules/unschedule-transformations","autogeneratedByOpenApi":true},{"title":"Update schedules","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/schedules/update","href":"/20230101-alpha/transformation-schedules/update-schedules","autogeneratedByOpenApi":true}]},{"group":"Transformation notifications","pages":[{"title":"Transformation Notifications","sidebarTitle":"Overview","description":"Subscribe to transformation notifications in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/transformation-notifications"},{"title":"Subscribe for notifications","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nSubscribe for notifications on the transformation errors.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/notifications","href":"/20230101-alpha/transformation-notifications/subscribe-for-notifications","autogeneratedByOpenApi":true},{"title":"Delete notification subscriptions by notification ID","description":"\n\n> **Required capabilities:** `transformationsAcl:WRITE`\n\nDeletes the specified notification subscriptions on the transformation. Requests to delete non-existing subscriptions do nothing, but do not throw an error.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/notifications/delete","href":"/20230101-alpha/transformation-notifications/delete-notification-subscriptions-by-notification-id","autogeneratedByOpenApi":true}]},{"group":"Query","pages":[{"title":"Query","sidebarTitle":"Overview","description":"Run SQL queries against CDF resources in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/transformation-query"},{"title":"Run query","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n\nPreview a SQL query.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/query/run","href":"/20230101-alpha/query/run-query","autogeneratedByOpenApi":true}]},{"group":"Schema","pages":[{"title":"Schema","sidebarTitle":"Overview","description":"Retrieve resource schemas for transformations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/transformation-schema"},{"title":"Get Instance schema.","description":"Returns the instance schema for a view or a data model. Requires `transformationsAcl:READ`. See [Instance schema](/api-reference/concepts/20230101/transformations#instance-schema).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /transformations/schema/instances","href":"/20230101-alpha/schema/get-instance-schema","autogeneratedByOpenApi":true},{"title":"Get the schema of a sequence","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /transformations/schema/sequence_rows","href":"/20230101-alpha/schema/get-the-schema-of-a-sequence","autogeneratedByOpenApi":true},{"title":"Get the schema of resource type","description":"\n\n> **Required capabilities:** `transformationsAcl:READ`\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /transformations/schema/{schemaType}","href":"/20230101-alpha/schema/get-the-schema-of-resource-type","autogeneratedByOpenApi":true}]},{"group":"External data sources","pages":[{"title":"Transformation external data sources","sidebarTitle":"Overview","description":"Register and manage external data sources so Transformations can read Microsoft Fabric OneLake (alpha REST API).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/transformation-external-data"},{"title":"List external data sources","description":"\n\n> **Required capabilities:** `transformationsExternalDataSourcesAcl:READ`\n\nList the external data sources configured for the project.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /transformations/externaldata","href":"/20230101-alpha/transformation-external-data-sources/list-external-data-sources","autogeneratedByOpenApi":true},{"title":"Create external data sources","description":"\n\n> **Required capabilities:** `transformationsExternalDataSourcesAcl:WRITE`\n\nCreate external data sources.\n\nIf an item's `externalId` already exists for the project, the whole\nrequest is rejected with a 409 and no items are created. To modify an\nexisting data source, delete it and create a replacement.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/externaldata","href":"/20230101-alpha/transformation-external-data-sources/create-external-data-sources","autogeneratedByOpenApi":true},{"title":"Retrieve external data sources by external ids","description":"Retrieves external data sources by external ID. Alpha only. Requires `transformationsExternalDataSourcesAcl:READ`. See [Retrieve by ID](/api-reference/concepts/20230101-alpha/transformation-external-data#retrieve-by-id).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/externaldata/byids","href":"/20230101-alpha/transformation-external-data-sources/retrieve-external-data-sources-by-external-ids","autogeneratedByOpenApi":true},{"title":"Delete external data sources","description":"\n\n> **Required capabilities:** `transformationsExternalDataSourcesAcl:WRITE`\n\nDelete external data sources by external ID.\n\nTransformations that still reference a deleted data source fail when\nthey next run.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/externaldata/delete","href":"/20230101-alpha/transformation-external-data-sources/delete-external-data-sources","autogeneratedByOpenApi":true},{"title":"Rotate external data source keys","description":"Rotates RSA keys for Snowflake sources. The call is atomic. Alpha only. Requires `transformationsExternalDataSourcesAcl:WRITE`. See [Rotate keys](/api-reference/concepts/20230101-alpha/transformation-external-data#rotate-keys).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/externaldata/rotatekeys","href":"/20230101-alpha/transformation-external-data-sources/rotate-external-data-source-keys","autogeneratedByOpenApi":true},{"title":"Verify external data source usability","description":"\n\n> **Required capabilities:** `transformationsExternalDataSourcesAcl:USE`\n\nCheck whether an external data source can be used by a transformation.\n\nReturns the external id and the latest `usableVersion` of the data\nsource. If `usableVersion` is not present in the response, the\nresource is missing or inaccessible.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations/externaldata/usability","href":"/20230101-alpha/transformation-external-data-sources/verify-external-data-source-usability","autogeneratedByOpenApi":true}]}]}]},{"group":"Documents","icon":"file-text","expanded":true,"pages":[{"group":"Documents","pages":[{"title":"Documents","sidebarTitle":"Overview","description":"Search, manage, and preview documents in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/documents-overview"},{"group":"Documents","pages":[{"title":"Documents","sidebarTitle":"Overview","description":"Search and manage documents in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/documents"},{"title":"Aggregate","description":"Compute aggregated results on documents, such as counts, distinct values, and unique properties.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/aggregate"},{"title":"Search","description":"Search for documents using advanced filters and free text queries.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/search"},{"title":"Passages search","description":"Search for relevant passages of PDF documents using semantic and lexical search filters.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/passages-search"},{"title":"Aggregate documents","description":"Aggregates documents that match a filter or search. Requires `filesAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/documents#aggregates).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /documents/aggregate","href":"/20230101-alpha/documents/aggregate-documents","autogeneratedByOpenApi":true},{"title":"List documents","description":"Lists documents. Unlike search, pagination is not capped at 1000 documents. 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-alpha.json post /documents/list","href":"/20230101-alpha/documents/list-documents","autogeneratedByOpenApi":true},{"title":"Document status","description":"\n\n> **Required capabilities:** `filesAcl:READ`\n\nCheck the index status for set of documents. Useful to check if a document is ready for search.\n\nThis endpoint is in `beta` and is available only when a `cdf-version: YYYYMMDD-beta` header\nis provided.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /documents/status","href":"/20230101-alpha/documents/document-status","autogeneratedByOpenApi":true},{"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-alpha.json post /documents/content","href":"/20230101-alpha/documents/retrieve-document-content","autogeneratedByOpenApi":true},{"title":"Retrieve parsed document content","description":"Returns the parsed layout of a PDF, including word bounding boxes. Alpha only. Requires `filesAcl:READ`. See [Document elements](/api-reference/concepts/20230101-alpha/documents#document-elements).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /documents/elements","href":"/20230101-alpha/documents/retrieve-parsed-document-content","autogeneratedByOpenApi":true},{"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-alpha.json post /documents/search","href":"/20230101-alpha/documents/search-for-documents","autogeneratedByOpenApi":true},{"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-alpha.json post /documents/passages/search","href":"/20230101-alpha/documents/semantic-search-for-passages","autogeneratedByOpenApi":true}]},{"group":"Document preview","pages":[{"title":"Document preview","sidebarTitle":"Overview","description":"Preview documents in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/document-preview"},{"title":"Retrieve a image preview of a page from a document","description":"Returns a PNG preview of one page. Set `Accept` to `image/png`. Requires `filesAcl:READ`. See [Rendering limits](/api-reference/concepts/20230101/document-preview#rendering-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /documents/{documentId}/preview/image/pages/{pageNumber}","href":"/20230101-alpha/document-preview/retrieve-a-image-preview-of-a-page-from-a-document","autogeneratedByOpenApi":true},{"title":"Retrieve a PDF preview of a document","description":"Returns a PDF preview. Set `Accept` to `application/pdf`. Requires `filesAcl:READ`. See [Rendering limits](/api-reference/concepts/20230101/document-preview#rendering-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /documents/{documentId}/preview/pdf","href":"/20230101-alpha/document-preview/retrieve-a-pdf-preview-of-a-document","autogeneratedByOpenApi":true},{"title":"Retrieve a temporary link to a PDF preview of a document","description":"\n\n> **Required capabilities:** `filesAcl:READ`\n\nThis endpoint works similar as the normal preview endpoint except\nit returns a short-lived temporary link to download the rendered preview instead\nof returning the binary data.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /documents/{documentId}/preview/pdf/temporarylink","href":"/20230101-alpha/document-preview/retrieve-a-temporary-link-to-a-pdf-preview-of-a-document","autogeneratedByOpenApi":true}]}]}]},{"group":"Integrations","icon":"layers","expanded":true,"pages":[{"title":"Integrations","sidebarTitle":"Overview","description":"Monitor and control extractors and other data integrations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/integrations-overview"},{"group":"Integrations","pages":[{"title":"Integrations resource","sidebarTitle":"Integrations","description":"Register, update, and delete integrations so you can monitor extractors and data pipelines in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/integrations"},{"title":"List Integrations","description":"\n\n> **Required capabilities:** `integrationsAcl:READ`\n\nList integrations, with optional pagination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /integrations","href":"/20230101-alpha/integrations/list-integrations","autogeneratedByOpenApi":true},{"title":"Create Integrations","description":"\n\n> **Required capabilities:** `integrationsAcl:WRITE`\n\nCreate integrations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /integrations","href":"/20230101-alpha/integrations/create-integrations","autogeneratedByOpenApi":true},{"title":"Retrieve Integrations","description":"\n\n> **Required capabilities:** `integrationsAcl:READ`\n\nRetrieve integrations by ID, optionally ignoring unknown ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /integrations/byids","href":"/20230101-alpha/integrations/retrieve-integrations","autogeneratedByOpenApi":true},{"title":"Delete Integrations","description":"\n\n> **Required capabilities:** `integrationsAcl:WRITE`\n\nDelete integrations by ID, optionally ignoring unknown ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /integrations/delete","href":"/20230101-alpha/integrations/delete-integrations","autogeneratedByOpenApi":true},{"title":"Update Integrations","description":"\n\n> **Required capabilities:** `integrationsAcl:WRITE`\n\nUpdate up to 20 integrations.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /integrations/update","href":"/20230101-alpha/integrations/update-integrations","autogeneratedByOpenApi":true},{"title":"Report Extractor Info","description":"\n\n> **Required capabilities:** `integrationsAcl:USE`\n\nReport changes to general information about the extractor, and indicates to the API that the extractor has started. This will close any currently running tasks with an error.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /integrations/startup","href":"/20230101-alpha/integrations/report-extractor-info","autogeneratedByOpenApi":true},{"title":"Check in","description":"\n\n> **Required capabilities:** `integrationsAcl:USE`\n\nCheck in with the integrations service. This endpoint is called periodically by extractors to signal that they are still alive, and report any events that may have happened since the last check in.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /integrations/checkin","href":"/20230101-alpha/integrations/check-in","autogeneratedByOpenApi":true}]},{"group":"Tasks","pages":[{"title":"Tasks","sidebarTitle":"Tasks","description":"Track integration task run history and sync updates in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/integrations-tasks"},{"title":"Get Task History","description":"\n\n> **Required capabilities:** `integrationsAcl:READ`\n\nList task history with optional filtering and pagination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /integrations/history","href":"/20230101-alpha/integration-tasks/get-task-history","autogeneratedByOpenApi":true},{"title":"Sync Integration History","description":"Returns task history and errors since the cursor. Requires `integrationsAcl:READ`. See [Sync](/api-reference/concepts/20230101-beta/integrations-tasks#sync).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /integrations/sync","href":"/20230101-alpha/integration-tasks/sync-integration-history","autogeneratedByOpenApi":true}]},{"group":"Actions","pages":[{"title":"Actions","sidebarTitle":"Actions","description":"Trigger and manage remote actions on an integration in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/integrations-actions"},{"title":"Create Actions","description":"\n\n> **Required capabilities:** `integrationActionsAcl:WRITE`\n\nCreate actions for an integration. The extractor is requested to run pending actions the next time it checks in.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /integrations/actions","href":"/20230101-alpha/integration-actions/create-actions","autogeneratedByOpenApi":true},{"title":"List Actions","description":"\n\n> **Required capabilities:** `integrationActionsAcl:READ`\n\nList actions, with optional filtering by integration and pagination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /integrations/actions","href":"/20230101-alpha/integration-actions/list-actions","autogeneratedByOpenApi":true},{"title":"Retrieve Actions","description":"\n\n> **Required capabilities:** `integrationActionsAcl:READ`\n\nRetrieve actions by ID, optionally ignoring unknown ids.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /integrations/actions/byids","href":"/20230101-alpha/integration-actions/retrieve-actions","autogeneratedByOpenApi":true},{"title":"Cancel Actions","description":"\n\n> **Required capabilities:** `integrationActionsAcl:WRITE`\n\nCancel actions by ID, optionally ignoring unknown ids. Only actions that are pending, running, or already cancel-pending can be cancelled.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /integrations/actions/cancel","href":"/20230101-alpha/integration-actions/cancel-actions","autogeneratedByOpenApi":true}]},{"group":"Configuration","pages":[{"title":"Configuration","sidebarTitle":"Configuration","description":"Create and retrieve immutable configuration revisions for an integration in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/integrations-config"},{"title":"Create config revision.","description":"\n\n> **Required capabilities:** `integrationConfigsAcl:WRITE`\n\nCreate a new config revision. The extractor will be notified of this when it next checks in.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /integrations/config","href":"/20230101-alpha/integration-configuration/create-config-revision","autogeneratedByOpenApi":true},{"title":"Fetch config revision","description":"\n\n> **Required capabilities:** `integrationConfigsAcl:READ`\n\nFetch a specific config revision.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /integrations/config","href":"/20230101-alpha/integration-configuration/fetch-config-revision","autogeneratedByOpenApi":true},{"title":"List config revisions","description":"\n\n> **Required capabilities:** `integrationConfigsAcl:READ`\n\nList config revisions, optionally filtering by a specific integration.\nThis is backwards compatible with extraction pipelines API.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /integrations/config/revisions","href":"/20230101-alpha/integration-configuration/list-config-revisions","autogeneratedByOpenApi":true}]},{"group":"Errors","pages":[{"title":"Errors","sidebarTitle":"Errors","description":"List errors reported by an integration, filtered by task or time range, in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/integrations-errors"},{"title":"List Errors","description":"\n\n> **Required capabilities:** `integrationsAcl:READ`\n\nList errors, filtering by tasks and integration. With optional pagination.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /integrations/errors","href":"/20230101-alpha/integration-errors/list-errors","autogeneratedByOpenApi":true}]}]},{"group":"Signals","icon":"radio","pages":[{"title":"Signals","sidebarTitle":"Overview","description":"Publish signals and manage sinks and subscriptions in Cognite Data Fusion using the alpha REST API.","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/signals"},{"group":"Signal sinks","pages":[{"title":"Create sinks","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:WRITE`\n\nCreate one or more sinks in the project. A sink represents a destination for signals, either a user sink (signals sent to the user's e-mail) or an e-mail sink (signals sent to a specified e-mail address).\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /processes/signals/sinks","href":"/20230101-alpha/signals/create-sinks","autogeneratedByOpenApi":true},{"title":"List sinks","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:READ`\n\nList all sinks in the project. This will return all sinks the user has access to. If the user only has \"current_user\" scope, it will only return the sink for the user making the request, if it exists.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /processes/signals/sinks","href":"/20230101-alpha/signals/list-sinks","autogeneratedByOpenApi":true},{"title":"Retrieve sinks by external IDs","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:READ`\n\nRetrieve one or more sinks by their external IDs.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /processes/signals/sinks/byids","href":"/20230101-alpha/signals/retrieve-sinks-by-external-ids","autogeneratedByOpenApi":true},{"title":"Update sinks","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:WRITE`\n\nUpdate one or more sinks in the project.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /processes/signals/sinks/update","href":"/20230101-alpha/signals/update-sinks","autogeneratedByOpenApi":true},{"title":"Delete sinks","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:WRITE`\n\nDelete one or more sinks by their external IDs.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /processes/signals/sinks/delete","href":"/20230101-alpha/signals/delete-sinks","autogeneratedByOpenApi":true}]},{"group":"Signal subscriptions","pages":[{"title":"Create subscriptions","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:WRITE`\n\nCreate one or more subscriptions in the project. A subscription ties a sink to a topic with a filter that determines which signals will be pushed out to the sink.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /processes/signals/subscriptions","href":"/20230101-alpha/signals/create-subscriptions","autogeneratedByOpenApi":true},{"title":"Filter subscriptions","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:READ`\n\nRetrieve subscriptions matching a filter.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /processes/signals/subscriptions/list","href":"/20230101-alpha/signals/filter-subscriptions","autogeneratedByOpenApi":true},{"title":"Update subscriptions","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:WRITE`\n\nUpdate one or more subscriptions in the project.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /processes/signals/subscriptions/update","href":"/20230101-alpha/signals/update-subscriptions","autogeneratedByOpenApi":true},{"title":"Delete subscriptions","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:WRITE`\n\nDelete one or more subscriptions by their external IDs.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /processes/signals/subscriptions/delete","href":"/20230101-alpha/signals/delete-subscriptions","autogeneratedByOpenApi":true}]},{"group":"List signals","pages":[{"title":"List signals.","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:READ`\n\nList all signals for a sink.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /processes/signals/list","href":"/20230101-alpha/signals/list-signals","autogeneratedByOpenApi":true}]},{"group":"Sync signals","pages":[{"title":"Sync signals","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:READ`\n\nRetrieve signals for a sink incrementally. Unlike the list endpoint, the returned cursor is persistent and can be stored and reused later to fetch only signals that arrived after the previous sync. The response always includes a `nextCursor`, and `moreData` indicates whether more signals are immediately available.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /processes/signals/sync","href":"/20230101-alpha/signals/sync-signals","autogeneratedByOpenApi":true}]},{"group":"Signal topics","pages":[{"title":"List topics","description":"\n\n> **Required capabilities:** `subscribeSignalsAcl:READ`\n\nList all topics supported by the signals service. Each topic represents a type of CDF resource that can emit signals, such as integrations or workflows. The response includes the available notification categories for each topic, which can be used when creating subscriptions.\n","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /processes/signals/topics","href":"/20230101-alpha/signals/list-topics","autogeneratedByOpenApi":true}]}]},{"group":"Workflows","icon":"workflow","pages":[{"title":"Workflows","sidebarTitle":"Overview","description":"Orchestrate multi-step data processing pipelines in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/workflows-overview"},{"group":"Workflows","pages":[{"title":"Workflows","sidebarTitle":"Overview","description":"Create and manage data workflows in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/workflows"},{"title":"Create or update a workflow","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nCreate or update a workflow. Limited to a single workflow per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /workflows","href":"/20230101-alpha/workflows/create-or-update-a-workflow","autogeneratedByOpenApi":true},{"title":"Delete workflows","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nDelete workflows, including all associated workflow versions.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /workflows/delete","href":"/20230101-alpha/workflows/delete-workflows","autogeneratedByOpenApi":true},{"title":"Retrieve a workflow","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nRetrieve a workflow by its external id.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /workflows/{workflowExternalId}","href":"/20230101-alpha/workflows/retrieve-a-workflow","autogeneratedByOpenApi":true}]},{"group":"Workflow versions","pages":[{"title":"Workflow versions","sidebarTitle":"Overview","description":"Manage workflow versions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/workflow-versions"},{"title":"Create or update a workflow version","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nCreate or update a workflow version. Limited to a single workflow version per request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /workflows/versions","href":"/20230101-alpha/workflow-versions/create-or-update-a-workflow-version","autogeneratedByOpenApi":true},{"title":"Filter workflow versions","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nList workflow versions matching a given filter.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /workflows/versions/list","href":"/20230101-alpha/workflow-versions/filter-workflow-versions","autogeneratedByOpenApi":true},{"title":"Retrieve a workflow version","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nRetrieve a version of a given workflow.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /workflows/{workflowExternalId}/versions/{version}","href":"/20230101-alpha/workflow-versions/retrieve-a-workflow-version","autogeneratedByOpenApi":true},{"title":"Delete workflow versions","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nDelete specific versions of one or more workflows.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /workflows/versions/delete","href":"/20230101-alpha/workflow-versions/delete-workflow-versions","autogeneratedByOpenApi":true}]},{"group":"Workflow executions","pages":[{"title":"Workflow executions","sidebarTitle":"Overview","description":"Run and monitor workflow executions in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/workflow-executions"},{"title":"Run a workflow","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nStart an execution of a specific version of a workflow.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /workflows/{workflowExternalId}/versions/{version}/run","href":"/20230101-alpha/workflow-executions/run-a-workflow","autogeneratedByOpenApi":true},{"title":"Filter workflow executions","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nList workflow executions matching a given filter.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /workflows/executions/list","href":"/20230101-alpha/workflow-executions/filter-workflow-executions","autogeneratedByOpenApi":true},{"title":"Retrieve workflow execution details","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nRetrieve detailed information about a specific workflow execution.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /workflows/executions/{executionId}","href":"/20230101-alpha/workflow-executions/retrieve-workflow-execution-details","autogeneratedByOpenApi":true},{"title":"Cancel a workflow execution","description":"Stops an execution from starting new tasks and sets it to `TERMINATED`. Requires `workflowOrchestrationACL:WRITE`. See [Canceling executions](/api-reference/concepts/20230101/workflow-executions#canceling-executions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /workflows/executions/{executionId}/cancel","href":"/20230101-alpha/workflow-executions/cancel-a-workflow-execution","autogeneratedByOpenApi":true},{"title":"Retry workflow execution","description":"Retries tasks that did not finish in a failed, timed out, or terminated execution. Requires `workflowOrchestrationACL:WRITE`. See [Retrying executions](/api-reference/concepts/20230101/workflow-executions#retrying-executions).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /workflows/executions/{executionId}/retry","href":"/20230101-alpha/workflow-executions/retry-workflow-execution","autogeneratedByOpenApi":true}]},{"group":"Workflow triggers","pages":[{"title":"Workflow triggers","sidebarTitle":"Overview","description":"Schedule and manage workflow triggers in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/workflow-triggers"},{"title":"Create or update triggers","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nCreate or update a trigger.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /workflows/triggers","href":"/20230101-alpha/workflow-triggers/create-or-update-triggers","autogeneratedByOpenApi":true},{"title":"Delete triggers","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:WRITE`\n\nDelete a trigger.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /workflows/triggers/delete","href":"/20230101-alpha/workflow-triggers/delete-triggers","autogeneratedByOpenApi":true},{"title":"Get the run history of a trigger","description":"\n\n> **Required capabilities:** `workflowOrchestrationACL:READ`\n\nGet information about every run of a trigger. This includes timing information and a reference to the started execution (or an explanation as to why it failed). The returned items are sorted by `fireTime` in descending order (newest first), followed by `externalId` in ascending order.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /workflows/triggers/{triggerExternalId}/history","href":"/20230101-alpha/workflow-triggers/get-the-run-history-of-a-trigger","autogeneratedByOpenApi":true},{"title":"Pause a trigger","description":"Pauses a trigger so it does not fire. Stream triggers resume from the cursor at pause time. Requires `workflowOrchestrationACL:WRITE`. See [Pause and resume](/api-reference/concepts/20230101/workflow-triggers#pause-and-resume).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /workflows/triggers/{triggerExternalId}/pause","href":"/20230101-alpha/workflow-triggers/pause-a-trigger","autogeneratedByOpenApi":true},{"title":"Resume a trigger","description":"Resumes a paused trigger. Stream triggers continue from the cursor at pause time. Requires `workflowOrchestrationACL:WRITE`. See [Pause and resume](/api-reference/concepts/20230101/workflow-triggers#pause-and-resume).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /workflows/triggers/{triggerExternalId}/resume","href":"/20230101-alpha/workflow-triggers/resume-a-trigger","autogeneratedByOpenApi":true}]},{"group":"Tasks","pages":[{"title":"Tasks","sidebarTitle":"Tasks","description":"Update workflow task statuses in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/workflow-tasks"},{"title":"Update task status","description":"Sets the status of an asynchronous task to completed or failed. Requires `workflowOrchestrationACL:WRITE`. See [Complete an async task](/api-reference/concepts/20230101/workflow-executions#complete-an-async-task).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /workflows/tasks/{taskId}/update","href":"/20230101-alpha/tasks/update-task-status","autogeneratedByOpenApi":true}]}]},{"group":"Specialized","icon":"sparkles","expanded":true,"pages":[{"group":"Simulators","pages":[{"title":"Simulators","sidebarTitle":"Overview","description":"Integrate simulation software with Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/simulators-overview"},{"group":"Simulators","pages":[{"title":"Simulators","sidebarTitle":"Overview","description":"Manage simulators in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/simulators"},{"title":"Filter Simulators","description":"List simulators.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/list","href":"/20230101-alpha/simulators/filter-simulators","autogeneratedByOpenApi":true}]},{"group":"Simulator integrations","pages":[{"title":"Simulator Integrations","sidebarTitle":"Overview","description":"Manage simulator integrations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/simulator-integrations"},{"title":"Delete Simulator Integrations","description":"Delete a simulator integration. This will also delete all associated simulator resources (e.g. routines, runs).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/integrations/delete","href":"/20230101-alpha/simulator-integrations/delete-simulator-integrations","autogeneratedByOpenApi":true},{"title":"Filter Simulator Integrations","description":"Retrieves a list of simulator integrations that match the given criteria.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/integrations/list","href":"/20230101-alpha/simulator-integrations/filter-simulator-integrations","autogeneratedByOpenApi":true}]},{"group":"Simulator models","pages":[{"title":"Simulator Models","sidebarTitle":"Overview","description":"Manage simulator models in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/simulator-models"},{"title":"Create Simulator Model","description":"Create a simulator model.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/models","href":"/20230101-alpha/simulator-models/create-simulator-model","autogeneratedByOpenApi":true},{"title":"Filter Simulator Models","description":"Retrieves a list of simulator models that match the given criteria.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/models/list","href":"/20230101-alpha/simulator-models/filter-simulator-models","autogeneratedByOpenApi":true},{"title":"Aggregate Simulator Models","description":"Calculate aggregates for simulator models, considering the optional filter specification.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/models/aggregate","href":"/20230101-alpha/simulator-models/aggregate-simulator-models","autogeneratedByOpenApi":true},{"title":"Delete Simulator Model","description":"Delete a simulator model. This will also delete all associated simulator resources (e.g. revisions, routines, runs).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/models/delete","href":"/20230101-alpha/simulator-models/delete-simulator-model","autogeneratedByOpenApi":true},{"title":"Update Simulator Model","description":"Update a simulator model.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/models/update","href":"/20230101-alpha/simulator-models/update-simulator-model","autogeneratedByOpenApi":true},{"title":"Retrieve Simulator Model","description":"Retrieve a simulator model by ID or external ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/models/byids","href":"/20230101-alpha/simulator-models/retrieve-simulator-model","autogeneratedByOpenApi":true},{"title":"Create Simulator Model Revision","description":"Create a simulator model revision.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/models/revisions","href":"/20230101-alpha/simulator-models/create-simulator-model-revision","autogeneratedByOpenApi":true},{"title":"Filter Simulator Model Revisions","description":"Retrieves a list of simulator model revisions that match the given criteria.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/models/revisions/list","href":"/20230101-alpha/simulator-models/filter-simulator-model-revisions","autogeneratedByOpenApi":true},{"title":"Retrieve Simulator Model Revisions","description":"Retrieve one or more simulator model revisions by IDs or external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/models/revisions/byids","href":"/20230101-alpha/simulator-models/retrieve-simulator-model-revisions","autogeneratedByOpenApi":true},{"title":"Retrieve Simulator Model Revision Data","description":"Retrieves a list of simulator model revisions data that match the given criteria.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/models/revisions/data/list","href":"/20230101-alpha/simulator-models/retrieve-simulator-model-revision-data","autogeneratedByOpenApi":true}]},{"group":"Simulator routines","pages":[{"title":"Simulator Routines","sidebarTitle":"Overview","description":"Manage simulator routines in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/simulator-routines"},{"title":"Create Simulator Routine","description":"Create a simulator routine.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/routines","href":"/20230101-alpha/simulator-routines/create-simulator-routine","autogeneratedByOpenApi":true},{"title":"Filter Simulator Routines","description":"Retrieves a list of simulator routines that match the given criteria.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/routines/list","href":"/20230101-alpha/simulator-routines/filter-simulator-routines","autogeneratedByOpenApi":true},{"title":"Delete Simulator Routine","description":"Delete a simulator routine. This will also delete all associated simulator resources (e.g. revisions, runs, data).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/routines/delete","href":"/20230101-alpha/simulator-routines/delete-simulator-routine","autogeneratedByOpenApi":true},{"title":"Aggregate Simulator Routines","description":"Calculate aggregates for simulator routines, considering the optional filter specification.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/routines/aggregate","href":"/20230101-alpha/simulator-routines/aggregate-simulator-routines","autogeneratedByOpenApi":true},{"title":"Create Simulator Routine Revision","description":"Creates a routine revision. The body can be at most 50 KB. See [Revision size](/api-reference/concepts/20230101/simulator-routines#revision-size).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/routines/revisions","href":"/20230101-alpha/simulator-routines/create-simulator-routine-revision","autogeneratedByOpenApi":true},{"title":"Filter Simulator Routine Revisions","description":"Retrieves a list of simulator routine revisions that match the given criteria.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/routines/revisions/list","href":"/20230101-alpha/simulator-routines/filter-simulator-routine-revisions","autogeneratedByOpenApi":true},{"title":"Retrieve Simulator Routine Revisions","description":"Retrieve one or more simulator routine revisions by IDs or external IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/routines/revisions/byids","href":"/20230101-alpha/simulator-routines/retrieve-simulator-routine-revisions","autogeneratedByOpenApi":true}]},{"group":"Simulation runs","pages":[{"title":"Simulation Runs","sidebarTitle":"Overview","description":"Execute and monitor simulation runs in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/simulation-runs"},{"title":"Run Simulation","description":"Request to run a simulator routine asynchronously.\n\nThe total size of the request body can be a maximum of 50.00 KB.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/run","href":"/20230101-alpha/simulation-runs/run-simulation","autogeneratedByOpenApi":true},{"title":"Filter Simulation Runs","description":"Retrieves a list of simulation runs that match the given criteria.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/runs/list","href":"/20230101-alpha/simulation-runs/filter-simulation-runs","autogeneratedByOpenApi":true},{"title":"Retrieve Simulation","description":"Retrieve a simulation run by ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/runs/byids","href":"/20230101-alpha/simulation-runs/retrieve-simulation","autogeneratedByOpenApi":true},{"title":"Retrieve Simulation Data","description":"Retrieve data associated with a simulation run by ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/runs/data/list","href":"/20230101-alpha/simulation-runs/retrieve-simulation-data","autogeneratedByOpenApi":true}]},{"group":"Simulator logs","pages":[{"title":"Simulator Logs","sidebarTitle":"Overview","description":"Retrieve simulator logs in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/simulator-logs"},{"title":"Retrieve Simulator Logs","description":"Retrieve one or more simulator logs by IDs.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /simulators/logs/byids","href":"/20230101-alpha/simulator-logs/retrieve-simulator-logs","autogeneratedByOpenApi":true}]}]},{"group":"Units","pages":[{"title":"Units","sidebarTitle":"Overview","description":"Access the units catalog and unit systems in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/units-overview"},{"group":"Units","pages":[{"title":"Units","sidebarTitle":"Overview","description":"Access the units catalog in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/units"},{"title":"List all units","description":"List all units.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /units","href":"/20230101-alpha/units/list-all-units","autogeneratedByOpenApi":true},{"title":"Retrieve unit by external ID","description":"Retrieve a single unit by its external ID.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /units/{externalId}","href":"/20230101-alpha/units/retrieve-unit-by-external-id","autogeneratedByOpenApi":true},{"title":"Retrieve units by external IDs","description":"Retrieves one or more units by external ID. The response returns the units in the same order as in the request.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /units/byids","href":"/20230101-alpha/units/retrieve-units-by-external-ids","autogeneratedByOpenApi":true}]},{"group":"Unit systems","pages":[{"title":"Unit Systems","sidebarTitle":"Overview","description":"Access unit systems in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/unit-systems"},{"title":"List all unit systems","description":"List all unit systems.","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /units/systems","href":"/20230101-alpha/unit-systems/list-all-unit-systems","autogeneratedByOpenApi":true}]}]}]},{"group":"Legacy","icon":"archive","expanded":true,"pages":[{"group":"Legacy data modeling","pages":[{"title":"Asset-centric data modeling (legacy)","sidebarTitle":"Overview","description":"This is the original CDF approach, where data is organized around a hierarchy of physical equipment (assets). While fully supported for existing solutions, it lacks the flexibility of data modeling for the knowledge graph.","content-type":"concept","audience":"developer","experience-level":200,"lifecycle":"use","applicable-to":["asset-centric"],"article-type":"article","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/asset-centric"},{"group":"Assets","pages":[{"title":"Assets","sidebarTitle":"Overview","description":"Manage assets in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/assets"},{"title":"Aggregate assets","description":"Aggregates assets. Requires `assetsAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/assets#aggregates).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /assets/aggregate","href":"/20230101-alpha/assets/aggregate-assets","autogeneratedByOpenApi":true},{"title":"Create assets","description":"Creates assets. Requires `assetsAcl:WRITE`. See [Assets](/api-reference/concepts/20230101/assets).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /assets","href":"/20230101-alpha/assets/create-assets","autogeneratedByOpenApi":true},{"title":"Delete assets","description":"Deletes assets. Set `recursive` to true to delete descendants. Requires `assetsAcl:WRITE`. See [Delete assets](/api-reference/concepts/20230101/assets#delete-assets).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /assets/delete","href":"/20230101-alpha/assets/delete-assets","autogeneratedByOpenApi":true},{"title":"Filter assets","description":"Lists assets that match a filter. This endpoint is for exploration. Requires `assetsAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/assets#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /assets/list","href":"/20230101-alpha/assets/filter-assets","autogeneratedByOpenApi":true},{"title":"List assets","description":"Lists assets in the project. This endpoint is for exploration. Requires `assetsAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/assets#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /assets","href":"/20230101-alpha/assets/list-assets","autogeneratedByOpenApi":true},{"title":"Retrieve an asset by its ID","description":"Retrieves an asset by internal ID. Requires `assetsAcl:READ`. See [Assets](/api-reference/concepts/20230101/assets).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /assets/{id}","href":"/20230101-alpha/assets/retrieve-an-asset-by-its-id","autogeneratedByOpenApi":true},{"title":"Retrieve assets","description":"Retrieves assets by internal or external ID. Requires `assetsAcl:READ`. See [Assets](/api-reference/concepts/20230101/assets).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /assets/byids","href":"/20230101-alpha/assets/retrieve-assets","autogeneratedByOpenApi":true},{"title":"Search assets","description":"Searches assets by relevance. Matching and order can change, and the operation does not paginate. Requires `assetsAcl:READ`. See [Sorting](/api-reference/concepts/20230101/assets#sorting).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /assets/search","href":"/20230101-alpha/assets/search-assets","autogeneratedByOpenApi":true},{"title":"Update assets","description":"\n\n> **Required capabilities:** `assetsAcl:WRITE`\n\nUpdate the attributes of assets.\n\n### Request throttling\nThis endpoint is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Assets resource description](../../) for more information.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /assets/update","href":"/20230101-alpha/assets/update-assets","autogeneratedByOpenApi":true}]},{"group":"Time series metadata","pages":[{"title":"Time series","sidebarTitle":"Overview","description":"Manage time series data in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["asset-centric"],"api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/time-series"},{"title":"Aggregate time series","description":"Aggregates time series. Requires `timeSeriesAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/time-series#aggregates).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/aggregate","href":"/20230101-alpha/time-series/aggregate-time-series","autogeneratedByOpenApi":true},{"title":"Create time series","description":"\n\n> **Required capabilities:** `timeSeriesAcl:WRITE`\n\nCreates one or more time series.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries","href":"/20230101-alpha/time-series/create-time-series","autogeneratedByOpenApi":true},{"title":"Delete time series","description":"\n\n> **Required capabilities:** `timeSeriesAcl:WRITE`\n\nDeletes the time series with the specified IDs and their data points.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/delete","href":"/20230101-alpha/time-series/delete-time-series","autogeneratedByOpenApi":true},{"title":"Filter time series","description":"Lists time series that match a filter. This endpoint is for exploration. Requires `timeSeriesAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/time-series#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/list","href":"/20230101-alpha/time-series/filter-time-series","autogeneratedByOpenApi":true},{"title":"List time series","description":"\n\n> **Required capabilities:** `timeSeriesAcl:READ`\n\nList time series. Use `nextCursor` to paginate through the results.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /timeseries","href":"/20230101-alpha/time-series/list-time-series","autogeneratedByOpenApi":true},{"title":"Retrieve time series","description":"\n\n> **Required capabilities:** `timeSeriesAcl:READ`\n\nRetrieves one or more time series by ID or external ID. The response returns the time series in the same order as in the request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/byids","href":"/20230101-alpha/time-series/retrieve-time-series","autogeneratedByOpenApi":true},{"title":"Search time series","description":"Searches time series by relevance. Requires `timeSeriesAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/time-series#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/search","href":"/20230101-alpha/time-series/search-time-series","autogeneratedByOpenApi":true},{"title":"Update time series","description":"Updates time series. Requires `timeSeriesAcl:WRITE`. See [Time series](/api-reference/concepts/20230101/time-series).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /timeseries/update","href":"/20230101-alpha/time-series/update-time-series","autogeneratedByOpenApi":true}]},{"group":"Events","pages":[{"title":"Events","sidebarTitle":"Overview","description":"Manage events in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/events"},{"title":"Aggregate events","description":"Aggregates events. Requires `eventsAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/events#aggregates).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /events/aggregate","href":"/20230101-alpha/events/aggregate-events","autogeneratedByOpenApi":true},{"title":"Create events","description":"Creates events. Requires `eventsAcl:WRITE`. See [Events](/api-reference/concepts/20230101/events).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /events","href":"/20230101-alpha/events/create-events","autogeneratedByOpenApi":true},{"title":"Delete events","description":"Deletes up to 1000 events. Requires `eventsAcl:WRITE`. See [Delete events](/api-reference/concepts/20230101/events#delete-events).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /events/delete","href":"/20230101-alpha/events/delete-events","autogeneratedByOpenApi":true},{"title":"Filter events","description":"Lists events that match a filter. This endpoint is for exploration. Requires `eventsAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/events#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /events/list","href":"/20230101-alpha/events/filter-events","autogeneratedByOpenApi":true},{"title":"List events","description":"\n\n> **Required capabilities:** `eventsAcl:READ`\n\nList events optionally filtered on query parameters\n\n### Request throttling\nThis endpoint is meant for data analytics/exploration usage and is not suitable for high load data retrieval usage.\nIt is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Events resource description](../../) for more information.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /events","href":"/20230101-alpha/events/list-events","autogeneratedByOpenApi":true},{"title":"Receive an event by its ID","description":"\n\n> **Required capabilities:** `eventsAcl:READ`\n\nRetrieves an event by its internal (service-generated) ID.\n\n### Request throttling\nThis endpoint is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Events resource description](../../) for more information.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /events/{id}","href":"/20230101-alpha/events/receive-an-event-by-its-id","autogeneratedByOpenApi":true},{"title":"Retrieve events","description":"Retrieves events by internal or external ID. Requires `eventsAcl:READ`. See [Events](/api-reference/concepts/20230101/events).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /events/byids","href":"/20230101-alpha/events/retrieve-events","autogeneratedByOpenApi":true},{"title":"Search events","description":"Searches events by relevance. Matching and order can change, and the operation does not paginate. Requires `eventsAcl:READ`. See [Sorting](/api-reference/concepts/20230101/events#sorting).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /events/search","href":"/20230101-alpha/events/search-events","autogeneratedByOpenApi":true},{"title":"Update events","description":"Partially updates up to 1000 events. Requires `eventsAcl:WRITE`. See [Update events](/api-reference/concepts/20230101/events#update-events).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /events/update","href":"/20230101-alpha/events/update-events","autogeneratedByOpenApi":true}]},{"group":"File metadata","pages":[{"title":"Files","sidebarTitle":"Overview","description":"Manage files in Cognite Data Fusion (CDF).","content-type":"concept","applicable-to":["asset-centric"],"api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/files"},{"title":"Aggregate files","description":"Counts files that match a filter. Requires `filesAcl:READ`. See [Files](/api-reference/concepts/20230101/files).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /files/aggregate","href":"/20230101-alpha/files/aggregate-files","autogeneratedByOpenApi":true},{"title":"Upload file","description":"Creates file metadata and returns an upload URL. Requires `filesAcl:WRITE`. See [Upload limits](/api-reference/concepts/20230101/file-content#upload-limits).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /files","href":"/20230101-alpha/files/upload-file","autogeneratedByOpenApi":true},{"title":"Delete files","description":"Deletes up to 1000 files. Requires `filesAcl:WRITE`. See [Delete files](/api-reference/concepts/20230101/files#delete-files).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /files/delete","href":"/20230101-alpha/files/delete-files","autogeneratedByOpenApi":true},{"title":"Filter files","description":"Lists files that match a filter. This endpoint is for exploration. Requires `filesAcl:READ`. See [Files](/api-reference/concepts/20230101/files).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /files/list","href":"/20230101-alpha/files/filter-files","autogeneratedByOpenApi":true},{"title":"List files","description":"Lists files in the project. This endpoint is for exploration. Requires `filesAcl:READ`. See [Files](/api-reference/concepts/20230101/files).","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /files","href":"/20230101-alpha/files/list-files","autogeneratedByOpenApi":true},{"title":"Retrieve a file by its ID","description":"Retrieves file metadata by internal ID. Requires `filesAcl:READ`, or data modeling read. See [Files](/api-reference/concepts/20230101/files).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /files/{id}","href":"/20230101-alpha/files/retrieve-a-file-by-its-id","autogeneratedByOpenApi":true},{"title":"Retrieve files","description":"Retrieves file metadata for the requested IDs, in request order. Requires `filesAcl:READ`, or data modeling read. See [Files](/api-reference/concepts/20230101/files).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /files/byids","href":"/20230101-alpha/files/retrieve-files","autogeneratedByOpenApi":true},{"title":"Search files","description":"Searches files by relevance and returns at most 1000 matches. Requires `filesAcl:READ`. See [Search](/api-reference/concepts/20230101/files#search).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /files/search","href":"/20230101-alpha/files/search-files","autogeneratedByOpenApi":true},{"title":"Update files","description":"Updates file metadata. Replace content with init upload and `overwrite=true`. Requires `filesAcl:WRITE`. See [Update metadata](/api-reference/concepts/20230101/files#update-metadata).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /files/update","href":"/20230101-alpha/files/update-files","autogeneratedByOpenApi":true}]},{"group":"Sequences","pages":[{"title":"Sequences","sidebarTitle":"Overview","description":"Manage sequences in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/sequences"},{"title":"Aggregate sequences","description":"Aggregates sequences. Requires `sequencesAcl:READ`. See [Aggregates](/api-reference/concepts/20230101/sequences#aggregates).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /sequences/aggregate","href":"/20230101-alpha/sequences/aggregate-sequences","autogeneratedByOpenApi":true},{"title":"Create sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nCreate one or more sequences.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /sequences","href":"/20230101-alpha/sequences/create-sequences","autogeneratedByOpenApi":true},{"title":"Delete rows","description":"\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nDeletes the given rows of the sequence. All columns are affected.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /sequences/data/delete","href":"/20230101-alpha/sequences/delete-rows","autogeneratedByOpenApi":true},{"title":"Delete sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nDeletes the sequences with the specified IDs. If one or more of the sequences do not exist, the `ignoreUnknownIds` parameter controls what will happen: if it is `true`, the sequences that do exist will be deleted, and the request succeeds; if it is `false` or absent, nothing will be deleted, and the request fails.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /sequences/delete","href":"/20230101-alpha/sequences/delete-sequences","autogeneratedByOpenApi":true},{"title":"Filter sequences","description":"Lists sequences that match a filter. This endpoint is for exploration. Requires `sequencesAcl:READ`. See [Advanced filtering](/api-reference/concepts/20230101/sequences#advanced-filtering).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /sequences/list","href":"/20230101-alpha/sequences/filter-sequences","autogeneratedByOpenApi":true},{"title":"Insert rows","description":"\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nInserts rows into a sequence. This overwrites data in rows and columns that exist.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /sequences/data","href":"/20230101-alpha/sequences/insert-rows","autogeneratedByOpenApi":true},{"title":"List sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nList sequences. Use `nextCursor` to paginate through the results.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /sequences","href":"/20230101-alpha/sequences/list-sequences","autogeneratedByOpenApi":true},{"title":"Retrieve last row","description":"\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nRetrieves the last row in one or more sequences. Note that the last row in a sequence is the\none with the highest row number, which is not necessarily the one that was ingested most\nrecently.\n","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /sequences/data/latest","href":"/20230101-alpha/sequences/retrieve-last-row","autogeneratedByOpenApi":true},{"title":"Retrieve rows","description":"\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nProcesses data requests and returns the result. Note that this operation uses a dynamic limit on the number of rows returned based on the number and type of columns; use the provided cursor to paginate and retrieve all data.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /sequences/data/list","href":"/20230101-alpha/sequences/retrieve-rows","autogeneratedByOpenApi":true},{"title":"Retrieve sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nRetrieves one or more sequences by ID or external ID. The response returns the sequences in the same order as in the request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /sequences/byids","href":"/20230101-alpha/sequences/retrieve-sequences","autogeneratedByOpenApi":true},{"title":"Search sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nRetrieves a list of sequences matching the given criteria. This operation doesn't support pagination.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /sequences/search","href":"/20230101-alpha/sequences/search-sequences","autogeneratedByOpenApi":true},{"title":"Update sequences","description":"\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nUpdates one or more sequences. Fields outside of the request remain unchanged.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /sequences/update","href":"/20230101-alpha/sequences/update-sequences","autogeneratedByOpenApi":true}]},{"group":"Data sets","pages":[{"title":"Data sets","sidebarTitle":"Overview","description":"Organize and govern data with data sets in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/data-sets"},{"title":"Create data sets","description":"\n\n> **Required capabilities:** `datasetsAcl:WRITE`\n\nYou can create a maximum of 10 data sets per request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /datasets","href":"/20230101-alpha/data-sets/create-data-sets","autogeneratedByOpenApi":true},{"title":"Aggregate data sets","description":"\n\n> **Required capabilities:** `datasetsAcl:READ`\n\nAggregate data sets in the same project. Criteria can be applied to select a subset of data sets.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /datasets/aggregate","href":"/20230101-alpha/data-sets/aggregate-data-sets","autogeneratedByOpenApi":true},{"title":"Filter data sets","description":"\n\n> **Required capabilities:** `datasetsAcl:READ`\n\nUse advanced filtering options to find data sets.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /datasets/list","href":"/20230101-alpha/data-sets/filter-data-sets","autogeneratedByOpenApi":true},{"title":"Retrieve data sets","description":"\n\n> **Required capabilities:** `datasetsAcl:READ`\n\nRetrieve data sets by IDs or external IDs.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /datasets/byids","href":"/20230101-alpha/data-sets/retrieve-data-sets","autogeneratedByOpenApi":true},{"title":"Update data sets.","description":"\n\n> **Required capabilities:** `datasetsAcl:WRITE`\n","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /datasets/update","href":"/20230101-alpha/data-sets/update-data-sets","autogeneratedByOpenApi":true}]},{"group":"Labels","pages":[{"title":"Labels","sidebarTitle":"Overview","description":"Create and manage labels in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/labels"},{"title":"Create label definitions.","description":"\n\n> **Required capabilities:** `labelsAcl:WRITE`\n\nCreates label definitions that can be used across different resource types. The label definitions are uniquely identified by their external id.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /labels","href":"/20230101-alpha/labels/create-label-definitions","autogeneratedByOpenApi":true},{"title":"Filter labels","description":"\n\n> **Required capabilities:** `labelsAcl:READ`\n\nUse advanced filtering options to find label definitions.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /labels/list","href":"/20230101-alpha/labels/filter-labels","autogeneratedByOpenApi":true},{"title":"Retrieve labels","description":"\n\n> **Required capabilities:** `labelsAcl:READ`\n\nRetrieve labels using their external ids","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /labels/byids","href":"/20230101-alpha/labels/retrieve-labels","autogeneratedByOpenApi":true},{"title":"Delete label definitions.","description":"\n\n> **Required capabilities:** `labelsAcl:WRITE`\n\nDelete all the label definitions specified by their external ids. The resource items that have the corresponding label attached remain unmodified. It is up to the client to clean up the resource items from their attached labels if necessary.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /labels/delete","href":"/20230101-alpha/labels/delete-label-definitions","autogeneratedByOpenApi":true}]},{"group":"Relationships","pages":[{"title":"Relationships","sidebarTitle":"Overview","description":"Create and manage relationships between resources in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/relationships"},{"title":"Create relationships","description":"Creates up to 1000 relationships. `externalId` must be unique. Requires `relationshipsAcl:WRITE`. See [Create and update](/api-reference/concepts/20230101/relationships#create-and-update).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /relationships","href":"/20230101-alpha/relationships/create-relationships","autogeneratedByOpenApi":true},{"title":"Delete relationships","description":"\n\n> **Required capabilities:** `relationshipsAcl:WRITE`\n\nDelete the relationships between resources identified by the external IDs in the request. You can delete a maximum of 1000 relationships per request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /relationships/delete","href":"/20230101-alpha/relationships/delete-relationships","autogeneratedByOpenApi":true},{"title":"Filter relationships","description":"\n\n> **Required capabilities:** `relationshipsAcl:READ`\n\nLists relationships matching the query filter in the request. You can retrieve a maximum of 1000 relationships per request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /relationships/list","href":"/20230101-alpha/relationships/filter-relationships","autogeneratedByOpenApi":true},{"title":"List relationships","description":"\n\n> **Required capabilities:** `relationshipsAcl:READ`\n\nLists all relationships. The order of retrieved objects may change for two calls with the same parameters.\nThe endpoint supports pagination. The initial call to this endpoint should not contain a cursor, but the cursor parameter should be used to retrieve further pages of results.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /relationships","href":"/20230101-alpha/relationships/list-relationships","autogeneratedByOpenApi":true},{"title":"Retrieve relationships","description":"\n\n> **Required capabilities:** `relationshipsAcl:READ`\n\nRetrieve relationships by external IDs. You can retrieve a maximum of 1000 relationships per request.\nThe order of the relationships in the response equals the order in the request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /relationships/byids","href":"/20230101-alpha/relationships/retrieve-relationships","autogeneratedByOpenApi":true},{"title":"Update relationships","description":"Partially updates up to 1000 relationships. Requires `relationshipsAcl:WRITE` and `relationshipsAcl:READ`. See [Create and update](/api-reference/concepts/20230101/relationships#create-and-update).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /relationships/update","href":"/20230101-alpha/relationships/update-relationships","autogeneratedByOpenApi":true}]},{"group":"Annotations","pages":[{"title":"Annotations","sidebarTitle":"Overview","description":"Create and manage annotations in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/annotations"},{"title":"Create annotations","description":"Creates annotations on resources you can read. Requires `annotationsAcl:WRITE`. See [Create annotations](/api-reference/concepts/20230101/annotations#create-annotations).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /annotations","href":"/20230101-alpha/annotations/create-annotations","autogeneratedByOpenApi":true},{"title":"Suggest annotations","description":"Creates annotations with status `suggested`. Requires `annotationsAcl:SUGGEST`. See [Create annotations](/api-reference/concepts/20230101/annotations#create-annotations).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /annotations/suggest","href":"/20230101-alpha/annotations/suggest-annotations","autogeneratedByOpenApi":true},{"title":"Get an annotation","description":"Retrieves the referenced annotation.\n\nThe caller _must_ have read-access on the **annotated resource**, otherwise the call will fail.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /annotations/{annotationId}","href":"/20230101-alpha/annotations/get-an-annotation","autogeneratedByOpenApi":true},{"title":"Filter annotations","description":"Lists the annotations the caller has access to, based on a filter.\n\nThe caller _must_ have read-access on the **annotated resources** listed in the filter, otherwise the call will\nfail.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /annotations/list","href":"/20230101-alpha/annotations/filter-annotations","autogeneratedByOpenApi":true},{"title":"Reverse lookup","description":"Returns annotated files or 3D resources that match a filter. Requires `annotationsAcl:WRITE`. See [Reverse lookup](/api-reference/concepts/20230101/annotations#reverse-lookup).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /annotations/reverselookup","href":"/20230101-alpha/annotations/reverse-lookup","autogeneratedByOpenApi":true},{"title":"Retrieve annotations","description":"Retrieves the referenced annotations.\n\nThe caller _must_ have read-access on all the **annotated resources**, otherwise the call will fail.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /annotations/byids","href":"/20230101-alpha/annotations/retrieve-annotations","autogeneratedByOpenApi":true},{"title":"Delete annotations","description":"\n\n> **Required capabilities:** `annotationsAcl:WRITE`\n\nDeletes the referenced annotations completely.\n\nThe caller _must_ have read-access on all the **annotated resources**, otherwise the call will fail.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /annotations/delete","href":"/20230101-alpha/annotations/delete-annotations","autogeneratedByOpenApi":true},{"title":"Update annotations","description":"\n\n> **Required capabilities:** `annotationsAcl:WRITE`\n\nUpdates the referenced annotations.\n\nThe caller _must_ have read-access on all the **annotated resources**, otherwise the call will fail.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /annotations/update","href":"/20230101-alpha/annotations/update-annotations","autogeneratedByOpenApi":true}]},{"group":"Geospatial","pages":[{"title":"Geospatial","sidebarTitle":"Overview","description":"Manage geospatial data in Cognite Data Fusion (CDF).","content-type":"concept","api-calendar-version":"20230101-alpha","searchable":false,"boost":2,"href":"/api-reference/concepts/20230101-alpha/geospatial"},{"title":"Aggregate features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nSearch for features based on the feature property filter and perform requested aggregations on a given property. Aggregations are supported for all filters that do not contain `stWithin`, `stWithinProperly`, `stContains` and `stContainsProperly` search in 3D geometries.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/featuretypes/{featureTypeExternalId}/features/aggregate","href":"/20230101-alpha/geospatial/aggregate-features","autogeneratedByOpenApi":true},{"title":"Compute","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialCrsAcl:READ`\n\nCompute custom json output structures or well known binary format responses based on calculation or selection of feature properties or direct values given in the request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/compute","href":"/20230101-alpha/geospatial/compute","autogeneratedByOpenApi":true},{"title":"Create Coordinate Reference Systems","description":"\n\n> **Required capabilities:** `geospatialCrsAcl:WRITE`\n\nCreates custom Coordinate Reference Systems.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/crs","href":"/20230101-alpha/geospatial/create-coordinate-reference-systems","autogeneratedByOpenApi":true},{"title":"Create feature types","description":"\n\n> **Required capabilities:** `geospatialAcl:WRITE`\n\nCreates feature types. Each tenant can have up to 100 feature types.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/featuretypes","href":"/20230101-alpha/geospatial/create-feature-types","autogeneratedByOpenApi":true},{"title":"Create features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nCreate features","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/featuretypes/{featureTypeExternalId}/features","href":"/20230101-alpha/geospatial/create-features","autogeneratedByOpenApi":true},{"title":"Delete Coordinate Reference Systems","description":"\n\n> **Required capabilities:** `geospatialCrsAcl:WRITE`\n\nDelete custom Coordinate Reference Systems.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/crs/delete","href":"/20230101-alpha/geospatial/delete-coordinate-reference-systems","autogeneratedByOpenApi":true},{"title":"Delete feature types","description":"\n\n> **Required capabilities:** `geospatialAcl:WRITE`\n\nDelete feature types.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/featuretypes/delete","href":"/20230101-alpha/geospatial/delete-feature-types","autogeneratedByOpenApi":true},{"title":"Delete features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nDelete features.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/featuretypes/{featureTypeExternalId}/features/delete","href":"/20230101-alpha/geospatial/delete-features","autogeneratedByOpenApi":true},{"title":"Delete a raster from a feature property","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nDelete a raster from a feature property. If there is no raster already, the operation is a no-op.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/featuretypes/{featureTypeExternalId}/features/{featureExternalId}/rasters/{rasterPropertyName}/delete","href":"/20230101-alpha/geospatial/delete-a-raster-from-a-feature-property","autogeneratedByOpenApi":true},{"title":"Get Coordinate Reference Systems","description":"\n\n> **Required capabilities:** `geospatialCrsAcl:READ`\n\nGet Coordinate Reference Systems by their Spatial Reference IDs","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/crs/byids","href":"/20230101-alpha/geospatial/get-coordinate-reference-systems","autogeneratedByOpenApi":true},{"title":"Get features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nGet features with paging support","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /geospatial/featuretypes/{featureTypeExternalId}/features","href":"/20230101-alpha/geospatial/get-features","autogeneratedByOpenApi":true},{"title":"List feature types","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nList all feature types","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/featuretypes/list","href":"/20230101-alpha/geospatial/list-feature-types","autogeneratedByOpenApi":true},{"title":"Put a raster into a feature property","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nPut a raster into a feature property. The feature property must be of type RASTER.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json put /geospatial/featuretypes/{featureTypeExternalId}/features/{featureExternalId}/rasters/{rasterPropertyName}","href":"/20230101-alpha/geospatial/put-a-raster-into-a-feature-property","autogeneratedByOpenApi":true},{"title":"Get a raster from a feature property","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nGet a raster from a feature property. The feature property must be of type RASTER.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/featuretypes/{featureTypeExternalId}/features/{featureExternalId}/rasters/{rasterPropertyName}","href":"/20230101-alpha/geospatial/get-a-raster-from-a-feature-property","autogeneratedByOpenApi":true},{"title":"Retrieve feature types","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nRetrieves feature types by external ids. It is possible to retrieve up to 100 items per request, i.e. the maximum number of feature types for a tenant.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/featuretypes/byids","href":"/20230101-alpha/geospatial/retrieve-feature-types","autogeneratedByOpenApi":true},{"title":"Retrieve features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nRetrieves features by external ids. It is possible to retrieve up to 1000 items per request.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/featuretypes/{featureTypeExternalId}/features/byids","href":"/20230101-alpha/geospatial/retrieve-features","autogeneratedByOpenApi":true},{"title":"Search and stream features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nSearch for features based on the feature property filter passed in the body of the request. The streaming response format can be length prefixed, new line delimited, record separator delimited or concatenated depending on requested output (see https://en.wikipedia.org/wiki/JSON_streaming).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/featuretypes/{featureTypeExternalId}/features/search-streaming","href":"/20230101-alpha/geospatial/search-and-stream-features","autogeneratedByOpenApi":true},{"title":"Search features","description":"Searches features. The response contains at most 1000 items. Requires `geospatialAcl:READ`. See [Search results](/api-reference/concepts/20230101/geospatial#search-results).","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/featuretypes/{featureTypeExternalId}/features/search","href":"/20230101-alpha/geospatial/search-features","autogeneratedByOpenApi":true},{"title":"Update feature types","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nUpdate one or more feature types","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/featuretypes/update","href":"/20230101-alpha/geospatial/update-feature-types","autogeneratedByOpenApi":true},{"title":"Update features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nUpdate features. This is a replace operation, i.e., all feature properties have to be sent in the request body even if their values do not change.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/featuretypes/{featureTypeExternalId}/features/update","href":"/20230101-alpha/geospatial/update-features","autogeneratedByOpenApi":true},{"title":"Filter all features","description":"\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nList features based on the feature property filter passed in the body of the request. This operation supports pagination by cursor.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/featuretypes/{featureTypeExternalId}/features/list","href":"/20230101-alpha/geospatial/filter-all-features","autogeneratedByOpenApi":true}]}]}]}]}]}]},{"tab":"CogDocs","hidden":true,"searchable":false,"groups":[{"group":"Overview","pages":[{"title":"Documentation platform overview","sidebarTitle":"Platform overview","icon":"library-big","description":"Learn about Cognite's documentation platform and how Mintlify, CogDocs, and AI assistants work together to produce consistent, discoverable, and maintainable technical content at scale.","content-type":"concept","article-type":"article","audience":"internal","experience-level":"100","lifecycle":"use","href":"/cogdocs/concepts/platform-overview"},{"title":"Documentation ownership","sidebarTitle":"Who owns what?","icon":"network","description":"How Cognite distributes documentation ownership across the organization while keeping quality consistent and serving both humans and AI.","content-type":"concept","audience":"internal","experience-level":"200","lifecycle":"use","article-type":"article","href":"/cogdocs/concepts/cogdocs-documentation-data-mesh"}]},{"group":"Content framework","pages":[{"title":"Understanding the content information architecture","sidebarTitle":"Information architecture","icon":"badge-info","description":"Learn how documentation is organized in the repository: folder layout, the content model from collections through articles, and Mintlify components for a consistent reader experience.","content-type":"concept","article-type":"article","audience":"internal","experience-level":"200","lifecycle":"use","href":"/cogdocs/concepts/cogdocs-information-architecture"},{"title":"Choosing your content type","sidebarTitle":"Content types","icon":"shapes","description":"Understand when to use each content type and how to decide which one fits the information you're writing.","content-type":"concept","article-type":"article","audience":"internal","experience-level":"100","lifecycle":"use","href":"/cogdocs/concepts/cogdocs-content-types"},{"title":"Cognite documentation style and voice","sidebarTitle":"Style and voice","icon":"audio-lines","description":"Essential style considerations and voice principles for creating consistent, user-focused technical documentation across Cognite products","content-type":"concept","article-type":"article","audience":"internal","experience-level":"100","lifecycle":"use","href":"/cogdocs/concepts/cogdocs-style-guide"}]},{"group":"Reference","pages":[{"title":"Metadata reference for Cognite documentation","sidebarTitle":"Metadata","icon":"hash","description":"Required metadata fields for Cognite documentation articles, including title, description, content-type, audience, experience-level, lifecycle, and article-type.","content-type":"reference","article-type":"article","audience":"internal","experience-level":"100","lifecycle":"use","href":"/cogdocs/reference/cogdocs-metadata"},{"title":"Content quality overview","description":"Establishes characteristics, criteria, and checklists to help develop high-quality content consistently.","sidebarTitle":"Content quality","icon":"check","content-type":"reference","article-type":"article","audience":"internal","experience-level":"200","lifecycle":"use","href":"/cogdocs/reference/cogdocs-quality-checklist"},{"title":"Cognite terminology","sidebarTitle":"Cognite glossary","icon":"book-a","description":"A glossary of approved, pending, and discouraged terms for Cognite documentation, with usage guidance and examples.","content-type":"reference","article-type":"article","audience":"internal","experience-level":"100","lifecycle":"use","href":"/cogdocs/reference/cogdocs-glossary"}]}]}]},{"language":"de","tabs":[{"tab":"Willkommen","groups":[{"group":"Willkommen","pages":[{"title":"Cognite-Dokumentation","description":"Selbstbedienungsproduktdokumentation für Entwickler und Technologieprofis.","mode":"wide","to-L10N":true,"content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/de"}]},{"group":"Erste Schritte","pages":[{"title":"Info zu Cognite Data Fusion (CDF)","description":"Cognite Data Fusion (CDF) ist eine industrielle DataOps-Plattform, die Ihre industriellen Daten in ein strukturiertes, flexibles und kontextualisiertes Wissensgraphen streamt.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/de/cdf/index"},{"title":"Bei CDF anmelden","description":"Um sich bei Cognite Data Fusion anzumelden, müssen Sie den Namen Ihrer Organisation angeben, Ihre Anmeldedaten eingeben und angeben, bei welchem Projekt Sie sich anmelden möchten.","content-type":"procedure","audience":"businessUser","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":true,"href":"/de/cdf/sign-in"},{"title":"CDF abonnieren","description":"Abonnieren Sie Cognite Data Fusion (CDF) und verbinden Sie sich mit unseren cloudbasierten Apps und Diensten.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/de/cdf/sign-up"}]}]},{"tab":"Flows","groups":[{"group":"Flows","pages":[{"title":"Über Flows","sidebarTitle":"Übersicht","description":"Nutzen Sie den Flows-Arbeitsbereich, um Daten zu finden und zu analysieren.","content-type":"reference","mode":"wide","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"map","href":"/de/cdf/flows_workspace/index"},{"title":"Flows-Arbeitsbereich","description":"Navigieren Sie in der Seitenleiste des Flows-Arbeitsbereichs, um zwischen Tools und Projekten zu wechseln, mit Cognite Atlas zu chatten sowie Hilfe- und Profileinstellungen zu verwalten.","content-type":"reference","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"article","href":"/de/cdf/flows_workspace/flows_workspace"},{"title":"Suche","description":"Schritt-für-Schritt-Anleitung zum Finden von Industriedaten in Cognite Data Fusion (CDF), vom Filtern und Sortieren der Ergebnisse bis hin zur Vorschau eines Elements und dem Herunterladen von Listen als CSV.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/de/cdf/explore/search"},{"title":"3D durchsuchen","description":"Erforschen Sie physische Vermögenswerte in 3D-Umgebungen und suchen Sie nach Geräten innerhalb von Standortmodellen.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/de/cdf/explore/navigate_3d"},{"title":"Canvas","description":"Schritt-für-Schritt-Anleitung zum Erstellen einer Arbeitsfläche, Hochladen von Dateien, Hinzufügen von Zeitreihen und Diagrammen, Arbeiten mit PDFs, Erstellen von Ursachenkarten, Organisieren von Arbeitsflächen mit Labels und Verwenden von Agenten zur Analyse industrieller Daten.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/de/cdf/explore/canvas"},{"title":"Charts","description":"Analysieren Sie Zeitreihendaten, erstellen Sie Berechnungen, setzen Sie Schwellenwerte, überwachen Sie Warnungen, bewerten Sie die Datenqualität und visualisieren Sie Aktivitäten.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/de/cdf/explore/charts"},{"title":"Angepasste Apps","description":"Greifen Sie auf benutzerdefinierte Anwendungen zu, die für die spezifischen Arbeitsabläufe Ihrer Organisation entwickelt wurden.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/de/cdf/explore/custom_apps"},{"title":"Agenten","description":"Arbeiten Sie mit Atlas AI-Agenten, die auf Ihren Daten trainiert und für die spezifischen Anwendungsfälle Ihrer Organisation angepasst sind.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/de/cdf/explore/agents"}]},{"group":"InField","pages":[{"title":"Über Cognite InField","sidebarTitle":"Übersicht","description":"Helfen Sie Feldarbeitern und Vorgesetzten, ihre Aufgaben effizient zu planen und durchzuführen, indem Sie papierbasierte Datenerfassung ersetzen.","content-type":"map","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/de/cdf/infield/index"},{"title":"Vorlagen und Checklisten erstellen","description":"Erstellen Sie Vorlagen, fügen Sie Aufgaben und Zeitpläne hinzu und generieren Sie Checklisten für Feldarbeiter, die in regelmäßigen Abständen ausgeführt werden sollen.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/de/cdf/infield/guides/create_templates"},{"title":"Arbeitsaufträge planen, terminieren und zuweisen","description":"Arbeiten Sie mit Arbeitsaufträgen und Checklisten, weisen Sie Aktivitäten Disziplinen oder Benutzern zu, erstellen Sie Checklisten aus Arbeitsaufträgen und verfolgen Sie den Fortschritt der Aufgaben.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/de/cdf/infield/guides/plan"},{"title":"Arbeitsaufträge ausführen","description":"Arbeiten Sie mit Checklisten, um Aufgaben abzuschließen, Messwerte hinzuzufügen, Beobachtungen aufzuzeichnen und offline auf Ihrem mobilen Gerät zu arbeiten.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/de/cdf/infield/guides/perform"},{"title":"Beobachtungen erstellen und anzeigen","description":"Ausrüstungsprobleme, die während der Arbeit entdeckt wurden, aufzeichnen, ihren Status verfolgen und Berichte senden.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/de/cdf/infield/guides/observations"},{"title":"Problembehandlung","description":"Finden Sie Informationen, die Ihnen helfen, häufige Probleme zu beheben.","content-type":"troubleshooting","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"support","article-type":"article","href":"/de/cdf/infield/guides/troubleshoot"}]},{"group":"Maintain","pages":[{"title":"Über Cognite Maintain","sidebarTitle":"Übersicht","description":"Cognite Maintain hilft Ihnen, Ihre Feldaktivitäten für mittel- bis langfristige Projekte zu planen, zu überprüfen und zu verbessern.","content-type":"concept","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/de/cdf/maintain/index"},{"title":"Aktivitäten planen","description":"Erstellen und verwalten Sie Pläne, um Aktivitäten zu terminieren, Konflikte zu identifizieren und den Arbeitsumfang zu optimieren.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/de/cdf/maintain/guides/set_work_scope"},{"title":"Aktivitäten in Maintain importieren","sidebarTitle":"Aktivitäten importieren","description":"Erfahren Sie, wie Sie Aktivitäten über die Benutzeroberfläche (APM-Modus), das Cognite Toolkit oder Transformationen importieren können.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/de/cdf/maintain/guides/import_activities"}]},{"group":"Externe Ressourcen","pages":[{"title":"Industrial Data Science Library","url":"https://indsl.docs.cognite.com/","description":null,"href":"/cdf/indsl"}]}]}]},{"language":"es","tabs":[{"tab":"Bienvenidos","groups":[{"group":"Bienvenidos","pages":[{"title":"Documentación de Cognite","description":"Documentación de autoservicio para desarrolladores y profesionales de la tecnología.","mode":"wide","to-L10N":true,"content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/es"}]},{"group":"Comenzando","pages":[{"title":"Acerca de Cognite Data Fusion (CDF)","description":"Cognite Data Fusion (CDF) es una plataforma industrial de DataOps que transmite sus datos industriales a un gráfico de conocimiento estructurado, flexible y contextualizado.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/es/cdf/index"},{"title":"Iniciar sesión en CDF","description":"Para iniciar sesión en Cognite Data Fusion, debe proporcionar el nombre de su organización, ingresar sus credenciales y especificar a qué proyecto está iniciando sesión.","content-type":"procedure","audience":"businessUser","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":true,"href":"/es/cdf/sign-in"},{"title":"Suscribirse a CDF","description":"Suscríbete a Cognite Data Fusion (CDF) y conéctate a nuestras aplicaciones y servicios basados en la nube.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/es/cdf/sign-up"}]}]},{"tab":"Flows","groups":[{"group":"Flows","pages":[{"title":"Acerca de Flows","sidebarTitle":"Resumen","description":"Utilice el espacio de trabajo de Flows para encontrar y analizar datos.","content-type":"reference","mode":"wide","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"map","href":"/es/cdf/flows_workspace"},{"title":"Espacio de trabajo de Flows","description":"Navegue por la barra lateral del área de trabajo de Flows para cambiar de herramientas y proyectos, chatear con Cognite Atlas y gestionar la ayuda y la configuración del perfil.","content-type":"reference","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"article","href":"/es/cdf/flows_workspace/flows_workspace"},{"title":"Búsqueda","description":"Guía paso a paso para encontrar datos industriales en Cognite Data Fusion (CDF), desde filtrar y ordenar resultados hasta previsualizar un elemento y descargar listas como CSV.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/es/cdf/explore/search"},{"title":"Explorar 3D","description":"Explora activos físicos en entornos 3D y busca equipos dentro de modelos de ubicación.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/es/cdf/explore/navigate_3d"},{"title":"Canvas","description":"Guía paso a paso para crear un lienzo, cargar archivos, añadir series temporales y diagramas, trabajar con archivos PDF, crear mapas de causas, organizar lienzos con etiquetas y utilizar agentes para analizar datos industriales.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/es/cdf/explore/canvas"},{"title":"Charts","description":"Analizar datos de series temporales, crear cálculos, establecer umbrales, monitorear alertas, evaluar la calidad de los datos y visualizar actividades.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/es/cdf/explore/charts"},{"title":"Aplicaciones personalizadas","description":"Acceda a aplicaciones personalizadas diseñadas para los flujos de trabajo específicos de su organización.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/es/cdf/explore/custom_apps"},{"title":"Agentes","description":"Trabaje con agentes de Atlas AI entrenados con sus datos y personalizados para los casos de uso específicos de su organización.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/es/cdf/explore/agents"}]},{"group":"InField","pages":[{"title":"Acerca de Cognite InField","sidebarTitle":"Resumen","description":"Ayude a los trabajadores de campo y supervisores a planificar y realizar sus tareas de manera eficiente, reemplazando la recopilación de datos en papel.","content-type":"map","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/es/cdf/infield/index"},{"title":"Crear plantillas y listas de verificación","description":"Cree plantillas, añada tareas y horarios, y genere listas de verificación para que los trabajadores de campo realicen a intervalos regulares.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/es/cdf/infield/guides/create_templates"},{"title":"Planificar, programar y asignar actividades","description":"Ver órdenes de trabajo y listas de verificación, asignar actividades a disciplinas o usuarios, crear listas de verificación a partir de órdenes de trabajo y rastrear el progreso de las tareas.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/es/cdf/infield/guides/plan"},{"title":"Realizar actividades","description":"Trabaje con listas de verificación para completar tareas, agregar lecturas de medición, registrar observaciones y trabajar sin conexión en su dispositivo móvil.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/es/cdf/infield/guides/perform"},{"title":"Crear y ver observaciones","description":"Registre los problemas de equipo descubiertos durante el trabajo, rastree su estado y envíe informes.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/es/cdf/infield/guides/observations"},{"title":"Solución de problemas","description":"Encuentra información para ayudarte a resolver problemas comunes.","content-type":"troubleshooting","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"support","article-type":"article","href":"/es/cdf/infield/guides/troubleshoot"}]},{"group":"Maintain","pages":[{"title":"Acerca de Cognite Maintain","sidebarTitle":"Resumen","description":"Cognite Maintain le ayuda a planificar, revisar y mejorar sus actividades en el campo para proyectos de mediano a largo plazo.","content-type":"concept","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/es/cdf/maintain/index"},{"title":"Planificar actividades","description":"Crear y gestionar planes para programar actividades, identificar conflictos y optimizar el alcance del trabajo.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/es/cdf/maintain/guides/set_work_scope"},{"title":"Importar actividades en Maintain","sidebarTitle":"Importar actividades","description":"Aprenda a importar actividades utilizando la interfaz de usuario (modo APM), Cognite Toolkit o Transformaciones.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/es/cdf/maintain/guides/import_activities"}]},{"group":"Recursos externos","pages":[{"title":"Industrial Data Science Library","url":"https://indsl.docs.cognite.com/","description":null,"href":"/cdf/indsl"}]}]}]},{"language":"fr","tabs":[{"tab":"Bienvenue","groups":[{"group":"Bienvenue","pages":[{"title":"Documentation de Cognite","description":"Documentation en libre-service pour les développeurs et les professionnels de la technologie.","mode":"wide","to-L10N":true,"content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/fr"}]},{"group":"Commencer","pages":[{"title":"À propos de Cognite Data Fusion (CDF)","description":"Cognite Data Fusion (CDF) est une plateforme industrielle de DataOps qui diffuse vos données industrielles dans un graphe de connaissances structuré, flexible et contextualisé.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/fr/cdf/index"},{"title":"Connexion à CDF","description":"Pour vous connecter à Cognite Data Fusion, vous devez fournir le nom de votre organisation, entrer vos identifiants et spécifier le projet auquel vous vous connectez.","content-type":"procedure","audience":"businessUser","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":true,"href":"/fr/cdf/sign-in"},{"title":"Abonnement à CDF","description":"Abonnez-vous à Cognite Data Fusion (CDF) et connectez-vous à nos applications et services basés sur le cloud.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/fr/cdf/sign-up"}]}]},{"tab":"Flows","groups":[{"group":"Flows","pages":[{"title":"À propos des Flows","sidebarTitle":"Vue d'ensemble","description":"Utilisez l'espace de travail des Flows pour trouver et analyser des données.","content-type":"reference","mode":"wide","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"map","href":"/fr/cdf/flows_workspace/index"},{"title":"Espace de travail Flows","description":"Utilisez la barre latérale de l'espace de travail Flows pour changer d'outils et de projets, discuter avec Cognite Atlas et gérer l'aide et les paramètres de profil.","content-type":"reference","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"article","href":"/fr/cdf/flows_workspace/flows_workspace"},{"title":"Recherche","description":"Guide étape par étape pour trouver des données industrielles dans Cognite Data Fusion (CDF), du filtrage et du tri des résultats à la prévisualisation d'un élément et au téléchargement de listes au format CSV.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/fr/cdf/explore/search"},{"title":"Parcourir les modèles 3D","description":"Explorez les actifs physiques dans des environnements 3D et recherchez des équipements dans les modèles de localisation.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/fr/cdf/explore/navigate_3d"},{"title":"Canvas","description":"Guide étape par étape pour créer un canevas, télécharger des fichiers, ajouter des séries temporelles et des diagrammes, travailler avec des PDF, créer des cartes causales, organiser les canevas avec des étiquettes et utiliser des agents pour analyser des données industrielles.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/fr/cdf/explore/canvas"},{"title":"Charts","description":"Analysez les données de séries temporelles, créez des calculs, définissez des seuils, surveillez les alertes, évaluez la qualité des données et visualisez les activités.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/fr/cdf/explore/charts"},{"title":"Applications personnalisées","description":"Accédez à des applications personnalisées conçues pour les flux de travail spécifiques de votre organisation.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/fr/cdf/explore/custom_apps"},{"title":"Agents","description":"Travaillez avec des agents Atlas AI formés sur vos données et personnalisés pour les cas d'utilisation spécifiques de votre organisation.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/fr/cdf/explore/agents"}]},{"group":"InField","pages":[{"title":"À propos de Cognite InField","sidebarTitle":"Vue d'ensemble","description":"Aidez les travailleurs de terrain et les superviseurs à planifier et à exécuter efficacement leurs tâches en remplaçant la collecte de données sur papier.","content-type":"map","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/fr/cdf/infield/index"},{"title":"Création de modèles et de listes de contrôle","description":"Créez des modèles, ajoutez des tâches et des plannings, et générez des listes de contrôle pour que les travailleurs sur le terrain puissent les réaliser à intervalles réguliers.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/fr/cdf/infield/guides/create_templates"},{"title":"Planification, programmation et affectation d’activités","description":"Consultez les ordres de travail et les listes de contrôle, assignez des activités à des disciplines ou des utilisateurs, créez des listes de contrôle à partir des ordres de travail et suivez l'avancement des tâches.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/fr/cdf/infield/guides/plan"},{"title":"Réalisation d’activités","description":"Travaillez avec des listes de contrôle pour accomplir des tâches, ajouter des relevés de mesure, enregistrer des observations et travailler hors ligne sur votre appareil mobile.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/fr/cdf/infield/guides/perform"},{"title":"Création et consultation des observations","description":"Enregistrez les problèmes d'équipement découverts lors du travail, suivez leur statut et envoyez des rapports.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/fr/cdf/infield/guides/observations"},{"title":"Dépannage","description":"Trouvez des informations pour vous aider à résoudre des problèmes courants.","content-type":"troubleshooting","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"support","article-type":"article","href":"/fr/cdf/infield/guides/troubleshoot"}]},{"group":"Maintain","pages":[{"title":"À propos de Cognite Maintain","sidebarTitle":"Vue d'ensemble","description":"Cognite Maintain vous aide à planifier, examiner et améliorer vos activités sur le terrain pour des projets à moyen et long terme.","content-type":"concept","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/fr/cdf/maintain/index"},{"title":"Planifiez des activités","description":"Créez et gérez des plans pour programmer des activités, identifier des conflits et optimiser l'étendue du travail.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/fr/cdf/maintain/guides/set_work_scope"},{"title":"Importer des activités dans Maintain","sidebarTitle":"Importer des activités","description":"Apprenez à importer des activités en utilisant l'interface utilisateur (mode APM), Cognite Toolkit ou Transformations.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/fr/cdf/maintain/guides/import_activities"}]},{"group":"Ressources externes","pages":[{"title":"Industrial Data Science Library","url":"https://indsl.docs.cognite.com/","description":null,"href":"/cdf/indsl"}]}]}]},{"language":"ko","tabs":[{"tab":"환영합니다","groups":[{"group":"환영합니다","pages":[{"title":"코그나이트 문서","description":"개발자 및 기술 전문가를 위한 셀프 서비스 제품 문서입니다.","mode":"wide","to-L10N":true,"content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/ko"}]},{"group":"시작하기","pages":[{"title":"Cognite Data Fusion(CDF) 정보","description":"Cognite Data Fusion (CDF)는 산업 데이터를 구조화되고 유연하며 맥락화된 지식 그래프로 스트리밍하는 산업 DataOps 플랫폼입니다.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/ko/cdf/index"},{"title":"CDF 로그인","description":"Cognite Data Fusion에 로그인하려면 조직의 이름을 제공하고, 자격 증명을 입력하며, 로그인할 프로젝트를 지정해야 합니다.","content-type":"procedure","audience":"businessUser","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":true,"href":"/ko/cdf/sign-in"},{"title":"CDF 가입","description":"Cognite Data Fusion (CDF)에 구독하고 클라우드 기반 앱 및 서비스에 연결하여 사용하세요.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/ko/cdf/sign-up"}]}]},{"tab":"Flows","groups":[{"group":"Flows","pages":[{"title":"Flows 정보","sidebarTitle":"개요","description":"Flows 작업 공간을 사용하여 데이터를 찾고 분석합니다.","content-type":"reference","mode":"wide","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"map","href":"/ko/cdf/flows_workspace/index"},{"title":"Flows 작업 공간","description":"Flows 작업 영역 사이드바를 탐색하여 도구와 프로젝트를 전환하고, Cognite Atlas와 대화하며, 도움말 및 프로필 설정을 관리하세요.","content-type":"reference","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"article","href":"/ko/cdf/flows_workspace/flows_workspace"},{"title":"검색","sidebarTitle":"검색","description":"결과 필터링 및 정렬부터 항목 미리 보기, CSV로 목록 다운로드에 이르기까지 Cognite Data Fusion(CDF)에서 산업 데이터를 찾는 단계별 가이드입니다.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ko/cdf/explore/search"},{"title":"3D 찾아보기","description":"3D 환경에서 물리적 자산을 탐색하고 위치 모델 내에서 장비를 검색합니다.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ko/cdf/explore/navigate_3d"},{"title":"Canvas","description":"캔버스 생성, 파일 업로드, 시계열 및 다이어그램 추가, PDF 작업, 인과 관계 맵 구축, 레이블을 사용한 캔버스 정리, 에이전트를 활용한 산업 데이터 분석을 위한 단계별 가이드입니다.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ko/cdf/explore/canvas"},{"title":"Charts","description":"시계열 데이터를 분석하고, 계산을 생성하며, 임계값을 설정하고, 경고를 모니터링하고, 데이터 품질을 평가하며, 활동을 시각화합니다.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ko/cdf/explore/charts"},{"title":"사용자 지정 앱","description":"조직의 특정 작업 흐름에 맞게 구축된 맞춤형 애플리케이션에 액세스하십시오.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ko/cdf/explore/custom_apps"},{"title":"에이전트","description":"귀하의 데이터에 대해 훈련되고 귀하 조직의 특정 사용 사례에 맞게 맞춤화된 Atlas AI 에이전트와 함께 작업하십시오.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ko/cdf/explore/agents"}]},{"group":"InField","pages":[{"title":"Cognite InField 소개","sidebarTitle":"개요","description":"현장 작업자와 감독이 종이 기반 데이터 수집을 대체하여 작업을 효율적으로 계획하고 수행할 수 있도록 돕습니다.","content-type":"map","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/ko/cdf/infield/index"},{"title":"템플릿 및 체크리스트 생성","description":"템플릿을 생성하고, 작업 및 일정을 추가하며, 현장 작업자가 정기적으로 수행할 체크리스트를 생성합니다.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/ko/cdf/infield/guides/create_templates"},{"title":"활동 계획, 예약 및 할당","description":"작업 지시서 및 체크리스트를 보고, 활동을 분야 또는 사용자에게 할당하고, 작업 지시서에서 체크리스트를 생성하며, 작업 진행 상황을 추적합니다.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/ko/cdf/infield/guides/plan"},{"title":"활동 수행","description":"작업을 완료하고, 측정값을 추가하며, 관찰을 기록하고, 모바일 장치에서 오프라인으로 작업하기 위해 체크리스트를 사용하십시오.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ko/cdf/infield/guides/perform"},{"title":"관찰 생성 및 보기","description":"작업 중 발견된 장비 문제를 기록하고, 상태를 추적하며, 보고서를 전송합니다.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ko/cdf/infield/guides/observations"},{"title":"문제 해결","description":"문제를 해결하는 데 도움이 되는 정보를 찾으세요.","content-type":"troubleshooting","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"support","article-type":"article","href":"/ko/cdf/infield/guides/troubleshoot"}]},{"group":"Maintain","pages":[{"title":"Cognite Maintain 정보","sidebarTitle":"개요","description":"Cognite Maintain은 중장기 프로젝트를 위한 현장 활동을 계획하고 검토하며 개선하는 데 도움을 줍니다.","content-type":"concept","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/ko/cdf/maintain/index"},{"title":"활동 계획하기","description":"활동을 일정에 맞춰 계획하고, 충돌을 식별하며, 작업 범위를 최적화하기 위한 계획을 생성하고 관리합니다.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ko/cdf/maintain/guides/set_work_scope"},{"title":"활동을 Maintain로 가져오기","sidebarTitle":"활동 가져오기","description":"사용자 인터페이스(APM 모드), Cognite Toolkit 또는 변환을 사용하여 활동을 가져오는 방법을 배우십시오.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/ko/cdf/maintain/guides/import_activities"}]},{"group":"외부 리소스","pages":[{"title":"Industrial Data Science Library","url":"https://indsl.docs.cognite.com/","description":null,"href":"/cdf/indsl"}]}]}]},{"language":"it","tabs":[{"tab":"Benvenuto","groups":[{"group":"Benvenuto","pages":[{"title":"Documentazione di Cognite","description":"Documentazione self-service per sviluppatori e professionisti della tecnologia.","mode":"wide","to-L10N":true,"content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/it"}]},{"group":"Iniziare","pages":[{"title":"Informazioni su Cognite Data Fusion (CDF)","description":"Cognite Data Fusion (CDF) è una piattaforma industriale di DataOps che trasmette i tuoi dati industriali in un grafo della conoscenza strutturato, flessibile e contestualizzato.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/it/cdf/index"},{"title":"Accesso a CDF","description":"Per accedere a Cognite Data Fusion, è necessario fornire il nome della propria organizzazione, inserire le proprie credenziali e specificare a quale progetto si sta accedendo.","content-type":"procedure","audience":"businessUser","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":true,"href":"/it/cdf/sign-in"},{"title":"Abbonamento a CDF","description":"Iscriviti a Cognite Data Fusion (CDF) e connettiti e utilizza le nostre app e servizi basati su cloud.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/it/cdf/sign-up"}]}]},{"tab":"Flows","groups":[{"group":"Flows","pages":[{"title":"Informazioni sui Flows","sidebarTitle":"Panoramica","description":"Utilizza lo spazio di lavoro Flows per trovare e analizzare i dati.","content-type":"reference","mode":"wide","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"map","href":"/it/cdf/flows_workspace/index"},{"title":"Flows spazio di lavoro","description":"Esplora la barra laterale dell'area di lavoro Flows per cambiare strumenti e progetti, chattare con Cognite Atlas e gestire le impostazioni del profilo e della guida.","content-type":"reference","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"article","href":"/it/cdf/flows_workspace/flows_workspace"},{"title":"Cerca","description":"Guida passo dopo passo per trovare dati industriali in Cognite Data Fusion (CDF), dal filtraggio e ordinamento dei risultati all'anteprima di un elemento e al download di elenchi come CSV.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/it/cdf/explore/search"},{"title":"Sfoglia 3D","description":"Esplora beni fisici in ambienti 3D e cerca attrezzature all'interno dei modelli di posizione.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/it/cdf/explore/navigate_3d"},{"title":"Canvas","description":"Guida passo dopo passo per creare una canvas, caricare file, aggiungere serie temporali e diagrammi, lavorare con PDF, costruire mappe causali, organizzare le canvas con etichette e utilizzare agenti per analizzare dati industriali.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/it/cdf/explore/canvas"},{"title":"Charts","description":"Analizza i dati delle serie temporali, crea calcoli, imposta soglie, monitora avvisi, valuta la qualità dei dati e visualizza le attività.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/it/cdf/explore/charts"},{"title":"App personalizzate","description":"Accedi a applicazioni personalizzate create per i flussi di lavoro specifici della tua organizzazione.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/it/cdf/explore/custom_apps"},{"title":"Agenti","description":"Lavora con gli agenti di Atlas AI addestrati sui tuoi dati e personalizzati per i casi d'uso specifici della tua organizzazione.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/it/cdf/explore/agents"}]},{"group":"InField","pages":[{"title":"Informazioni su Cognite InField","sidebarTitle":"Panoramica","description":"Aiuta i lavoratori e i supervisori sul campo a pianificare e svolgere le loro attività in modo efficiente, sostituendo la raccolta di dati su carta.","content-type":"map","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/it/cdf/infield/index"},{"title":"Creazione di modelli ed elenchi di controllo","description":"Crea modelli, aggiungi compiti e programmi, e genera liste di controllo per i lavoratori sul campo da eseguire a intervalli regolari.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/it/cdf/infield/guides/create_templates"},{"title":"Pianificazione, programmazione e assegnazione di attività","description":"Visualizza gli ordini di lavoro e le liste di controllo, assegna attività a discipline o utenti, crea liste di controllo dagli ordini di lavoro e monitora il progresso delle attività.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/it/cdf/infield/guides/plan"},{"title":"Esecuzione di attività","description":"Lavora con le liste di controllo per completare i compiti, aggiungere letture di misurazione, registrare osservazioni e lavorare offline sul tuo dispositivo mobile.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/it/cdf/infield/guides/perform"},{"title":"Creazione e visualizzazione di osservazioni","description":"Registra i problemi dell'attrezzatura scoperti durante il lavoro, monitora il loro stato e invia rapporti.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/it/cdf/infield/guides/observations"},{"title":"Risoluzione dei problemi","description":"Trova informazioni per aiutarti a risolvere problemi comuni.","content-type":"troubleshooting","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"support","article-type":"article","href":"/it/cdf/infield/guides/troubleshoot"}]},{"group":"Maintain","pages":[{"title":"Informazioni su Cognite Maintain","sidebarTitle":"Panoramica","description":"Cognite Maintain ti aiuta a pianificare, rivedere e migliorare le tue attività sul campo per progetti a medio e lungo termine.","content-type":"concept","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/it/cdf/maintain/index"},{"title":"Pianifica attività","description":"Crea e gestisci piani per programmare attività, identificare conflitti e ottimizzare l'ambito di lavoro.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/it/cdf/maintain/guides/set_work_scope"},{"title":"Importa attività in Maintain","sidebarTitle":"Importa attività","description":"Scopri come importare attività utilizzando l'interfaccia utente (solo modalità APM), Cognite Toolkit o Trasformazioni.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/it/cdf/maintain/guides/import_activities"}]},{"group":"Risorse esterne","pages":[{"title":"Industrial Data Science Library","url":"https://indsl.docs.cognite.com/","description":null,"href":"/cdf/indsl"}]}]}]},{"language":"lv","tabs":[{"tab":"Laipni lūdzam","groups":[{"group":"Laipni lūdzam","pages":[{"title":"Cognite dokumentācija","description":"Pašapkalpošanās produktu dokumentācija izstrādātājiem un tehnoloģiju profesionāļiem.","mode":"wide","to-L10N":true,"content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/lv"}]},{"group":"Sākt","pages":[{"title":"Par Cognite Data Fusion (CDF)","description":"Cognite Data Fusion (CDF) ir industriāla DataOps platforma, kas straumē jūsu industriālos datus strukturētā, elastīgā un kontekstualizētā zināšanu grafikā.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/lv/cdf/index"},{"title":"Pierakstīšanās platformā CDF","description":"Lai pierakstītos Cognite Data Fusion, jums jānorāda jūsu organizācijas nosaukums, jāievada savi akreditīvi un jānorāda, uz kuru projektu jūs pierakstāties.","content-type":"procedure","audience":"businessUser","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":true,"href":"/lv/cdf/sign-in"},{"title":"CDF abonēšana","description":"Abonējiet Cognite Data Fusion (CDF) un pieslēdzieties mūsu mākoņpakalpojumiem un lietotnēm.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/lv/cdf/sign-up"}]}]},{"tab":"Flows","groups":[{"group":"Flows","pages":[{"title":"Par Flows","sidebarTitle":"Pārskats","description":"Izmantojiet Flows darba vietu, lai atrastu un analizētu datus.","content-type":"reference","mode":"wide","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"map","href":"/lv/cdf/flows_workspace/index"},{"title":"Flows darba vieta","description":"Pārvietojieties pa Flows darbvietas sānjoslu, lai pārslēgtos starp rīkiem un projektiem, tērzētu ar Cognite Atlas un pārvaldītu palīdzības un profila iestatījumus.","content-type":"reference","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"article","href":"/lv/cdf/flows_workspace/flows_workspace"},{"title":"Meklēšana","description":"Soli pa solim izstrādāta rokasgrāmata rūpniecisko datu atrašanai Cognite Data Fusion (CDF), sākot no rezultātu filtrēšanas un kārtošanas līdz vienuma priekšskatīšanai un sarakstu lejupielādei CSV formātā.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/lv/cdf/explore/search"},{"title":"3D attēlu pārlūkošana","description":"Izpētiet fiziskos aktīvus 3D vidēs un meklējiet aprīkojumu atrašanās vietas modeļos.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/lv/cdf/explore/navigate_3d"},{"title":"Canvas","description":"Soli pa solim sniegts ceļvedis, kā izveidot audeklu, augšupielādēt failus, pievienot laika rindas un diagrammas, strādāt ar PDF failiem, veidot cēloņsakarību kartes, organizēt audeklus ar etiķetēm un izmantot aģentus rūpniecisko datu analīzei.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/lv/cdf/explore/canvas"},{"title":"Charts","description":"Analizējiet laika sēriju datus, veidojiet aprēķinus, iestatiet sliekšņus, uzraugiet brīdinājumus, novērtējiet datu kvalitāti un vizualizējiet aktivitātes.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/lv/cdf/explore/charts"},{"title":"Pielāgotas programmas","description":"Piekļūstiet pielāgotām lietojumprogrammām, kas izstrādātas jūsu organizācijas specifiskajiem darba procesiem.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/lv/cdf/explore/custom_apps"},{"title":"Aģenti","description":"Strādājiet ar Atlas AI aģentiem, kas apmācīti uz jūsu datiem un pielāgoti jūsu organizācijas specifiskajām lietošanas gadījumiem.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/lv/cdf/explore/agents"}]},{"group":"InField","pages":[{"title":"Par Cognite InField","sidebarTitle":"Pārskats","description":"Palīdziet lauka darbiniekiem un uzraugiem efektīvi plānot un veikt savus uzdevumus, aizstājot papīra datu vākšanu.","content-type":"map","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/lv/cdf/infield/index"},{"title":"Veidņu un kontrolsarakstu izveide","description":"Izveidojiet veidnes, pievienojiet uzdevumus un grafikus, kā arī ģenerējiet kontrolsarakstus lauka darbiniekiem, lai tos veiktu regulāros intervālos.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/lv/cdf/infield/guides/create_templates"},{"title":"Plānošana, laika grafiku veidošana un darbību deleģēšana","description":"Skatīt darba pasūtījumus un kontrolsarakstus, piešķirt aktivitātes disciplīnām vai lietotājiem, izveidot kontrolsarakstus no darba pasūtījumiem un sekot uzdevumu progresam.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/lv/cdf/infield/guides/plan"},{"title":"Darbību izpilde","description":"Strādājiet ar kontrolsarakstiem, lai pabeigtu uzdevumus, pievienotu mērījumu rādījumus, reģistrētu novērojumus un strādātu bezsaistē savā mobilajā ierīcē.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/lv/cdf/infield/guides/perform"},{"title":"Novērojumu izveide un skatīšana","description":"Reģistrējiet aprīkojuma problēmas, kas atklātas darba laikā, izsekojiet to statusam un sūtiet ziņojumus.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/lv/cdf/infield/guides/observations"},{"title":"Problēmu novēršana","description":"Atrodiet informāciju, kas palīdzēs jums novērst biežākās problēmas.","content-type":"troubleshooting","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"support","article-type":"article","href":"/lv/cdf/infield/guides/troubleshoot"}]},{"group":"Maintain","pages":[{"title":"Par Cognite Maintain","sidebarTitle":"Pārskats","description":"Cognite Maintain palīdz plānot, pārskatīt un uzlabot jūsu lauka aktivitātes vidēja līdz ilgtermiņa projektiem.","content-type":"concept","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/lv/cdf/maintain/index"},{"title":"Plānojiet aktivitātes","description":"Izveidojiet un pārvaldiet plānus, lai plānotu aktivitātes, identificētu konfliktus un optimizētu darba apjomu.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/lv/cdf/maintain/guides/set_work_scope"},{"title":"Importēt aktivitātes programmā Maintain","sidebarTitle":"Importēt aktivitātes","description":"Uzziniet, kā importēt aktivitātes, izmantojot lietotāja saskarni (APM režīms), Cognite Toolkit vai Transformācijas.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/lv/cdf/maintain/guides/import_activities"}]},{"group":"Ārējie resursi","pages":[{"title":"Industrial Data Science Library","url":"https://indsl.docs.cognite.com/","description":null,"href":"/cdf/indsl"}]}]}]},{"language":"nl","tabs":[{"tab":"Welkom","groups":[{"group":"Welkom","pages":[{"title":"Cognite-documentatie","description":"Zelfbedieningsproductdocumentatie voor ontwikkelaars en technologieprofessionals.","mode":"wide","to-L10N":true,"content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/nl"}]},{"group":"Aan de slag","pages":[{"title":"Over Cognite Data Fusion (CDF)","description":"Cognite Data Fusion (CDF) is een industriële DataOps-platform dat uw industriële gegevens streamt naar een gestructureerde, flexibele en gecontextualiseerde kennisgrafiek.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/nl/cdf/index"},{"title":"Aanmelden bij CDF","description":"Om in te loggen op Cognite Data Fusion, moet u de naam van uw organisatie opgeven, uw inloggegevens invoeren en specificeren naar welk project u inlogt.","content-type":"procedure","audience":"businessUser","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":true,"href":"/nl/cdf/sign-in"},{"title":"Abonneren op CDF","description":"Abonneer u op Cognite Data Fusion (CDF) en verbind met en gebruik onze cloudgebaseerde apps en diensten.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/nl/cdf/sign-up"}]}]},{"tab":"Flows","groups":[{"group":"Flows","pages":[{"title":"Over Flows","sidebarTitle":"Overzicht","description":"Gebruik de Flows-werkruimte om gegevens te vinden en te analyseren.","content-type":"reference","mode":"wide","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"map","href":"/nl/cdf/flows_workspace/index"},{"title":"Flows werkruimte","description":"Navigeer door de zijbalk van de Flows-werkruimte om tussen tools en projecten te schakelen, te chatten met Cognite Atlas en hulp- en profielinstellingen te beheren.","content-type":"reference","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"article","href":"/nl/cdf/flows_workspace/flows_workspace"},{"title":"Zoeken","description":"Stapsgewijze handleiding voor het vinden van industriële gegevens in Cognite Data Fusion (CDF), van het filteren en sorteren van resultaten tot het bekijken van een item en het downloaden van lijsten als CSV.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/nl/cdf/explore/search"},{"title":"Bladeren in 3D","description":"Verken fysieke activa in 3D-omgevingen en zoek naar apparatuur binnen locatie-modellen.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/nl/cdf/explore/navigate_3d"},{"title":"Canvas","description":"Stapsgewijze handleiding voor het maken van een canvas, uploaden van bestanden, toevoegen van tijdreeksen en diagrammen, werken met pdf's, bouwen van oorzaak-gevolgdiagrammen, organiseren van canvassen met labels en gebruiken van agents voor het analyseren van industriële data.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/nl/cdf/explore/canvas"},{"title":"Charts","description":"Analyseer tijdreeksgegevens, maak berekeningen, stel drempels in, monitor waarschuwingen, beoordeel datakwaliteit en visualiseer activiteiten.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/nl/cdf/explore/charts"},{"title":"Aangepaste apps","description":"Toegang tot op maat gemaakte applicaties die zijn gebouwd voor de specifieke workflows van uw organisatie.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/nl/cdf/explore/custom_apps"},{"title":"Agenten","description":"Werk met Atlas AI-agenten die zijn getraind op uw gegevens en zijn aangepast voor de specifieke gebruiksgevallen van uw organisatie.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/nl/cdf/explore/agents"}]},{"group":"InField","pages":[{"title":"Over Cognite InField","sidebarTitle":"Overzicht","description":"Help veldwerkers en supervisors om hun taken efficiënt te plannen en uit te voeren, waarbij papiergebaseerde gegevensverzameling wordt vervangen.","content-type":"map","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/nl/cdf/infield/index"},{"title":"Sjablonen en controlelijsten maken","description":"Maak sjablonen, voeg taken en schema's toe, en genereer checklists voor veldwerkers om op regelmatige tijdstippen uit te voeren.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/nl/cdf/infield/guides/create_templates"},{"title":"Activiteiten plannen en toewijzen","description":"Bekijk werkorders en checklists, wijs activiteiten toe aan disciplines of gebruikers, maak checklists aan vanuit werkorders en volg de voortgang van taken.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/nl/cdf/infield/guides/plan"},{"title":"Activiteiten uitvoeren","description":"Werk met checklists om taken te voltooien, meetwaarden toe te voegen, observaties vast te leggen en offline te werken op uw mobiele apparaat.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/nl/cdf/infield/guides/perform"},{"title":"Observaties maken en bekijken","description":"Registreer apparatuurproblemen die tijdens het werk zijn ontdekt, volg hun status en stuur rapporten.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/nl/cdf/infield/guides/observations"},{"title":"Probleemoplossing","description":"Zoek informatie om u te helpen bij het oplossen van veelvoorkomende problemen.","content-type":"troubleshooting","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"support","article-type":"article","href":"/nl/cdf/infield/guides/troubleshoot"}]},{"group":"Maintain","pages":[{"title":"Over Cognite Maintain","sidebarTitle":"Overzicht","description":"Cognite Maintain helpt u bij het plannen, beoordelen en verbeteren van uw veldactiviteiten voor middelgrote tot langlopende projecten.","content-type":"concept","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/nl/cdf/maintain/index"},{"title":"Plan activiteiten","description":"Maak en beheer plannen om activiteiten te plannen, conflicten te identificeren en de werkomvang te optimaliseren.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/nl/cdf/maintain/guides/set_work_scope"},{"title":"Importeer activiteiten in Maintain","sidebarTitle":"Importeren van activiteiten","description":"Leer hoe u activiteiten kunt importeren met de gebruikersinterface (APM-modus), Cognite Toolkit of Transformations.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/nl/cdf/maintain/guides/import_activities"}]},{"group":"Externe bronnen","pages":[{"title":"Industrial Data Science Library","url":"https://indsl.docs.cognite.com/","description":null,"href":"/cdf/indsl"}]}]}]},{"language":"ja","tabs":[{"tab":"ようこそ","groups":[{"group":"ようこそ","pages":[{"title":"Cogniteのドキュメント","description":"開発者と技術専門家のためのセルフサービス製品ドキュメント。","mode":"wide","to-L10N":true,"content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/ja"}]},{"group":"始める","pages":[{"title":"Cognite Data Fusion(CDF)について","description":"Cognite Data Fusion (CDF) は、産業データを構造化され、柔軟で、文脈化された知識グラフにストリーミングする産業データオペレーションプラットフォームです。","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/ja/cdf/index"},{"title":"CDF にサインインする","description":"Cognite Data Fusionにサインインするには、組織名を提供し、認証情報を入力し、サインインするプロジェクトを指定する必要があります。","content-type":"procedure","audience":"businessUser","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":true,"href":"/ja/cdf/sign-in"},{"title":"CDF に登録する","description":"Cognite Data Fusion (CDF)に登録し、私たちのクラウドベースのアプリやサービスに接続して使用してください。","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/ja/cdf/sign-up"}]}]},{"tab":"Flows","groups":[{"group":"Flows","pages":[{"title":"Flowsについて","sidebarTitle":"概要","description":"Flowsワークスペースを使用してデータを見つけ、分析します。","content-type":"reference","mode":"wide","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"map","href":"/ja/cdf/flows_workspace/index"},{"title":"Flowsワークスペース","sidebarTitle":"Flowsワークスペース","description":"Flowsワークスペースのサイドバーを操作して、ツールやプロジェクトの切り替え、Cognite Atlasとのチャット、ヘルプやプロファイル設定の管理を行います。","content-type":"reference","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"article","href":"/ja/cdf/flows_workspace/flows_workspace"},{"title":"検索","description":"Cognite Data Fusion (CDF) で産業データを検索するためのステップバイステップガイドです。結果のフィルタリングや並べ替えから、アイテムのプレビュー、リストのCSVダウンロードまでを説明します。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ja/cdf/explore/search"},{"title":"3D を参照","description":"3D環境で物理資産を探索し、ロケーションモデル内の機器を検索します。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ja/cdf/explore/navigate_3d"},{"title":"Canvas","description":"キャンバスの作成、ファイルのアップロード、時系列データや図の追加、PDFの操作、因果マップの構築、ラベルによるキャンバスの整理、およびエージェントを使用した産業データの分析に関するステップバイステップガイドです。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ja/cdf/explore/canvas"},{"title":"Charts","description":"時系列データを分析し、計算を作成し、閾値を設定し、アラートを監視し、データの質を評価し、活動を可視化します。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ja/cdf/explore/charts"},{"title":"カスタム アプリ","description":"組織の特定のワークフローに合わせて構築されたカスタムアプリケーションにアクセスします。","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ja/cdf/explore/custom_apps"},{"title":"エージェント","description":"あなたのデータに基づいて訓練され、あなたの組織の特定の使用ケースにカスタマイズされたAtlas AIエージェントと連携してください。","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ja/cdf/explore/agents"}]},{"group":"InField","pages":[{"title":"Cognite InFieldについて","sidebarTitle":"概要","description":"現場の作業員と監督者が効率的にタスクを計画し、紙ベースのデータ収集を置き換えて作業を行うのを支援します。","content-type":"map","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/ja/cdf/infield/index"},{"title":"テンプレートとチェックリストを作成する","description":"テンプレートを作成し、タスクやスケジュールを追加し、フィールド作業者が定期的に実行するためのチェックリストを生成します。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/ja/cdf/infield/guides/create_templates"},{"title":"アクティビティの計画、スケジュール設定、および割り当てを行う","description":"作業指示書とチェックリストを表示し、活動を専門分野やユーザーに割り当て、作業指示書からチェックリストを作成し、タスクの進捗を追跡します。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/ja/cdf/infield/guides/plan"},{"title":"アクティビティを実行する","description":"チェックリストを使用してタスクを完了し、測定値を追加し、観察を記録し、モバイルデバイスでオフライン作業を行います。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ja/cdf/infield/guides/perform"},{"title":"観察の作成と表示","description":"作業中に発見された機器の問題を記録し、その状況を追跡し、報告書を送信します。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ja/cdf/infield/guides/observations"},{"title":"トラブルシューティング","description":"一般的な問題をトラブルシューティングするための情報を見つけてください。","content-type":"troubleshooting","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"support","article-type":"article","href":"/ja/cdf/infield/guides/troubleshoot"}]},{"group":"Maintain","pages":[{"title":"Cognite Maintainについて","sidebarTitle":"概要","description":"Cognite Maintainは、中長期プロジェクトのための現場活動を計画、レビュー、改善するのに役立ちます。","content-type":"concept","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/ja/cdf/maintain/index"},{"title":"アクティビティを計画する","description":"活動をスケジュールし、競合を特定し、作業範囲を最適化するための計画を作成および管理します。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ja/cdf/maintain/guides/set_work_scope"},{"title":"アクティビティをMaintainにインポートする","sidebarTitle":"アクティビティをインポート","description":"ユーザーインターフェース(APMモード)、Cognite Toolkit、またはTransformationsを使用してアクティビティをインポートする方法を学びます。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/ja/cdf/maintain/guides/import_activities"}]},{"group":"外部リソース","pages":[{"title":"Industrial Data Science Library","url":"https://indsl.docs.cognite.com/","description":null,"href":"/cdf/indsl"}]}]}]},{"language":"no","tabs":[{"tab":"Velkommen","groups":[{"group":"Velkommen","pages":[{"title":"Cognite dokumentasjon","description":"Selvbetjent produktdokumentasjon for utviklere og teknologiprofesjonelle.","mode":"wide","to-L10N":true,"content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/no"}]},{"group":"Kom i gang","pages":[{"title":"Om Cognite Data Fusion (CDF)","description":"Cognite Data Fusion (CDF) er en industriell DataOps-plattform som strømmer dine industrielle data inn i et strukturert, fleksibelt og kontekstualisert kunnskapsgraf.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/no/cdf/index"},{"title":"Logg på CDF","description":"For å logge inn på Cognite Data Fusion, må du oppgi navnet på organisasjonen din, skrive inn legitimasjonen din, og spesifisere hvilket prosjekt du logger inn på.","content-type":"procedure","audience":"businessUser","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":true,"href":"/no/cdf/sign-in"},{"title":"Abonnere på CDF","description":"Abonner på Cognite Data Fusion (CDF) og koble til og bruke våre skybaserte apper og tjenester.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/no/cdf/sign-up"}]}]},{"tab":"Flows","groups":[{"group":"Flows","pages":[{"title":"Om Flows","sidebarTitle":"Oversikt","description":"Bruk Flows-arbeidsområdet for å finne og analysere data.","content-type":"reference","mode":"wide","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"map","href":"/no/cdf/flows_workspace/index"},{"title":"Flows arbeidsområde","description":"Naviger i sidepanelet i Flows-arbeidsområdet for å bytte verktøy og prosjekter, chatte med Cognite Atlas og administrere hjelp- og profilinnstillinger.","content-type":"reference","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"article","href":"/no/cdf/flows_workspace/flows_workspace"},{"title":"Søk","description":"Trinnvis veiledning for å finne industridata i Cognite Data Fusion (CDF), fra filtrering og sortering av resultater til forhåndsvisning av et element og nedlasting av lister som CSV.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/no/cdf/explore/search"},{"title":"Bla gjennom 3D","description":"Utforsk fysiske eiendeler i 3D-miljøer og søk etter utstyr innenfor lokasjonsmodeller.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/no/cdf/explore/navigate_3d"},{"title":"Canvas","description":"Trinnvis veiledning for å opprette et lerret, laste opp filer, legge til tidsserier og diagrammer, arbeide med PDF-er, bygge årsakskart, organisere lerreter med merkelapper og bruke agenter til å analysere industridata.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/no/cdf/explore/canvas"},{"title":"Charts","description":"Analyser tidsseriedata, lag beregninger, sett terskler, overvåk varsler, vurder datakvalitet, og visualiser aktiviteter.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/no/cdf/explore/charts"},{"title":"Egendefinerte apper","description":"Få tilgang til tilpassede applikasjoner bygget for organisasjonens spesifikke arbeidsflyter.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/no/cdf/explore/custom_apps"},{"title":"Agenter","description":"Arbeid med Atlas AI-agenter som er trent på dine data og tilpasset for din organisasjons spesifikke bruksområder.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/no/cdf/explore/agents"}]},{"group":"InField","pages":[{"title":"Om Cognite InField","sidebarTitle":"Oversikt","description":"Hjelp feltarbeidere og veiledere med å planlegge og utføre oppgavene sine effektivt, og erstatte papirbasert datainnsamling.","content-type":"map","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/no/cdf/infield/index"},{"title":"Opprette maler og sjekklister","description":"Lag maler, legg til oppgaver og tidsplaner, og generer sjekklister for feltarbeidere som skal utføres med jevne mellomrom.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/no/cdf/infield/guides/create_templates"},{"title":"Planlegg, tidfest og tilordne aktiviteter","description":"Se arbeidsordrer og sjekklister, tilordne aktiviteter til disipliner eller brukere, opprette sjekklister fra arbeidsordrer, og spore fremdriften av oppgaver.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/no/cdf/infield/guides/plan"},{"title":"Utfør aktiviteter","description":"Arbeid med sjekklister for å fullføre oppgaver, legge til måleverdier, registrere observasjoner og arbeide frakoblet på din mobile enhet.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/no/cdf/infield/guides/perform"},{"title":"Lage og vise observasjoner","description":"Registrer utstyrsproblemer oppdaget under arbeidet, følg med på statusen deres, og send rapporter.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/no/cdf/infield/guides/observations"},{"title":"Feilsøking","description":"Finn informasjon for å hjelpe deg med å feilsøke vanlige problemer.","content-type":"troubleshooting","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"support","article-type":"article","href":"/no/cdf/infield/guides/troubleshoot"}]},{"group":"Maintain","pages":[{"title":"Om Cognite Maintain","sidebarTitle":"Oversikt","description":"Cognite Maintain hjelper deg med å planlegge, gjennomgå og forbedre feltaktiviteter for prosjekter med middels til lang sikt.","content-type":"concept","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/no/cdf/maintain/index"},{"title":"Planlegg aktiviteter","description":"Opprett og administrer planer for å planlegge aktiviteter, identifisere konflikter og optimalisere arbeidsomfang.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/no/cdf/maintain/guides/set_work_scope"},{"title":"Importer aktiviteter til Maintain","sidebarTitle":"Importere aktiviteter","description":"Lær hvordan du importerer aktiviteter ved hjelp av brukergrensesnittet (APM-modus), Cognite Toolkit eller Transformasjoner.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/no/cdf/maintain/guides/import_activities"}]},{"group":"Eksterne ressurser","pages":[{"title":"Industrial Data Science Library","url":"https://indsl.docs.cognite.com/","description":null,"href":"/cdf/indsl"}]}]}]},{"language":"pt","tabs":[{"tab":"Boas-vindas","groups":[{"group":"Boas-vindas","pages":[{"title":"Documentação da Cognite","description":"Documentação de autoatendimento para desenvolvedores e profissionais de tecnologia.","mode":"wide","to-L10N":true,"content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/pt"}]},{"group":"Introdução","pages":[{"title":"Sobre o Cognite Data Fusion (CDF)","description":"Cognite Data Fusion (CDF) é uma plataforma industrial de DataOps que transmite seus dados industriais para um gráfico de conhecimento estruturado, flexível e contextualizado.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/pt/cdf/index"},{"title":"Fazer login no CDF","description":"Para fazer login no Cognite Data Fusion, você deve fornecer o nome da sua organização, inserir suas credenciais e especificar a qual projeto você está se conectando.","content-type":"procedure","audience":"businessUser","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":true,"href":"/pt/cdf/sign-in"},{"title":"Inscreva-se no CDF","description":"Inscreva-se no Cognite Data Fusion (CDF) e conecte-se e utilize nossos aplicativos e serviços baseados em nuvem.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/pt/cdf/sign-up"}]}]},{"tab":"Flows","groups":[{"group":"Flows","pages":[{"title":"Sobre Flows","sidebarTitle":"Visão geral","description":"Use o espaço de trabalho Flows para encontrar e analisar dados.","content-type":"reference","mode":"wide","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"map","href":"/pt/cdf/flows_workspace/index"},{"title":"Espaço de trabalho Flows","description":"Navegue pela barra lateral do espaço de trabalho do Flows para alternar entre ferramentas e projetos, conversar com o Cognite Atlas e gerenciar as configurações de ajuda e perfil.","content-type":"reference","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"article","href":"/pt/cdf/flows_workspace/flows_workspace"},{"title":"Pesquisa","sidebarTitle":"Pesquisa","description":"Guia passo a passo para encontrar dados industriais no Cognite Data Fusion (CDF), desde filtrar e classificar resultados até visualizar um item e baixar listas como CSV.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/pt/cdf/explore/search"},{"title":"Navegar em 3D","description":"Explore ativos físicos em ambientes 3D e busque equipamentos dentro dos modelos de localização.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/pt/cdf/explore/navigate_3d"},{"title":"Canvas","description":"Guia passo a passo para criar uma tela, fazer upload de arquivos, adicionar séries temporais e diagramas, trabalhar com PDFs, criar mapas de causa, organizar telas com etiquetas e usar agentes para analisar dados industriais.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/pt/cdf/explore/canvas"},{"title":"Charts","description":"Analise dados de séries temporais, crie cálculos, defina limites, monitore alertas, avalie a qualidade dos dados e visualize atividades.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/pt/cdf/explore/charts"},{"title":"Aplicativos personalizados","description":"Acesse aplicativos personalizados desenvolvidos para os fluxos de trabalho específicos da sua organização.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/pt/cdf/explore/custom_apps"},{"title":"Agentes","description":"Trabalhe com agentes Atlas AI treinados com seus dados e personalizados para os casos de uso específicos da sua organização.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/pt/cdf/explore/agents"}]},{"group":"InField","pages":[{"title":"Sobre o Cognite InField","sidebarTitle":"Visão geral","description":"Ajude os trabalhadores de campo e supervisores a planejar e realizar suas tarefas de forma eficiente, substituindo a coleta de dados em papel.","content-type":"map","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/pt/cdf/infield/index"},{"title":"Criar modelos e listas de verificação","description":"Crie modelos, adicione tarefas e cronogramas, e gere listas de verificação para os trabalhadores de campo realizarem em intervalos regulares.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/pt/cdf/infield/guides/create_templates"},{"title":"Planejar, agendar e atribuir atividades","description":"Visualize ordens de serviço e listas de verificação, atribua atividades a disciplinas ou usuários, crie listas de verificação a partir de ordens de serviço e acompanhe o progresso das tarefas.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/pt/cdf/infield/guides/plan"},{"title":"Executar atividades","description":"Trabalhe com listas de verificação para concluir tarefas, adicionar leituras de medição, registrar observações e trabalhar offline em seu dispositivo móvel.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/pt/cdf/infield/guides/perform"},{"title":"Criar e exibir observações","description":"Registre os problemas de equipamento descobertos durante o trabalho, acompanhe seu status e envie relatórios.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/pt/cdf/infield/guides/observations"},{"title":"Solução de problemas","description":"Encontre informações para ajudá-lo a solucionar problemas comuns.","content-type":"troubleshooting","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"support","article-type":"article","href":"/pt/cdf/infield/guides/troubleshoot"}]},{"group":"Maintain","pages":[{"title":"Sobre o Cognite Maintain","sidebarTitle":"Visão geral","description":"O Cognite Maintain ajuda você a planejar, revisar e melhorar suas atividades de campo para projetos de médio a longo prazo.","content-type":"concept","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/pt/cdf/maintain/index"},{"title":"Planejar atividades","description":"Crie e gerencie planos para agendar atividades, identificar conflitos e otimizar o escopo de trabalho.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/pt/cdf/maintain/guides/set_work_scope"},{"title":"Importar atividades para o Maintain","sidebarTitle":"Importar atividades","description":"Aprenda como importar atividades usando a interface do usuário (modo APM), Cognite Toolkit ou Transformações.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/pt/cdf/maintain/guides/import_activities"}]},{"group":"Recursos externos","pages":[{"title":"Industrial Data Science Library","url":"https://indsl.docs.cognite.com/","description":null,"href":"/cdf/indsl"}]}]}]},{"language":"ro","tabs":[{"tab":"Bine ați venit","groups":[{"group":"Bine ați venit","pages":[{"title":"Documentația Cognite","description":"Documentația de auto-servire pentru dezvoltatori și profesioniști în tehnologie.","mode":"wide","to-L10N":true,"content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/ro"}]},{"group":"Începere","pages":[{"title":"Despre Cognite Data Fusion (CDF)","description":"Cognite Data Fusion (CDF) este o platformă industrială de DataOps care transmite datele dumneavoastră industriale într-un grafic de cunoștințe structurat, flexibil și contextualizat.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/ro/cdf/index"},{"title":"Conectați-vă la CDF","description":"Pentru a vă conecta la Cognite Data Fusion, trebuie să furnizați numele organizației dumneavoastră, să introduceți acreditivele și să specificați la ce proiect vă conectați.","content-type":"procedure","audience":"businessUser","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":true,"href":"/ro/cdf/sign-in"},{"title":"Abonează-te la CDF","description":"Abonează-te la Cognite Data Fusion (CDF) și conectează-te la aplicațiile și serviciile noastre bazate pe cloud.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/ro/cdf/sign-up"}]}]},{"tab":"Flows","groups":[{"group":"Flows","pages":[{"title":"Despre Flows","sidebarTitle":"Prezentare generală","description":"Utilizați spațiul de lucru Flows pentru a găsi și analiza datele.","content-type":"reference","mode":"wide","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"map","href":"/ro/cdf/flows_workspace/index"},{"title":"Spațiul de lucru Flows","description":"Navigați prin bara laterală a spațiului de lucru Flows pentru a comuta între instrumente și proiecte, pentru a conversa cu Cognite Atlas și pentru a gestiona setările de ajutor și de profil.","content-type":"reference","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"article","href":"/ro/cdf/flows_workspace/flows_workspace"},{"title":"Căutare","sidebarTitle":"Căutare","description":"Ghid pas cu pas pentru găsirea datelor industriale în Cognite Data Fusion (CDF), de la filtrarea și sortarea rezultatelor până la previzualizarea unui element și descărcarea listelor ca CSV.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ro/cdf/explore/search"},{"title":"Răsfoiește 3D","description":"Explorează activele fizice în medii 3D și caută echipamente în modelele de locație.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ro/cdf/explore/navigate_3d"},{"title":"Canvas","description":"Ghid pas cu pas pentru a crea o planșă, a încărca fișiere, a adăuga serii temporale și diagrame, a lucra cu fișiere PDF, a construi hărți cauzale, a organiza planșele cu etichete și a utiliza agenți pentru a analiza date industriale.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ro/cdf/explore/canvas"},{"title":"Charts","description":"Analizați datele seriei temporale, creați calcule, stabiliți praguri, monitorizați alertele, evaluați calitatea datelor și vizualizați activitățile.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ro/cdf/explore/charts"},{"title":"Aplicații personalizate","description":"Accesați aplicații personalizate create pentru fluxurile de lucru specifice ale organizației dumneavoastră.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ro/cdf/explore/custom_apps"},{"title":"Agenți","description":"Lucrați cu agenți Atlas AI antrenați pe datele dumneavoastră și personalizați pentru cazurile specifice de utilizare ale organizației dumneavoastră.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ro/cdf/explore/agents"}]},{"group":"InField","pages":[{"title":"Despre Cognite InField","sidebarTitle":"Prezentare generală","description":"Ajuta lucrătorii din teren și supervizorii să planifice și să îndeplinească eficient sarcinile, înlocuind colectarea de date pe hârtie.","content-type":"map","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/ro/cdf/infield/index"},{"title":"Creează șabloane și liste de verificare","description":"Creează șabloane, adaugă sarcini și programe și generează liste de verificare pentru lucrătorii din teren să le execute la intervale regulate.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/ro/cdf/infield/guides/create_templates"},{"title":"Planifică, programează și atribuie activități","description":"Vizualizează ordinele de lucru și listele de verificare, atribuie activități disciplinelor sau utilizatorilor, creează liste de verificare din ordinele de lucru și urmărește progresul sarcinilor.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/ro/cdf/infield/guides/plan"},{"title":"Efectuați activități","description":"Lucrați cu liste de verificare pentru a finaliza sarcini, adăugați citiri de măsurare, înregistrați observații și lucrați offline pe dispozitivul mobil.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ro/cdf/infield/guides/perform"},{"title":"Creează și vizualizează observații","description":"Înregistrează problemele echipamentului descoperite în timpul lucrului, urmărește-le starea și trimite rapoarte.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ro/cdf/infield/guides/observations"},{"title":"Depanare","description":"Găsiți informații pentru a vă ajuta să depanați problemele comune.","content-type":"troubleshooting","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"support","article-type":"article","href":"/ro/cdf/infield/guides/troubleshoot"}]},{"group":"Maintain","pages":[{"title":"Despre Cognite Maintain","sidebarTitle":"Prezentare generală","description":"Cognite Maintain vă ajută să planificați, să revizuiți și să îmbunătățiți activitățile de teren pentru proiecte pe termen mediu și lung.","content-type":"concept","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/ro/cdf/maintain/index"},{"title":"Planificați activități","description":"Creați și gestionați planuri pentru a programa activități, a identifica conflicte și a optimiza domeniul de lucru.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/ro/cdf/maintain/guides/set_work_scope"},{"title":"Importați activitățile în Maintain","sidebarTitle":"Importați activitățile","description":"Învățați cum să importați activități folosind interfața utilizatorului (mod APM), Cognite Toolkit sau Transformări.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/ro/cdf/maintain/guides/import_activities"}]},{"group":"Resurse externe","pages":[{"title":"Industrial Data Science Library","url":"https://indsl.docs.cognite.com/","description":null,"href":"/cdf/indsl"}]}]}]},{"language":"sv","tabs":[{"tab":"Välkommen","groups":[{"group":"Välkommen","pages":[{"title":"Cognite-dokumentation","description":"Självbetjäningsproduktdokumentation för utvecklare och teknikprofessionella.","mode":"wide","to-L10N":true,"content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/sv"}]},{"group":"Komma igång","pages":[{"title":"Om Cognite Data Fusion (CDF)","description":"Cognite Data Fusion (CDF) är en industriell DataOps-plattform som strömmar din industriella data till en strukturerad, flexibel och kontextualiserad kunskapsgraf.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/sv/cdf/index"},{"title":"Logga in på CDF","description":"För att logga in på Cognite Data Fusion måste du ange ditt organisationsnamn, ange dina referenser och specificera vilket projekt du loggar in på.","content-type":"procedure","audience":"businessUser","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":true,"href":"/sv/cdf/sign-in"},{"title":"Prenumerera på CDF","description":"Prenumerera på Cognite Data Fusion (CDF) och anslut till och använd våra molnbaserade appar och tjänster.","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/sv/cdf/sign-up"}]}]},{"tab":"Flows","groups":[{"group":"Flows","pages":[{"title":"Om Flows","sidebarTitle":"Översikt","description":"Använd Flows-arbetsytan för att hitta och analysera data.","content-type":"reference","mode":"wide","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"map","href":"/sv/cdf/flows_workspace/index"},{"title":"Flows arbetsyta","description":"Navigera i sidofältet för Flows-arbetsytan för att växla mellan verktyg och projekt, chatta med Cognite Atlas och hantera hjälp- och profilinställningar.","content-type":"reference","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"article","href":"/sv/cdf/flows_workspace/flows_workspace"},{"title":"Sök","description":"Steg-för-steg-guide för att hitta industriella data i Cognite Data Fusion (CDF), från att filtrera och sortera resultat till att förhandsgranska ett objekt och ladda ner listor som CSV.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/sv/cdf/explore/search"},{"title":"Bläddra i 3D","description":"Utforska fysiska tillgångar i 3D-miljöer och sök efter utrustning inom platsmodeller.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/sv/cdf/explore/navigate_3d"},{"title":"Canvas","description":"Steg-för-steg-guide för att skapa en canvas, ladda upp filer, lägga till tidsserier och diagram, arbeta med PDF-filer, bygga orsakskartor, organisera canvasar med etiketter och använda agenter för att analysera industriella data.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/sv/cdf/explore/canvas"},{"title":"Charts","description":"Analysera tidsseriedata, skapa beräkningar, ställ in trösklar, övervaka varningar, bedöm datakvalitet och visualisera aktiviteter.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/sv/cdf/explore/charts"},{"title":"Anpassade appar","description":"Åtkomst till anpassade applikationer som är byggda för din organisations specifika arbetsflöden.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/sv/cdf/explore/custom_apps"},{"title":"Agenter","description":"Arbeta med Atlas AI-agenter som är tränade på dina data och anpassade för din organisations specifika användningsfall.","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/sv/cdf/explore/agents"}]},{"group":"InField","pages":[{"title":"Om Cognite InField","sidebarTitle":"Översikt","description":"Hjälp fältarbetare och övervakare att effektivt planera och utföra sina uppgifter och ersätta pappersbaserad datainsamling.","content-type":"map","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/sv/cdf/infield/index"},{"title":"Skapa mallar och checklistor","description":"Skapa mallar, lägg till uppgifter och scheman, och generera checklistor för fältarbetare att utföra med jämna mellanrum.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/sv/cdf/infield/guides/create_templates"},{"title":"Planera, schemalägg och tilldela aktiviteter","description":"Visa arbetsorder och checklistor, tilldela aktiviteter till discipliner eller användare, skapa checklistor från arbetsorder och spåra uppgiftens framsteg.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/sv/cdf/infield/guides/plan"},{"title":"Utför aktiviteter","description":"Arbeta med checklistor för att slutföra uppgifter, lägga till mätvärden, registrera observationer och arbeta offline på din mobila enhet.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/sv/cdf/infield/guides/perform"},{"title":"Skapa och visa observationer","description":"Registrera utrustningsproblem som upptäckts under arbetet, spåra deras status och skicka rapporter.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/sv/cdf/infield/guides/observations"},{"title":"Felsökning","description":"Hitta information för att hjälpa dig att felsöka vanliga problem.","content-type":"troubleshooting","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"support","article-type":"article","href":"/sv/cdf/infield/guides/troubleshoot"}]},{"group":"Maintain","pages":[{"title":"Om Cognite Maintain","sidebarTitle":"Översikt","description":"Cognite Maintain hjälper dig att planera, granska och förbättra dina fältaktiviteter för medellånga till långsiktiga projekt.","content-type":"concept","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/sv/cdf/maintain/index"},{"title":"Planera aktiviteter","description":"Skapa och hantera planer för att schemalägga aktiviteter, identifiera konflikter och optimera arbetsomfång.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/sv/cdf/maintain/guides/set_work_scope"},{"title":"Importera aktiviteter till Maintain","sidebarTitle":"Importera aktiviteter","description":"Lär dig hur du importerar aktiviteter med hjälp av användargränssnittet (APM-läge), Cognite Toolkit eller Transformationer.","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/sv/cdf/maintain/guides/import_activities"}]},{"group":"Externa resurser","pages":[{"title":"Industrial Data Science Library","url":"https://indsl.docs.cognite.com/","description":null,"href":"/cdf/indsl"}]}]}]},{"language":"zh","tabs":[{"tab":"欢迎","groups":[{"group":"欢迎","pages":[{"title":"Cognite 文档","description":"面向开发者和技术专业人员的自助产品文档。","mode":"wide","to-L10N":true,"content-type":"concept","audience":"dataEngineer","experience-level":100,"lifecycle":"use","article-type":"map","href":"/zh"}]},{"group":"开始使用","pages":[{"title":"关于 Cognite Data Fusion (CDF)","description":"Cognite数据融合(CDF)是一个工业数据操作平台,可以将您的工业数据流入一个结构化、灵活且具有上下文的知识图谱中。","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/zh/cdf/index"},{"title":"登录 CDF","description":"要登录Cognite Data Fusion,您必须提供您组织的名称,输入您的凭据,并指定您要登录的项目。","content-type":"procedure","audience":"businessUser","experience-level":100,"lifecycle":"setup","article-type":"article","to-L10N":true,"href":"/zh/cdf/sign-in"},{"title":"订阅CDF","description":"订阅Cognite Data Fusion (CDF),并连接和使用我们的云应用和服务。","content-type":"concept","audience":"businessUser","experience-level":100,"lifecycle":"investigate","article-type":"article","to-L10N":true,"href":"/zh/cdf/sign-up"}]}]},{"tab":"Flows","groups":[{"group":"Flows","pages":[{"title":"关于 Flows","sidebarTitle":"概述","description":"使用 Flows 工作区查找和分析数据。","content-type":"reference","mode":"wide","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"map","href":"/zh/cdf/flows_workspace/index"},{"title":"Flows 工作区","description":"在 Flows 工作区侧边栏中导航,以切换工具和项目、与 Cognite Atlas 聊天,以及管理帮助和个人资料设置。","content-type":"reference","to-L10N":true,"audience":"businessUser","experience-level":100,"lifecycle":"use","article-type":"article","href":"/zh/cdf/flows_workspace/flows_workspace"},{"title":"搜索","sidebarTitle":"搜索","description":"在 Cognite Data Fusion (CDF) 中查找工业数据的分步指南,内容涵盖从筛选和排序结果到预览项目以及将列表下载为 CSV。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/zh/cdf/explore/search"},{"title":"浏览 3D","description":"在3D环境中探索物理资产,并在位置模型中搜索设备。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/zh/cdf/explore/navigate_3d"},{"title":"Canvas","description":"创建画布、上传文件、添加时间序列和图表、处理PDF、构建因果图、使用标签组织画布以及使用智能体分析工业数据的分步指南。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/zh/cdf/explore/canvas"},{"title":"Charts","description":"分析时间序列数据,创建计算,设置阈值,监控警报,评估数据质量,并可视化活动。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/zh/cdf/explore/charts"},{"title":"自定义应用程序","description":"访问为您组织的特定工作流程构建的自定义应用程序。","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/zh/cdf/explore/custom_apps"},{"title":"代理","description":"与根据您的数据训练并为您组织的特定用例定制的Atlas AI代理合作。","content-type":"concept","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/zh/cdf/explore/agents"}]},{"group":"InField","pages":[{"title":"关于Cognite InField","sidebarTitle":"概述","description":"帮助现场工作人员和主管高效地规划和执行任务,取代基于纸张的数据收集。","content-type":"map","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/zh/cdf/infield/index"},{"title":"创建模板和检查清单","description":"创建模板,添加任务和日程,并生成供现场工作人员定期执行的检查清单。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/zh/cdf/infield/guides/create_templates"},{"title":"计划、安排和分配活动","description":"查看工作订单和检查清单,将活动分配给学科或用户,从工作订单创建检查清单,并跟踪任务进度。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/zh/cdf/infield/guides/plan"},{"title":"执行活动","description":"使用检查清单来完成任务,添加测量读数,记录观察结果,并在移动设备上离线工作。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/zh/cdf/infield/guides/perform"},{"title":"创建和查看观察记录","description":"记录在工作中发现的设备问题,跟踪其状态,并发送报告。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/zh/cdf/infield/guides/observations"},{"title":"故障排除","description":"查找信息以帮助您解决常见问题。","content-type":"troubleshooting","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"support","article-type":"article","href":"/zh/cdf/infield/guides/troubleshoot"}]},{"group":"Maintain","pages":[{"title":"关于 Cognite Maintain","sidebarTitle":"概述","description":"Cognite Maintain 帮助您规划、审查和改善中长期项目的现场活动。","content-type":"concept","audience":"businessUser","to-L10N":true,"mode":"wide","experience-level":100,"lifecycle":"use","article-type":"map","href":"/zh/cdf/maintain/index"},{"title":"计划活动","description":"创建和管理计划以安排活动、识别冲突并优化工作范围。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":100,"lifecycle":"use","article-type":"article","href":"/zh/cdf/maintain/guides/set_work_scope"},{"title":"将活动导入到 Maintain","sidebarTitle":"将活动导入到 Maintain","description":"学习如何使用用户界面(APM模式)、Cognite Toolkit 或转换导入活动。","content-type":"procedure","audience":"businessUser","to-L10N":true,"experience-level":200,"lifecycle":"use","article-type":"article","href":"/zh/cdf/maintain/guides/import_activities"}]},{"group":"外部资源","pages":[{"title":"Industrial Data Science Library","url":"https://indsl.docs.cognite.com/","description":null,"href":"/cdf/indsl"}]}]}]}]},"basePath":"","title":"Search - Cognite Docs","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["10e4515597"],"chunks":["BannerMarkdown-Cj6eAYhz.js","dist-CdrJecqK.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-D-TRO5q5.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js"]}