Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Cognite Docs","description":"Cognite Data Fusion (CDF) documentation for developers, data engineers, and administrators.","colors":{"primary":"#3C5FFB","light":"#4D8AFF","dark":"#3C5FFB"},"logo":{"light":"https://mintcdn.com/cognite/dkctM57aym6D8Toa/_images/logo/cognite-docs-black.svg?fit=max\u0026auto=format\u0026n=dkctM57aym6D8Toa\u0026q=85\u0026s=38c50e5be94d9baf1ff1c794ae17d6ea","dark":"https://mintcdn.com/cognite/dkctM57aym6D8Toa/_images/logo/cognite-docs-white.svg?fit=max\u0026auto=format\u0026n=dkctM57aym6D8Toa\u0026q=85\u0026s=06ff6278a32e16b65bc691b91f7bfe6d"},"favicon":"https://mintcdn.com/cognite/dkctM57aym6D8Toa/_images/CogniteIcon.svg?fit=max\u0026auto=format\u0026n=dkctM57aym6D8Toa\u0026q=85\u0026s=eaf7720816d261929421c888d58b8914","footer":{"socials":{"website":"https://www.cognite.com","linkedin":"https://www.linkedin.com/company/cognitedata","youtube":"https://www.youtube.com/c/cognite"},"links":[{"header":"Resources","items":[{"label":"Academy","href":"https://academy.cognite.com"},{"label":"Community","href":"https://hub.cognite.com"},{"label":"Support","href":"https://cognite.zendesk.com/hc/en-us"},{"label":"Trust Center","href":"https://trust.cognite.com/"},{"label":"CogDocs","href":"/cogdocs/concepts/platform-overview"}]},{"header":"Company","items":[{"label":"About us","href":"https://www.cognite.com/company/about-us-cognite"},{"label":"Careers","href":"https://www.cognite.com/company/careers"},{"label":"Blog","href":"https://www.cognite.com/resources/blog"}]},{"header":"Status","items":[{"label":"Cognite services","href":"https://status.cognite.com"}]}]},"search":{"prompt":"Search documentation"},"seo":{"metatags":{"canonical":"https://docs.cognite.com","google-site-verification":"kX2vFxX0NcdV88MV5ooALR09TbeSd8xDN-rVd6fiTG4"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"languages":{"custom":["/_languages/kuiper.json"]}},"latex":true},"banner":{"content":"New: build custom CDF applications with Cognite Flows. [Documentation](/cdf/flows) · [What's new](/cdf/whatsnew).","dismissible":true},"contextual":{"options":["mcp","copy","chatgpt","claude","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"metadata":{"timestamp":true},"markdown":{"instructions":["Cognite Data Fusion (CDF) is an industrial DataOps platform. Prefer English docs unless the user asks for another locale.","Follow /_llms/ index links recursively until you reach page URLs ending in .md. Fetch those Markdown twins instead of HTML.","For REST APIs, default to calendar version 20230101 (stable). Use 20230101-beta or 20230101-alpha only if the user is on a preview API. Cite paths under /api-reference/concepts/\u003cversion>/ and the Cdf-Version header. Prefer the Python SDK (cognite-sdk) unless the user is in JavaScript/TypeScript.","Start here by task: platform overview /cdf/index.md; data modeling /cdf/dm/index.md; data integration /cdf/integration/index.md; access /cdf/access/index.md; CDF Toolkit /cdf/deploy/cdf_toolkit/index.md; REST quickstart /dev/quickstart.md; Python SDK https://cognite-sdk-python.readthedocs-hosted.com/en/stable/; Atlas AI /cdf/atlas_ai/concepts/index.md; Flows apps /cdf/flows/index.md; MCP and IDE setup /dev/guides/ide_ai_integration.md.","For implementation work, also load /skill.md."]},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"de","href":"de"},{"language":"es","href":"es"},{"language":"fr","href":"fr"},{"language":"ko","href":"ko"},{"language":"it","href":"it"},{"language":"lv","href":"lv"},{"language":"nl","href":"nl"},{"language":"ja","href":"ja"},{"language":"no","href":"no"},{"language":"pt","href":"pt"},{"language":"ro","href":"ro"},{"language":"sv","href":"sv"},{"language":"zh","href":"zh"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cognite","hasAudioNarration":false,"actualSubdomain":"cognite","customDomains":["docs.cognite.com"],"gitSource":{"type":"github","owner":"cognitedata","repo":"docs.cognite.com","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true,"contextualFeedback":{"allowEmail":true}},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af312d02e595ebec461cc3b","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"en","tag":"API reference","count":1600},{"language":"en","tag":"Alpha (20230101-alpha)","count":557},{"language":"en","tag":"API reference (20230101-alpha)","count":557},{"language":"en","tag":"Beta (20230101-beta)","count":521},{"language":"en","tag":"API reference (20230101-beta)","count":521},{"language":"en","tag":"Stable (20230101)","count":515},{"language":"en","tag":"API reference (20230101)","count":515},{"language":"en","tag":"Data engineering","count":452},{"language":"en","tag":"Core data","count":314},{"language":"en","tag":"Build","count":294},{"language":"de","tag":"Flows","count":25},{"language":"es","tag":"Flows","count":25},{"language":"fr","tag":"Flows","count":25},{"language":"it","tag":"Flows","count":25},{"language":"ja","tag":"Flows","count":25},{"language":"ko","tag":"Flows","count":25},{"language":"lv","tag":"Flows","count":25},{"language":"nl","tag":"Flows","count":25},{"language":"no","tag":"Flows","count":25},{"language":"pt","tag":"Flows","count":25},{"language":"ro","tag":"Flows","count":25},{"language":"sv","tag":"Flows","count":25},{"language":"zh","tag":"Flows","count":25},{"language":"de","tag":"InField","count":6},{"language":"es","tag":"InField","count":6},{"language":"fr","tag":"InField","count":6},{"language":"it","tag":"InField","count":6},{"language":"ja","tag":"InField","count":6},{"language":"ko","tag":"InField","count":6},{"language":"lv","tag":"InField","count":6},{"language":"nl","tag":"InField","count":6},{"language":"no","tag":"InField","count":6},{"language":"pt","tag":"InField","count":6},{"language":"ro","tag":"InField","count":6},{"language":"sv","tag":"InField","count":6},{"language":"zh","tag":"InField","count":6},{"language":"de","tag":"Willkommen","count":5},{"language":"es","tag":"Bienvenidos","count":5},{"language":"fr","tag":"Bienvenue","count":5},{"language":"it","tag":"Benvenuto","count":5},{"language":"ja","tag":"ようこそ","count":5},{"language":"ko","tag":"환영합니다","count":5},{"language":"lv","tag":"Laipni lūdzam","count":5},{"language":"nl","tag":"Welkom","count":5},{"language":"no","tag":"Velkommen","count":5},{"language":"pt","tag":"Boas-vindas","count":5},{"language":"ro","tag":"Bine ați venit","count":5},{"language":"sv","tag":"Välkommen","count":5},{"language":"zh","tag":"欢迎","count":5},{"language":"de","tag":"Erste Schritte","count":3},{"language":"de","tag":"Maintain","count":3},{"language":"es","tag":"Comenzando","count":3},{"language":"es","tag":"Maintain","count":3},{"language":"fr","tag":"Commencer","count":3},{"language":"fr","tag":"Maintain","count":3},{"language":"it","tag":"Iniziare","count":3},{"language":"it","tag":"Maintain","count":3},{"language":"ja","tag":"始める","count":3},{"language":"ja","tag":"Maintain","count":3},{"language":"ko","tag":"시작하기","count":3},{"language":"ko","tag":"Maintain","count":3},{"language":"lv","tag":"Sākt","count":3},{"language":"lv","tag":"Maintain","count":3},{"language":"nl","tag":"Aan de slag","count":3},{"language":"nl","tag":"Maintain","count":3},{"language":"no","tag":"Kom i gang","count":3},{"language":"no","tag":"Maintain","count":3},{"language":"pt","tag":"Introdução","count":3},{"language":"pt","tag":"Maintain","count":3},{"language":"ro","tag":"Începere","count":3},{"language":"ro","tag":"Maintain","count":3},{"language":"sv","tag":"Komma igång","count":3},{"language":"sv","tag":"Maintain","count":3},{"language":"zh","tag":"开始使用","count":3},{"language":"zh","tag":"Maintain","count":3},{"language":"default","tag":"Build","count":2},{"language":"default","tag":"Industrial Data Science Library","count":1}],"searchSettings":{"fullPageSearch":true}},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":true,"enableAskAiSearchBar":false,"deflection":{"enabled":true,"email":"support@cognite.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"use-workflow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6967906434f9dd976594538d","deploymentId":"68e65d91d34a0d869e1b696c","questionText":"How do I query industrial data?","status":"active","generatedBy":"manual","createdAt":"2026-01-14T12:47:32.944Z","updatedAt":"2026-01-14T12:47:32.944Z","__v":0},{"_id":"6967906134f9dd9765945358","deploymentId":"68e65d91d34a0d869e1b696c","questionText":"What is data modeling in CDF?","status":"active","generatedBy":"manual","createdAt":"2026-01-14T12:47:29.227Z","updatedAt":"2026-01-14T12:47:29.227Z","__v":0},{"_id":"6967905d34f9dd9765945312","deploymentId":"68e65d91d34a0d869e1b696c","questionText":"How do I set up the Cognite Toolkit?","status":"active","generatedBy":"manual","createdAt":"2026-01-14T12:47:25.018Z","updatedAt":"2026-01-14T12:47:25.018Z","__v":0}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"_css/cognite.css","content":".ui-element{font-weight:bold!important}del{text-decoration:none!important}em>strong{font-style:normal!important}em,strong{font-weight:500!important}h5{font-weight:600!important}:root{--cog-table-row-odd-bg: #ffffff;--cog-table-row-even-bg: #f6f8fa}html.dark,[data-theme=\"dark\"]{--cog-table-row-odd-bg: rgba(255, 255, 255, 0.02);--cog-table-row-even-bg: rgba(255, 255, 255, 0.06)}@media (prefers-color-scheme: dark){:root:not(.light):not([data-theme=\"light\"]){--cog-table-row-odd-bg: rgba(255, 255, 255, 0.02);--cog-table-row-even-bg: rgba(255, 255, 255, 0.06)}}table th{text-align:left}.prose table th,.prose table td,.prose table th:first-child,.prose table td:first-child,.prose table th:last-child,.prose table td:last-child{padding-inline-start:0.75rem;padding-inline-end:0.75rem;padding-top:0.5rem;padding-bottom:0.5rem}table tr:nth-child(even){background-color:var(--cog-table-row-even-bg)}table tr:nth-child(odd){background-color:var(--cog-table-row-odd-bg)}.nav-logo{height:36px}.relative.w-4.h-4.rounded-full img{display:none}#localization-select-trigger img.w-full.h-full.rounded-full,#localization-select-trigger .absolute.top-0.left-0{display:none}.absolute.top-0.left-0.w-full.h-full.border.rounded-full{display:none}.back-to-top-container{position:fixed;bottom:80px;right:30px;z-index:50;display:none;transition:right 0.3s ease}@media (max-width: 1280px){.back-to-top-container{bottom:100px;right:20px}}.back-to-top-button{background-color:rgba(60, 95, 251, 0.1);color:#3C5FFB;width:40px;height:40px;border-radius:50%;display:flex;align-items:center;justify-content:center;text-decoration:none;box-shadow:0 4px 6px rgba(0,0,0,0.05);border:1px solid rgba(60, 95, 251, 0.1);cursor:pointer;transition:all 0.2s ease}.back-to-top-button:hover{background-color:rgba(60, 95, 251, 0.2)}html.dark .back-to-top-button,[data-theme=\"dark\"] .back-to-top-button{background-color:rgba(60, 95, 251, 0.25);color:#81a1ff;border-color:rgba(60, 95, 251, 0.4);box-shadow:0 4px 12px rgba(0,0,0,0.3)}html.dark .back-to-top-button:hover,[data-theme=\"dark\"] .back-to-top-button:hover{background-color:rgba(60, 95, 251, 0.35);color:#ffffff}@media (prefers-color-scheme: dark){:root:not(.light):not([data-theme=\"light\"]) .back-to-top-button{background-color:rgba(60, 95, 251, 0.25);color:#81a1ff;border-color:rgba(60, 95, 251, 0.4);box-shadow:0 4px 12px rgba(0,0,0,0.3)}:root:not(.light):not([data-theme=\"light\"]) .back-to-top-button:hover{background-color:rgba(60, 95, 251, 0.35);color:#ffffff}}div[class*=\"code\"] button [role=\"tooltip\"],div[class*=\"Code\"] button [role=\"tooltip\"],pre button [role=\"tooltip\"],button[aria-label*=\"Copy\"] [role=\"tooltip\"],button[aria-label*=\"copy\"] [role=\"tooltip\"],button[aria-label*=\"Ask\"] [role=\"tooltip\"],button[aria-label*=\"Report\"] [role=\"tooltip\"],.group\\/copy-button [role=\"tooltip\"],button.group\\/copy-button [role=\"tooltip\"],[class*=\"copy-button\"] [role=\"tooltip\"]{top:auto!important;bottom:100%!important;margin-bottom:8px!important;transform:translateX(-50%)!important}.code-block:has(.code-block-wrap) [data-floating-buttons=\"true\"]{opacity:1!important}html{scroll-padding-top:120px}@media (max-width: 768px){html{scroll-padding-top:100px}}"},{"filePath":"_styles/aura-primitive-content.css","content":"html[data-current-path^=\"/cdf/aura/primitives/\"] #header .mt-2.text-lg.prose,#content[data-page-href*=\"/cdf/aura/primitives/\"]:not([data-page-href$=\"/index\"]) #header .mt-2.text-lg.prose{max-width:700px}html[data-current-path^=\"/cdf/aura/primitives/\"] #content>:is(h2,h3,h4,h5,h6,p,span[data-as=\"p\"],ul,ol,blockquote,pre,hr),#content[data-page-href*=\"/cdf/aura/primitives/\"]:not([data-page-href$=\"/index\"])>:is(h2,h3,h4,h5,h6,p,span[data-as=\"p\"],ul,ol,blockquote,pre,hr){max-width:700px}"}],"page":{"pagePath":"20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines","slug":"/20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines","pageMetadata":{"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},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n blockquote: \"blockquote\",\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.blockquote, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Required capabilities:\"\n }), \" \", _jsx(_components.code, {\n children: \"entitymatchingAcl:READ\"\n }), \" \", _jsx(_components.code, {\n children: \"assetsAcl:READ\"\n })]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Retrieve multiple entity matching pipelines.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"languages":{"custom":["/_languages/kuiper.json"]}},"config":{},"pageMetadata":{"title":"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}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/cognite/cb9533f9ff163898/_scripts/back-to-top.js","/_mintlify/custom/cognite/77f6ac33743a5817/_scripts/sidebar-api-20230101-collapse.js","/_mintlify/custom/cognite/237ae201703aad29/_scripts/storybook-theme-sync.js"],"openApiReferenceData":{"operation":{"tags":["Entity matching pipelines"],"operationId":"entityMatchingPipelineMultiGet","summary":"Retrieve multiple pipelines","description":"\n\n> **Required capabilities:** `entitymatchingAcl:READ` `assetsAcl:READ`\n\nRetrieve multiple entity matching pipelines.","requestBody":"f5f9a54b-6bd3-40b9-bbc7-1b4bdd5c44d1","responses":{"200":"b8d174b0-e765-4424-8c4f-8d7fbb08b82c","400":"5f58a307-f5b7-4dd2-bcb5-d68f1390c51d"},"x-capability":["entitymatchingAcl:READ","assetsAcl:READ"],"method":"post","type":"path","servers":["2150d75b-88d8-4770-8187-171b713d9f99"],"security":["7a5db33e-7d67-4991-8ba9-297b63b3c513","04cf0117-c451-4de7-8791-4c79afede537","6c68a850-cb39-4a69-8e55-b49528f8c2e3","d738c8ed-8e7a-453a-9b0f-1c7e70c37062"],"path":"/context/entitymatching/pipelines/byids","baseUrlOptions":["https://{cluster}.cognitedata.com/api/v1/projects/{project}"],"title":"Retrieve multiple pipelines","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Pipeline identifiers","minItems":1,"maxItems":100,"items":{"oneOf":[{"type":"object","description":"Either an internal ID, or an external ID.","required":["id"],"properties":{"id":{"description":"A server-generated ID for the object.","type":"integer","minimum":1,"maximum":9007199254740991,"format":"int64","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint64>"}},"uniqueKey":"\\items.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"Either an internal ID, or an external ID.","required":["externalId"],"example":{"externalId":"my.known.id"},"properties":{"externalId":{"description":"The external ID provided by the client. Must be unique for the resource type.","type":"string","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.externalId","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"items":[{"id":4503599627370496}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b8d174b0-e765-4424-8c4f-8d7fbb08b82c":{"description":"List of pipelines","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","description":"Pipeline to create","required":["sources","targets","id","createdTime"],"properties":{"id":{"description":"A server-generated ID for the object.","type":"integer","minimum":1,"maximum":9007199254740991,"format":"int64","isRequired":true,"uniqueKey":"\\items.items.[INDEX].id","typeLabel":"integer\u003cint64>"},"createdTime":{"description":"The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.","type":"integer","minimum":0,"format":"int64","example":1730204346000,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].createdTime","typeLabel":"integer\u003cint64>"},"sources":{"oneOf":[{"type":"object","description":"Source of the pipeline","properties":{"dataSetIds":{"type":"array","description":"List of data set internal or external IDs.","items":{"oneOf":[{"type":"object","description":"Either an internal ID, or an external ID.","required":["id"],"properties":{"id":{"description":"A server-generated ID for the object.","type":"integer","minimum":1,"maximum":9007199254740991,"format":"int64","isRequired":true,"uniqueKey":"\\items.items.[INDEX].sources.oneOf.0.dataSetIds.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint64>"}},"uniqueKey":"\\items.items.[INDEX].sources.oneOf.0.dataSetIds.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"Either an internal ID, or an external ID.","required":["externalId"],"example":{"externalId":"my.known.id"},"properties":{"externalId":{"description":"The external ID provided by the client. Must be unique for the resource type.","type":"string","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].sources.oneOf.0.dataSetIds.items.[INDEX].oneOf.1.externalId","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].sources.oneOf.0.dataSetIds.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"\\items.items.[INDEX].sources.oneOf.0.dataSetIds.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].sources.oneOf.0.dataSetIds","typeLabel":"object[]"},"resource":{"type":"string","description":"CDF resource type.","default":"time_series","enum":["assets","time_series","events","files","sequences"],"example":"assets","uniqueKey":"\\items.items.[INDEX].sources.oneOf.0.resource","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].sources.oneOf.0","typeLabel":"object"},{"type":"object","description":"Source of the pipeline","properties":{"assetSubtreeIds":{"type":"array","description":"List of asset subtree internal or external IDs.","items":{"oneOf":[{"type":"object","description":"Either an internal ID, or an external ID.","required":["id"],"properties":{"id":{"description":"A server-generated ID for the object.","type":"integer","minimum":1,"maximum":9007199254740991,"format":"int64","isRequired":true,"uniqueKey":"\\items.items.[INDEX].sources.oneOf.1.assetSubtreeIds.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint64>"}},"uniqueKey":"\\items.items.[INDEX].sources.oneOf.1.assetSubtreeIds.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"Either an internal ID, or an external ID.","required":["externalId"],"example":{"externalId":"my.known.id"},"properties":{"externalId":{"description":"The external ID provided by the client. Must be unique for the resource type.","type":"string","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].sources.oneOf.1.assetSubtreeIds.items.[INDEX].oneOf.1.externalId","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].sources.oneOf.1.assetSubtreeIds.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"\\items.items.[INDEX].sources.oneOf.1.assetSubtreeIds.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].sources.oneOf.1.assetSubtreeIds","typeLabel":"object[]"},"resource":{"type":"string","description":"CDF resource type.","default":"time_series","enum":["assets","time_series","events","files","sequences"],"example":"assets","uniqueKey":"\\items.items.[INDEX].sources.oneOf.1.resource","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].sources.oneOf.1","typeLabel":"object"},{"type":"object","description":"Source of the pipeline","properties":{"entities":{"type":"array","items":{"type":"object","example":{"id":10,"name":"a_name","field":"value","ignoredfield":{"key":"value"}},"uniqueKey":"\\items.items.[INDEX].sources.oneOf.2.entities.items.[INDEX]","typeLabel":"object"},"description":"List of custom source object to match from, for example, time series. String key -> value. Optional id and/or externalId fields.","uniqueKey":"\\items.items.[INDEX].sources.oneOf.2.entities","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].sources.oneOf.2","typeLabel":"object"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].sources","typeLabel":"object"},"targets":{"oneOf":[{"type":"object","description":"Target a dataset","properties":{"dataSetIds":{"type":"array","description":"List of id or externalId for datasets to use.","items":{"oneOf":[{"type":"object","description":"Either an internal ID, or an external ID.","required":["id"],"properties":{"id":{"description":"A server-generated ID for the object.","type":"integer","minimum":1,"maximum":9007199254740991,"format":"int64","isRequired":true,"uniqueKey":"\\items.items.[INDEX].targets.oneOf.0.dataSetIds.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint64>"}},"uniqueKey":"\\items.items.[INDEX].targets.oneOf.0.dataSetIds.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"Either an internal ID, or an external ID.","required":["externalId"],"example":{"externalId":"my.known.id"},"properties":{"externalId":{"description":"The external ID provided by the client. Must be unique for the resource type.","type":"string","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].targets.oneOf.0.dataSetIds.items.[INDEX].oneOf.1.externalId","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].targets.oneOf.0.dataSetIds.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"\\items.items.[INDEX].targets.oneOf.0.dataSetIds.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].targets.oneOf.0.dataSetIds","typeLabel":"object[]"},"resource":{"type":"string","description":"CDF resource type.","default":"assets","enum":["assets","time_series","events","files","sequences"],"example":"assets","uniqueKey":"\\items.items.[INDEX].targets.oneOf.0.resource","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].targets.oneOf.0","typeLabel":"object"},{"type":"object","description":"Target asset subtrees","properties":{"assetSubtreeIds":{"type":"array","description":"List of id or externalId for asset subtrees to use.","items":{"oneOf":[{"type":"object","description":"Either an internal ID, or an external ID.","required":["id"],"properties":{"id":{"description":"A server-generated ID for the object.","type":"integer","minimum":1,"maximum":9007199254740991,"format":"int64","isRequired":true,"uniqueKey":"\\items.items.[INDEX].targets.oneOf.1.assetSubtreeIds.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint64>"}},"uniqueKey":"\\items.items.[INDEX].targets.oneOf.1.assetSubtreeIds.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"Either an internal ID, or an external ID.","required":["externalId"],"example":{"externalId":"my.known.id"},"properties":{"externalId":{"description":"The external ID provided by the client. Must be unique for the resource type.","type":"string","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].targets.oneOf.1.assetSubtreeIds.items.[INDEX].oneOf.1.externalId","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].targets.oneOf.1.assetSubtreeIds.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"\\items.items.[INDEX].targets.oneOf.1.assetSubtreeIds.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].targets.oneOf.1.assetSubtreeIds","typeLabel":"object[]"},"resource":{"type":"string","description":"CDF resource type.","default":"assets","enum":["assets","time_series","events","files","sequences"],"example":"assets","uniqueKey":"\\items.items.[INDEX].targets.oneOf.1.resource","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].targets.oneOf.1","typeLabel":"object"},{"type":"object","description":"Custom target","properties":{"entities":{"type":"array","items":{"type":"object","example":{"id":10,"name":"a_name","field":"value","ignoredfield":{"key":"value"}},"uniqueKey":"\\items.items.[INDEX].targets.oneOf.2.entities.items.[INDEX]","typeLabel":"object"},"description":"List of custom target object to match to, for example, assets. String key -> value. Optional id and/or externalId fields.","uniqueKey":"\\items.items.[INDEX].targets.oneOf.2.entities","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].targets.oneOf.2","typeLabel":"object"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].targets","typeLabel":"object"},"lastUpdatedTime":{"description":"The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.","type":"integer","minimum":0,"format":"int64","example":1730204346000,"uniqueKey":"\\items.items.[INDEX].lastUpdatedTime","typeLabel":"integer\u003cint64>"},"owner":{"type":"string","description":"Owner of the pipeline. This is only provided in case the pipeline was created in the Fusion front-end.","example":"alice@example.com","uniqueKey":"\\items.items.[INDEX].owner","typeLabel":"string"},"externalId":{"description":"The external ID provided by the client. Must be unique for the resource type.","type":"string","maxLength":255,"example":"my.known.id","uniqueKey":"\\items.items.[INDEX].externalId","typeLabel":"string"},"name":{"type":"string","description":"User-defined name of the pipeline.","example":"myPipeline","maxLength":256,"uniqueKey":"\\items.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","description":"User-defined description of the pipeline.","example":"My pipeline","maxLength":500,"uniqueKey":"\\items.items.[INDEX].description","typeLabel":"string"},"modelParameters":{"type":"object","example":{"featureType":"bigram"},"description":"The parameters to use in the entity matching model.","properties":{"externalId":{"description":"The external ID provided by the client. Must be unique for the resource type.","type":"string","maxLength":255,"example":"my.known.id","uniqueKey":"\\items.items.[INDEX].modelParameters.externalId","typeLabel":"string"},"name":{"oneOf":[{"type":"string","maxLength":256,"uniqueKey":"\\items.items.[INDEX].modelParameters.name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":256,"uniqueKey":"\\items.items.[INDEX].modelParameters.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].modelParameters.name","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","maxLength":512,"uniqueKey":"\\items.items.[INDEX].modelParameters.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":512,"uniqueKey":"\\items.items.[INDEX].modelParameters.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].modelParameters.description","typeLabel":"string | null"},"featureType":{"type":"string","example":"simple","enum":["simple","insensitive","bigram","frequencyweightedbigram","bigramextratokenizers","bigramcombo"],"default":"simple","description":"Each feature type defines the combination of features that will be created and used in the entity matcher model.","uniqueKey":"\\items.items.[INDEX].modelParameters.featureType","typeLabel":"enum\u003cstring>"},"classifier":{"type":"string","description":"The classifier used in the model. Only relevant if there are trueMatches/labeled data and a supervised model is fitted.","example":"randomforest","default":"randomforest","enum":["randomforest","decisiontree","logisticregression","augmentedlogisticregression","augmentedrandomforest"],"uniqueKey":"\\items.items.[INDEX].modelParameters.classifier","typeLabel":"enum\u003cstring>"},"matchFields":{"type":"array","example":[{"source":"name","target":"name"},{"source":"name","target":"someField"}],"default":[{"source":"name","target":"name"}],"description":"List of pairs of fields from the target and source items, used to calculate features. All source and target items should have all the `source` and `target` fields specified here.","items":{"type":"object","required":["source","target"],"properties":{"source":{"type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].modelParameters.matchFields.items.[INDEX].source","typeLabel":"string"},"target":{"type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].modelParameters.matchFields.items.[INDEX].target","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].modelParameters.matchFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].modelParameters.matchFields","typeLabel":"object[]"}},"uniqueKey":"\\items.items.[INDEX].modelParameters","typeLabel":"object"},"trueMatches":{"type":"array","description":"A list of confirmed source/target matches, which will be used to train the model. If omitted, an unsupervised\nmodel is trained.","minItems":1,"maxItems":2000000,"items":{"oneOf":[{"type":"object","description":"A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces.\nInternal and external IDs are supported.","required":["sourceId","targetId"],"example":{"sourceId":23},"properties":{"sourceId":{"type":"integer","description":"The id for the from-object of the match.","format":"int64","maximum":9007199254740991,"minimum":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].trueMatches.items.[INDEX].oneOf.0.sourceId","typeLabel":"integer\u003cint64>"},"targetId":{"type":"integer","description":"The id for the target-object of the match.","format":"int64","maximum":9007199254740991,"minimum":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].trueMatches.items.[INDEX].oneOf.0.targetId","typeLabel":"integer\u003cint64>"}},"uniqueKey":"\\items.items.[INDEX].trueMatches.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces.\nInternal and external IDs are supported.","required":["sourceId","targetExternalId"],"example":{"sourceId":23,"targetExternalId":"my.known.id"},"properties":{"sourceId":{"type":"integer","description":"The id for the from-object of the match.","format":"int64","maximum":9007199254740991,"minimum":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].trueMatches.items.[INDEX].oneOf.1.sourceId","typeLabel":"integer\u003cint64>"},"targetExternalId":{"type":"string","description":"The external id for the to-object of the match.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].trueMatches.items.[INDEX].oneOf.1.targetExternalId","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].trueMatches.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces.\nInternal and external IDs are supported.","required":["sourceExternalId","targetId"],"properties":{"sourceExternalId":{"type":"string","description":"The external id for the source-object of the match.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].trueMatches.items.[INDEX].oneOf.2.sourceExternalId","typeLabel":"string"},"targetId":{"type":"integer","description":"The id for the target-object of the match.","format":"int64","maximum":9007199254740991,"minimum":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].trueMatches.items.[INDEX].oneOf.2.targetId","typeLabel":"integer\u003cint64>"}},"uniqueKey":"\\items.items.[INDEX].trueMatches.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces.\nInternal and external IDs are supported.","required":["sourceExternalId","targetExternalId"],"example":{"targetExternalId":"my.known.id"},"properties":{"sourceExternalId":{"type":"string","description":"The external id for the source-object of the match.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].trueMatches.items.[INDEX].oneOf.3.sourceExternalId","typeLabel":"string"},"targetExternalId":{"type":"string","description":"The external id for the to-object of the match.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].trueMatches.items.[INDEX].oneOf.3.targetExternalId","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].trueMatches.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"\\items.items.[INDEX].trueMatches.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].trueMatches","typeLabel":"object[]"},"confirmedMatches":{"type":"array","description":"List of objects of pairs of sourceId or sourceExternalId and targetId or targetExternalId, that corresponds to entities in source and target respectively, that indicates a confirmed match by the user. A source and target pair in this list will override results from a model or rules and will therefore always be returned as a match. The matches are also used as training data when the entity matcher model is created.","items":{"oneOf":[{"type":"object","description":"A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces.\nInternal and external IDs are supported.","required":["sourceId","targetId"],"example":{"sourceId":23},"properties":{"sourceId":{"type":"integer","description":"The id for the from-object of the match.","format":"int64","maximum":9007199254740991,"minimum":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].confirmedMatches.items.[INDEX].oneOf.0.sourceId","typeLabel":"integer\u003cint64>"},"targetId":{"type":"integer","description":"The id for the target-object of the match.","format":"int64","maximum":9007199254740991,"minimum":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].confirmedMatches.items.[INDEX].oneOf.0.targetId","typeLabel":"integer\u003cint64>"}},"uniqueKey":"\\items.items.[INDEX].confirmedMatches.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces.\nInternal and external IDs are supported.","required":["sourceId","targetExternalId"],"example":{"sourceId":23,"targetExternalId":"my.known.id"},"properties":{"sourceId":{"type":"integer","description":"The id for the from-object of the match.","format":"int64","maximum":9007199254740991,"minimum":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].confirmedMatches.items.[INDEX].oneOf.1.sourceId","typeLabel":"integer\u003cint64>"},"targetExternalId":{"type":"string","description":"The external id for the to-object of the match.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].confirmedMatches.items.[INDEX].oneOf.1.targetExternalId","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].confirmedMatches.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces.\nInternal and external IDs are supported.","required":["sourceExternalId","targetId"],"properties":{"sourceExternalId":{"type":"string","description":"The external id for the source-object of the match.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].confirmedMatches.items.[INDEX].oneOf.2.sourceExternalId","typeLabel":"string"},"targetId":{"type":"integer","description":"The id for the target-object of the match.","format":"int64","maximum":9007199254740991,"minimum":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].confirmedMatches.items.[INDEX].oneOf.2.targetId","typeLabel":"integer\u003cint64>"}},"uniqueKey":"\\items.items.[INDEX].confirmedMatches.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces.\nInternal and external IDs are supported.","required":["sourceExternalId","targetExternalId"],"example":{"targetExternalId":"my.known.id"},"properties":{"sourceExternalId":{"type":"string","description":"The external id for the source-object of the match.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].confirmedMatches.items.[INDEX].oneOf.3.sourceExternalId","typeLabel":"string"},"targetExternalId":{"type":"string","description":"The external id for the to-object of the match.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].confirmedMatches.items.[INDEX].oneOf.3.targetExternalId","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].confirmedMatches.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"\\items.items.[INDEX].confirmedMatches.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].confirmedMatches","typeLabel":"object[]"},"rejectedMatches":{"type":"array","description":"List of objects of pairs of sourceId or sourceExternalId and targetId or targetExternalId, that corresponds to entities in source and target respectively, that indicates a match rejected by the user. A source and target pair in this list will override results from a model or rules and will never be returned as a match.","items":{"oneOf":[{"type":"object","description":"A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces.\nInternal and external IDs are supported.","required":["sourceId","targetId"],"example":{"sourceId":23},"properties":{"sourceId":{"type":"integer","description":"The id for the from-object of the match.","format":"int64","maximum":9007199254740991,"minimum":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedMatches.items.[INDEX].oneOf.0.sourceId","typeLabel":"integer\u003cint64>"},"targetId":{"type":"integer","description":"The id for the target-object of the match.","format":"int64","maximum":9007199254740991,"minimum":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedMatches.items.[INDEX].oneOf.0.targetId","typeLabel":"integer\u003cint64>"}},"uniqueKey":"\\items.items.[INDEX].rejectedMatches.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces.\nInternal and external IDs are supported.","required":["sourceId","targetExternalId"],"example":{"sourceId":23,"targetExternalId":"my.known.id"},"properties":{"sourceId":{"type":"integer","description":"The id for the from-object of the match.","format":"int64","maximum":9007199254740991,"minimum":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedMatches.items.[INDEX].oneOf.1.sourceId","typeLabel":"integer\u003cint64>"},"targetExternalId":{"type":"string","description":"The external id for the to-object of the match.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedMatches.items.[INDEX].oneOf.1.targetExternalId","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].rejectedMatches.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces.\nInternal and external IDs are supported.","required":["sourceExternalId","targetId"],"properties":{"sourceExternalId":{"type":"string","description":"The external id for the source-object of the match.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedMatches.items.[INDEX].oneOf.2.sourceExternalId","typeLabel":"string"},"targetId":{"type":"integer","description":"The id for the target-object of the match.","format":"int64","maximum":9007199254740991,"minimum":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedMatches.items.[INDEX].oneOf.2.targetId","typeLabel":"integer\u003cint64>"}},"uniqueKey":"\\items.items.[INDEX].rejectedMatches.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"A pair of source ID and target ID, that indicates a match between two entities in the source and target spaces.\nInternal and external IDs are supported.","required":["sourceExternalId","targetExternalId"],"example":{"targetExternalId":"my.known.id"},"properties":{"sourceExternalId":{"type":"string","description":"The external id for the source-object of the match.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedMatches.items.[INDEX].oneOf.3.sourceExternalId","typeLabel":"string"},"targetExternalId":{"type":"string","description":"The external id for the to-object of the match.","maxLength":255,"example":"my.known.id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedMatches.items.[INDEX].oneOf.3.targetExternalId","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].rejectedMatches.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"\\items.items.[INDEX].rejectedMatches.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].rejectedMatches","typeLabel":"object[]"},"useExistingMatches":{"oneOf":[{"type":"boolean","default":false,"description":"Use existing (id/assetId) links on the CDF resources as training data when the entity matching model is created.","uniqueKey":"\\items.items.[INDEX].useExistingMatches.oneOf.0","typeLabel":"boolean"},{"type":"null","default":false,"description":"Use existing (id/assetId) links on the CDF resources as training data when the entity matching model is created.","uniqueKey":"\\items.items.[INDEX].useExistingMatches.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].useExistingMatches","typeLabel":"boolean | null"},"generateRules":{"oneOf":[{"type":"boolean","default":true,"description":"Whether to generate match rules automatically","uniqueKey":"\\items.items.[INDEX].generateRules.oneOf.0","typeLabel":"boolean"},{"type":"null","default":true,"description":"Whether to generate match rules automatically","uniqueKey":"\\items.items.[INDEX].generateRules.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].generateRules","typeLabel":"boolean | null"},"replacements":{"type":"array","description":"Replace strings in entity fields. You can use this field to add input naming variations to the entity matching\nmodel to improve the suggested matches, for example, 'pmp' for 'pump' and 'bhp' for 'bottom hole pressure'.\nTo avoid false positives, we recommend using the longer string as `string` and the shorter as `replacement`.","items":{"type":"object","required":["field","string","replacement"],"properties":{"field":{"type":"string","description":"Which field to replace in. Can be '*' to affect all fields in both source and targets.","example":"*","isRequired":true,"uniqueKey":"\\items.items.[INDEX].replacements.items.[INDEX].field","typeLabel":"string"},"string":{"type":"string","description":"String to search for and replace in both sources and targets.","example":"Bottom-hole pressure","isRequired":true,"uniqueKey":"\\items.items.[INDEX].replacements.items.[INDEX].string","typeLabel":"string"},"replacement":{"type":"string","description":"Replacement for the string.","example":"bhp","isRequired":true,"uniqueKey":"\\items.items.[INDEX].replacements.items.[INDEX].replacement","typeLabel":"string"}},"minItems":1,"maxItems":1000,"uniqueKey":"\\items.items.[INDEX].replacements.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].replacements","typeLabel":"object[]"},"rules":{"type":"array","description":"A collection of match rules","minItems":0,"maxItems":1000,"default":[],"items":{"type":"object","description":"An entity matching rule matches source entities with target entities based on a pattern defined by the rule.\nA rule has extractors that both require entities to follow a certain format, and produce lists of features.\n\nFor a regex extractor, a specific field must match a pattern, and parts of the pattern become the features.\nThe conditions of a rule express which extracted features must be equal for two entities to match.\n\nSince extractors restrict the scopes of rules to entities that conform with patterns, two rules will often not\nhave entities in common that they apply to. But if they do, the more specific rule is given higher priority.\n\nIf one rule is not a special case of the other, they may be inconsistent (conflict) or redundant (overlap).","required":["extractors","conditions"],"properties":{"extractors":{"type":"array","description":"An extractor produces a list of features based on a source entity or a target entity. In particular a regex extractor defines which entities (e.g. sources) it acts on, a field (e.g. name) and a regular expression. The extractor will only produce features if the field of an entity matches the pattern. The returned features are then substrings of the field as defined in the pattern. Entities in the relevant set that do not match the pattern will not be matched by the rule, but may be matched by other rules.","items":{"type":"object","required":["entitySet","extractorType","field","pattern"],"description":"An extractor that acts on entities from 'entitySet'. An entity must have a value of 'field' that matches the regular expression 'pattern' to get features. The features are the catching groups of the pattern, that is the parts that are in parenthesis. E.g. ([A-Z])-00([0-9]) applied to A-007 produces [A, 7] as features.","properties":{"entitySet":{"type":"string","description":"Which set of entities the extractor will extract features from.","enum":["sources","targets"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].extractors.items.[INDEX].entitySet","typeLabel":"enum\u003cstring>"},"extractorType":{"type":"string","description":"The type of extractor. Currently, we only support \"regex\".","enum":["regex"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].extractors.items.[INDEX].extractorType","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"The entity field that the extractor will get features from.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].extractors.items.[INDEX].field","typeLabel":"string"},"pattern":{"type":"string","description":"A regular expression without nested catching groups.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].extractors.items.[INDEX].pattern","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].extractors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].extractors","typeLabel":"object[]"},"conditions":{"type":"array","description":"List of conditions that must be met for the rule to link two entities. The conditions refer to features extracted by the extractors. A condition of type \"equals\" that refers to features extracted from a source entity and a target entity requires these features to be equal for the entities to match.","items":{"type":"object","required":["conditionType","arguments"],"properties":{"conditionType":{"type":"string","description":"The type of condition. Currently, we only support the 'equals' condition. It requires all features referenced by its arguments to be equal.","enum":["equals"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].conditions.items.[INDEX].conditionType","typeLabel":"enum\u003cstring>"},"arguments":{"type":"array","description":"References to features. Each argument is a list with two zero indexed indices. E.g. [0, 1] refers to the 1th (second) feature produced by the 0th (first) extractor of the rule.","items":{"type":"array","items":{"type":"number","format":"int64","minimum":0,"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].conditions.items.[INDEX].arguments.items.[INDEX].items.[INDEX]","typeLabel":"number\u003cint64>"},"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].conditions.items.[INDEX].arguments.items.[INDEX]","typeLabel":"number\u003cint64>[]"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].conditions.items.[INDEX].arguments","typeLabel":"number\u003cint64>[][]"},"config":{"type":"object","description":"Configuration of the condition not captured in its arguments and type.","properties":{"synonyms":{"type":"array","description":"Entries describing tokens that are equivalent.","items":{"type":"object","description":"List of sources and targets words that all mean the same.","properties":{"sources":{"type":"array","description":"List of tokens that have the same meaning when appearing in a source entity.","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].conditions.items.[INDEX].config.synonyms.items.[INDEX].sources.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].conditions.items.[INDEX].config.synonyms.items.[INDEX].sources","typeLabel":"string[]"},"targets":{"type":"array","description":"List of tokens that have the same meaning when appearing in a target entity.","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].conditions.items.[INDEX].config.synonyms.items.[INDEX].targets.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].conditions.items.[INDEX].config.synonyms.items.[INDEX].targets","typeLabel":"string[]"}},"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].conditions.items.[INDEX].config.synonyms.items.[INDEX]","typeLabel":"object"},"example":[{"sources":["odour"],"targets":["odor"]},{"sources":["petrol"],"targets":["gas","gasoline"]}],"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].conditions.items.[INDEX].config.synonyms","typeLabel":"object[]"}},"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].conditions.items.[INDEX].config","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].conditions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].conditions","typeLabel":"object[]"},"priority":{"type":"number","format":"int64","minimum":0,"default":0,"description":"In case different rules provide matches for the same source entities, only the highest priority rules are applied to these entities.","uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX].priority","typeLabel":"number\u003cint64>"}},"example":{"extractors":[{"entitySet":"sources","extractorType":"regex","field":"species","pattern":"(.*)"},{"entitySet":"targets","extractorType":"regex","field":"species","pattern":"(.*)"}],"conditions":[{"conditionType":"equals","arguments":[[0,0],[1,0]]}],"priority":10},"uniqueKey":"\\items.items.[INDEX].rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].rules","typeLabel":"object[]"},"rejectedRules":{"type":"array","description":"A collection of match rules","minItems":0,"maxItems":1000,"default":[],"items":{"type":"object","description":"An entity matching rule matches source entities with target entities based on a pattern defined by the rule.\nA rule has extractors that both require entities to follow a certain format, and produce lists of features.\n\nFor a regex extractor, a specific field must match a pattern, and parts of the pattern become the features.\nThe conditions of a rule express which extracted features must be equal for two entities to match.\n\nSince extractors restrict the scopes of rules to entities that conform with patterns, two rules will often not\nhave entities in common that they apply to. But if they do, the more specific rule is given higher priority.\n\nIf one rule is not a special case of the other, they may be inconsistent (conflict) or redundant (overlap).","required":["extractors","conditions"],"properties":{"extractors":{"type":"array","description":"An extractor produces a list of features based on a source entity or a target entity. In particular a regex extractor defines which entities (e.g. sources) it acts on, a field (e.g. name) and a regular expression. The extractor will only produce features if the field of an entity matches the pattern. The returned features are then substrings of the field as defined in the pattern. Entities in the relevant set that do not match the pattern will not be matched by the rule, but may be matched by other rules.","items":{"type":"object","required":["entitySet","extractorType","field","pattern"],"description":"An extractor that acts on entities from 'entitySet'. An entity must have a value of 'field' that matches the regular expression 'pattern' to get features. The features are the catching groups of the pattern, that is the parts that are in parenthesis. E.g. ([A-Z])-00([0-9]) applied to A-007 produces [A, 7] as features.","properties":{"entitySet":{"type":"string","description":"Which set of entities the extractor will extract features from.","enum":["sources","targets"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].extractors.items.[INDEX].entitySet","typeLabel":"enum\u003cstring>"},"extractorType":{"type":"string","description":"The type of extractor. Currently, we only support \"regex\".","enum":["regex"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].extractors.items.[INDEX].extractorType","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"The entity field that the extractor will get features from.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].extractors.items.[INDEX].field","typeLabel":"string"},"pattern":{"type":"string","description":"A regular expression without nested catching groups.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].extractors.items.[INDEX].pattern","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].extractors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].extractors","typeLabel":"object[]"},"conditions":{"type":"array","description":"List of conditions that must be met for the rule to link two entities. The conditions refer to features extracted by the extractors. A condition of type \"equals\" that refers to features extracted from a source entity and a target entity requires these features to be equal for the entities to match.","items":{"type":"object","required":["conditionType","arguments"],"properties":{"conditionType":{"type":"string","description":"The type of condition. Currently, we only support the 'equals' condition. It requires all features referenced by its arguments to be equal.","enum":["equals"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].conditions.items.[INDEX].conditionType","typeLabel":"enum\u003cstring>"},"arguments":{"type":"array","description":"References to features. Each argument is a list with two zero indexed indices. E.g. [0, 1] refers to the 1th (second) feature produced by the 0th (first) extractor of the rule.","items":{"type":"array","items":{"type":"number","format":"int64","minimum":0,"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].conditions.items.[INDEX].arguments.items.[INDEX].items.[INDEX]","typeLabel":"number\u003cint64>"},"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].conditions.items.[INDEX].arguments.items.[INDEX]","typeLabel":"number\u003cint64>[]"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].conditions.items.[INDEX].arguments","typeLabel":"number\u003cint64>[][]"},"config":{"type":"object","description":"Configuration of the condition not captured in its arguments and type.","properties":{"synonyms":{"type":"array","description":"Entries describing tokens that are equivalent.","items":{"type":"object","description":"List of sources and targets words that all mean the same.","properties":{"sources":{"type":"array","description":"List of tokens that have the same meaning when appearing in a source entity.","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].conditions.items.[INDEX].config.synonyms.items.[INDEX].sources.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].conditions.items.[INDEX].config.synonyms.items.[INDEX].sources","typeLabel":"string[]"},"targets":{"type":"array","description":"List of tokens that have the same meaning when appearing in a target entity.","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].conditions.items.[INDEX].config.synonyms.items.[INDEX].targets.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].conditions.items.[INDEX].config.synonyms.items.[INDEX].targets","typeLabel":"string[]"}},"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].conditions.items.[INDEX].config.synonyms.items.[INDEX]","typeLabel":"object"},"example":[{"sources":["odour"],"targets":["odor"]},{"sources":["petrol"],"targets":["gas","gasoline"]}],"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].conditions.items.[INDEX].config.synonyms","typeLabel":"object[]"}},"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].conditions.items.[INDEX].config","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].conditions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].conditions","typeLabel":"object[]"},"priority":{"type":"number","format":"int64","minimum":0,"default":0,"description":"In case different rules provide matches for the same source entities, only the highest priority rules are applied to these entities.","uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX].priority","typeLabel":"number\u003cint64>"}},"example":{"extractors":[{"entitySet":"sources","extractorType":"regex","field":"species","pattern":"(.*)"},{"entitySet":"targets","extractorType":"regex","field":"species","pattern":"(.*)"}],"conditions":[{"conditionType":"equals","arguments":[[0,0],[1,0]]}],"priority":10},"uniqueKey":"\\items.items.[INDEX].rejectedRules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].rejectedRules","typeLabel":"object[]"},"scoreThreshold":{"type":"number","example":0.7,"minimum":0,"maximum":1,"default":0,"description":"Only return model matches with score above this threshold.","uniqueKey":"\\items.items.[INDEX].scoreThreshold","typeLabel":"number"},"scheduleInterval":{"type":"integer","example":7200,"minimum":3600,"maximum":2678400,"description":"How often to schedule the pipeline, in seconds. The interval can be between 1 hour and 31 days.","uniqueKey":"\\items.items.[INDEX].scheduleInterval","typeLabel":"integer"},"lastRun":{"type":"object","description":"The latest run for this pipeline, if it was ever run.","required":["pipelineId","jobId","status","createdTime","startTime","statusTime"],"properties":{"status":{"description":"The status of the job.","type":"string","enum":["Queued","Running","Completed","Failed"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].lastRun.status","typeLabel":"enum\u003cstring>"},"createdTime":{"description":"The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.","type":"integer","minimum":0,"format":"int64","example":1730204346000,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].lastRun.createdTime","typeLabel":"integer\u003cint64>"},"startTime":{"description":"The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.","type":"integer","minimum":0,"format":"int64","example":1730204346000,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].lastRun.startTime","typeLabel":"integer\u003cint64>"},"statusTime":{"description":"The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.","type":"integer","minimum":0,"format":"int64","example":1730204346000,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].lastRun.statusTime","typeLabel":"integer\u003cint64>"},"jobId":{"description":"Contextualization job ID.","type":"integer","example":123,"format":"int64","isRequired":true,"uniqueKey":"\\items.items.[INDEX].lastRun.jobId","typeLabel":"integer\u003cint64>"},"errorMessage":{"type":"string","description":"If the job failed, some more information about the error cause.","example":null,"default":null,"uniqueKey":"\\items.items.[INDEX].lastRun.errorMessage","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].lastRun","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"items":[{"id":4503599627370496,"createdTime":1730204346000,"sources":{"dataSetIds":[{"id":4503599627370496}],"resource":"assets"},"targets":{"dataSetIds":[{"id":4503599627370496}],"resource":"assets"},"lastUpdatedTime":1730204346000,"owner":"alice@example.com","externalId":"my.known.id","name":"myPipeline","description":"My pipeline","modelParameters":{"featureType":"bigram"},"trueMatches":[{"sourceId":23}],"confirmedMatches":[{"sourceId":23}],"rejectedMatches":[{"sourceId":23}],"useExistingMatches":false,"generateRules":true,"replacements":[{"field":"*","string":"Bottom-hole pressure","replacement":"bhp"}],"rules":[],"rejectedRules":[],"scoreThreshold":0.7,"scheduleInterval":7200,"lastRun":{"status":"Queued","createdTime":1730204346000,"startTime":1730204346000,"statusTime":1730204346000,"jobId":123,"errorMessage":null}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"5f58a307-f5b7-4dd2-bcb5-d68f1390c51d":{"description":"The response for a bad request.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"description":"Cognite API error.","properties":{"code":{"type":"integer","description":"HTTP status code.","format":"int32","example":401,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer\u003cint32>"},"message":{"type":"string","description":"Error message.","example":"Could not authenticate.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"missing":{"type":"array","description":"List of lookup objects that do not match any results.","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.missing.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.missing","typeLabel":"object[]"},"duplicated":{"type":"array","description":"List of objects that are not unique.","items":{"type":"object","additionalProperties":true,"uniqueKey":"error.duplicated.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.duplicated","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":400,"message":"`null` values aren't allowed."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":400,"message":"`null` values aren't allowed."}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"7a5db33e-7d67-4991-8ba9-297b63b3c513":{"oidc-token":{"type":"http","scheme":"bearer","bearerFormat":"OpenID Connect or OAuth2 token","description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","scopes":["https://{cluster}.cognitedata.com/.default"],"schemeName":"oidc-token"}},"04cf0117-c451-4de7-8791-4c79afede537":{"oauth2-client-credentials":{"type":"oauth2","description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","flows":{"clientCredentials":{"tokenUrl":"https://your-idps.token.url/","scopes":{"default":"https://{cluster}.cognitedata.com/.default"}}},"scopes":["https://{cluster}.cognitedata.com/.default"],"schemeName":"oauth2-client-credentials"}},"6c68a850-cb39-4a69-8e55-b49528f8c2e3":{"oauth2-open-industrial-data":{"type":"oauth2","description":"Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.","flows":{"clientCredentials":{"tokenUrl":"https://login.microsoftonline.com/48d5043c-cf70-4c49-881c-c638f5796997/oauth2/v2.0/token","scopes":{"default":"https://api.cognitedata.com/.default"}}},"scopes":["https://api.cognitedata.com/.default"],"schemeName":"oauth2-open-industrial-data"}},"d738c8ed-8e7a-453a-9b0f-1c7e70c37062":{"oauth2-auth-code":{"type":"oauth2","description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","flows":{"authorizationCode":{"authorizationUrl":"https://your-idps.authorization.url/","tokenUrl":"https://your-idps.token.url/","scopes":{"default":"https://{cluster}.cognitedata.com/.default"}}},"scopes":["https://{cluster}.cognitedata.com/.default"],"schemeName":"oauth2-auth-code"}}},"servers":{"2150d75b-88d8-4770-8187-171b713d9f99":{"url":"https://{cluster}.cognitedata.com/api/v1/projects/{project}","description":"The URL for the CDF cluster to connect to","variables":{"cluster":{"enum":["api","az-tyo-gp-001","az-eastus-1","az-power-no-northeurope","westeurope-1","asia-northeast1-1","gc-dsm-gp-001"],"default":"api","description":"The CDF cluster to connect to"},"project":{"default":"publicdata","description":"The CDF project name."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"OpenID Connect or OAuth2 token","description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","scopes":["https://{cluster}.cognitedata.com/.default"],"schemeName":"oidc-token"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oidc-token","name":"Authorization"}],"title":"oidc-token"},{"schemes":[{"scheme":{"type":"oauth2","description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","flows":{"clientCredentials":{"tokenUrl":"https://your-idps.token.url/","scopes":{"default":"https://{cluster}.cognitedata.com/.default"}}},"scopes":["https://{cluster}.cognitedata.com/.default"],"schemeName":"oauth2-client-credentials"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2-client-credentials","name":"Authorization"}],"title":"oauth2-client-credentials"},{"schemes":[{"scheme":{"type":"oauth2","description":"Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.","flows":{"clientCredentials":{"tokenUrl":"https://login.microsoftonline.com/48d5043c-cf70-4c49-881c-c638f5796997/oauth2/v2.0/token","scopes":{"default":"https://api.cognitedata.com/.default"}}},"scopes":["https://api.cognitedata.com/.default"],"schemeName":"oauth2-open-industrial-data"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2-open-industrial-data","name":"Authorization"}],"title":"oauth2-open-industrial-data"},{"schemes":[{"scheme":{"type":"oauth2","description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","flows":{"authorizationCode":{"authorizationUrl":"https://your-idps.authorization.url/","tokenUrl":"https://your-idps.token.url/","scopes":{"default":"https://{cluster}.cognitedata.com/.default"}}},"scopes":["https://{cluster}.cognitedata.com/.default"],"schemeName":"oauth2-auth-code"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2-auth-code","name":"Authorization"}],"title":"oauth2-auth-code"}]},"originalFileLocation":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json"},"subdomain":"cognite","siteName":"Cognite Docs","title":"Retrieve multiple pipelines - Cognite Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines","matchLevel":0},"de":{"href":"/de","matchLevel":4},"es":{"href":"/es","matchLevel":4},"fr":{"href":"/fr","matchLevel":4},"ko":{"href":"/ko","matchLevel":4},"it":{"href":"/it","matchLevel":4},"lv":{"href":"/lv","matchLevel":4},"nl":{"href":"/nl","matchLevel":4},"ja":{"href":"/ja","matchLevel":4},"no":{"href":"/no","matchLevel":4},"pt":{"href":"/pt","matchLevel":4},"ro":{"href":"/ro","matchLevel":4},"sv":{"href":"/sv","matchLevel":4},"zh":{"href":"/zh","matchLevel":4}}},"originalFileLocation":"20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"\u0026gt; Required capabilities: entitymatchingAcl:READ assetsAcl:READ Retrieve multiple entity matching pipelines.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cognite Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve multiple pipelines - Cognite Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"\u0026gt; Required capabilities: entitymatchingAcl:READ assetsAcl:READ Retrieve multiple entity matching pipelines.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cognite Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cognite.com/20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cognite.mintlify.site/_mintlify/api/og/v2?division=Pipelines\u0026amp;title=Retrieve+multiple+pipelines\u0026amp;description=%0A%0A%3E+**Required+capabilities%3A**+%60entitymatchingAcl%3AREAD%60+%60assetsAcl%3AREAD%60%0A%0ARetrieve+multiple+entity+matching+pipelines.\u0026amp;theme=9da546f85ddd355458e0d0e4\u0026amp;signature=0527a6dae28c6dc3310bddd50c6d107b13b7ca13297d06898bcf271f18329b7b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve multiple pipelines - Cognite Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"\u0026gt; Required capabilities: entitymatchingAcl:READ assetsAcl:READ Retrieve multiple entity matching pipelines.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cognite.mintlify.site/_mintlify/api/og/v2?division=Pipelines\u0026amp;title=Retrieve+multiple+pipelines\u0026amp;description=%0A%0A%3E+**Required+capabilities%3A**+%60entitymatchingAcl%3AREAD%60+%60assetsAcl%3AREAD%60%0A%0ARetrieve+multiple+entity+matching+pipelines.\u0026amp;theme=9da546f85ddd355458e0d0e4\u0026amp;signature=0527a6dae28c6dc3310bddd50c6d107b13b7ca13297d06898bcf271f18329b7b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/cognite/62AQOhh9Qn2JM6wf/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cognite Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3C5FFB\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"kX2vFxX0NcdV88MV5ooALR09TbeSd8xDN-rVd6fiTG4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cognite.com/20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cognite.com/#organization\",\"name\":\"Cognite Docs\",\"url\":\"https://docs.cognite.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cognite/dkctM57aym6D8Toa/_images/logo/cognite-docs-black.svg?fit=max\u0026auto=format\u0026n=dkctM57aym6D8Toa\u0026q=85\u0026s=38c50e5be94d9baf1ff1c794ae17d6ea\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cognite.com#website\",\"name\":\"Cognite Docs\",\"url\":\"https://docs.cognite.com\",\"publisher\":{\"@id\":\"https://docs.cognite.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cognite.com/20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines#webpage\",\"url\":\"https://docs.cognite.com/20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines\",\"name\":\"Retrieve multiple pipelines\",\"description\":\"> Required capabilities: entitymatchingAcl:READ assetsAcl:READ Retrieve multiple entity matching pipelines.\",\"isPartOf\":{\"@id\":\"https://docs.cognite.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cognite.com/20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cognite.com/20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference (20230101-alpha)\",\"item\":\"https://docs.cognite.com/api-reference/concepts/20230101-alpha/api-description\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Contextualization\",\"item\":\"https://docs.cognite.com/api-reference/concepts/20230101-alpha/contextualization\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Entity matching\",\"item\":\"https://docs.cognite.com/api-reference/concepts/20230101-alpha/entity-matching\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Pipelines\",\"item\":\"https://docs.cognite.com/20230101-alpha/entity-matching-pipelines/list-pipelines\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Retrieve multiple pipelines\",\"item\":\"https://docs.cognite.com/20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cognite.com/20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines#apireference\",\"headline\":\"Retrieve multiple pipelines\",\"name\":\"Retrieve multiple pipelines\",\"description\":\"> Required capabilities: entitymatchingAcl:READ assetsAcl:READ Retrieve multiple entity matching pipelines.\",\"url\":\"https://docs.cognite.com/20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cognite.com/20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines#webpage\"},\"publisher\":{\"@id\":\"https://docs.cognite.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cognite.com#website\"}}]}\u003c/script>","agentPointerHref":"/20230101-alpha/entity-matching-pipelines/retrieve-multiple-pipelines.md","siteName":"Cognite Docs","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":""}]},{"tab":"Flows","pages":[{"title":"Flows","href":"/cdf/flows_workspace"}]},{"tab":"Data engineering","pages":[{"title":"Data engineering","href":"/cdf/data_engineering"}]},{"tab":"Build","pages":[{"title":"Build","href":"/cdf/build"}]},{"tab":"Admin","pages":[{"title":"Admin","href":"/cdf/admin"}]},{"tab":"Deploy","pages":[{"title":"Deploy","href":"/cdf/deploy"}]},{"tab":"Develop","pages":[{"title":"Develop","href":"/dev"}]},{"tab":"API reference","menu":[{"item":"Stable (20230101)","description":"Production version (stable)","pages":[{"title":"Stable (20230101)","href":"/api-reference/concepts/20230101/api-description"}]},{"item":"Beta (20230101-beta)","description":"Preview API operations on top of stable","pages":[{"title":"Beta (20230101-beta)","href":"/api-reference/concepts/20230101-beta/api-description"}]},{"item":"Alpha (20230101-alpha)","description":"Experimental API operations","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","href":"/api-reference/concepts/20230101-alpha/api-description"},{"title":"API rate limits","sidebarTitle":"Rate limits","href":"/api-reference/concepts/20230101-alpha/rate-limits"},{"title":"Cognite API changelog","sidebarTitle":"Changelog","href":"/api-reference/concepts/20230101-alpha/changelog"}]},{"group":"Metering","pages":[{"title":"Metering","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/metering"},{"title":"List all meters","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"},{"title":"Retrieve multiple consumption data by their ids","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"},{"title":"Filter meters","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"},{"title":"Retrieve consumption data by its id","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"}]},{"group":"Limits","pages":[{"title":"Limits API","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/limits-api"},{"title":"List all limit values","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"},{"title":"Advanced list of limit values.","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"},{"title":"Retrieve a limit value by its id","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"}]},{"group":"Organizations and projects","pages":[{"title":"Organizations and projects","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/organizations-and-projects"},{"group":"Organizations","pages":[{"title":"Organizations","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/organizations"},{"title":"Create an 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"},{"title":"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"},{"title":"List child organizations","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"},{"title":"Retrieve an organization","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"}]},{"group":"Projects","pages":[{"title":"Projects","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/projects"},{"title":"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"},{"title":"List projects in an organization","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"}]}]},{"group":"Identity and access management","pages":[{"title":"Identity and access management","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/identity-and-access-management"},{"group":"Principals","pages":[{"title":"Principals","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/principals"},{"title":"Get the current caller's information","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"},{"title":"List 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"},{"title":"List principals","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"},{"title":"Retrieve principals by reference","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"},{"title":"Revoke 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"}]},{"group":"Groups","pages":[{"title":"Groups","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/groups"},{"title":"Create groups","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /groups","href":"/20230101-alpha/groups/create-groups"},{"title":"Delete groups","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"},{"title":"List groups","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /groups","href":"/20230101-alpha/groups/list-groups"}]},{"group":"Security categories","pages":[{"title":"Security categories","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/security-categories"},{"title":"Create security categories","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"},{"title":"Delete security categories","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"},{"title":"List security categories","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"}]},{"group":"Sessions","pages":[{"title":"Sessions","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/sessions"},{"title":"Create 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"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /sessions","href":"/20230101-alpha/sessions/list-sessions"},{"title":"Retrieve sessions with given IDs","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"},{"title":"Revoke sessions","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"}]},{"group":"Token","pages":[{"title":"Tokens","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/tokens"},{"title":"Inspect","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /token/inspect","href":"/20230101-alpha/token/inspect"}]},{"group":"User profiles","tag":"deprecated","pages":[{"title":"User profiles","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/user-profiles"},{"title":"(deprecated) Get the user profile of the principal issuing the request","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /profiles/me","href":"/20230101-alpha/user-profiles/deprecated-get-the-user-profile-of-the-principal-issuing-the-request"},{"title":"Get the user profile of the principal issuing the request","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /principals/me","href":"/20230101-alpha/user-profiles/get-the-user-profile-of-the-principal-issuing-the-request"},{"title":"List all user profiles in the current project","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /profiles","href":"/20230101-alpha/user-profiles/list-all-user-profiles-in-the-current-project"},{"title":"Retrieve profiles by ID in the current project","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /profiles/byids","href":"/20230101-alpha/user-profiles/retrieve-profiles-by-id-in-the-current-project"},{"title":"Search user profiles in the current project","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /profiles/search","href":"/20230101-alpha/user-profiles/search-user-profiles-in-the-current-project"}]},{"group":"Applications","pages":[{"title":"Applications","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/applications"},{"title":"List applications","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"},{"title":"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"},{"title":"Get application","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"},{"title":"Update applications","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"},{"title":"Delete applications","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"}]}]}]},{"group":"Core data","icon":"database","expanded":true,"pages":[{"group":"Data modeling","pages":[{"title":"Data modeling with the industrial knowledge graph","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/data-modeling"},{"group":"Data models","pages":[{"title":"Data models","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/data-models"},{"title":"Create or update data models","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"},{"title":"Delete data models","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"},{"title":"List data models defined in the project","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"},{"title":"Retrieve data models by their external ids","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"}]},{"group":"Spaces","pages":[{"title":"Spaces","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/spaces"},{"title":"Create or update spaces","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"},{"title":"Delete spaces","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"},{"title":"List spaces defined in the 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"},{"title":"Retrieve spaces by 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"}]},{"group":"Views","pages":[{"title":"Views","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/views"},{"title":"Create or update views","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"},{"title":"Delete views","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"},{"title":"List views defined in the project","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"},{"title":"Retrieve 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"}]},{"group":"Containers","pages":[{"title":"Containers","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/containers"},{"title":"Create or update containers","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"},{"title":"Delete containers","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"},{"title":"Delete indexes from containers","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"},{"title":"Delete constraints from containers","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"},{"title":"Inspect containers","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"},{"title":"List containers defined in the project","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"},{"title":"Retrieve containers by their 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"},{"title":"Retry failed container constraints","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"},{"title":"Retry failed indexes","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"},{"title":"Retry failed 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"}]},{"group":"Instances","pages":[{"title":"Instances","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/instances"},{"title":"Aggregate data across nodes/edges","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"},{"title":"Create or update nodes/edges","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"},{"title":"Delete nodes/edges","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"},{"title":"Filter nodes/edges","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"},{"title":"Inspect instances","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"},{"title":"Query nodes/edges","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"},{"title":"Retrieve nodes/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"},{"title":"Search for nodes/edges","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"},{"title":"Sync nodes/edges","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"}]},{"group":"Statistics","pages":[{"title":"Statistics","sidebarTitle":"Statistics","href":"/api-reference/concepts/20230101-alpha/dm-statistics"},{"title":"Retrieve project-wide statistics and limits","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"},{"title":"Retrieve statistics by space","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"},{"title":"Retrieve statistics by space for specific space-ids","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"}]},{"group":"Streams","pages":[{"title":"Streams","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/streams"},{"title":"Create stream","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /streams","href":"/20230101-alpha/streams/create-stream"},{"title":"Delete stream","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"},{"title":"List streams","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /streams","href":"/20230101-alpha/streams/list-streams"},{"title":"List 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"},{"title":"Retrieve stream","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"}]},{"group":"Records","pages":[{"title":"Records","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/records"},{"title":"Aggregate records data from a stream","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"},{"title":"Delete records from a stream","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"},{"title":"Ingest records into a stream","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"},{"title":"Retrieve records from a stream","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"},{"title":"Sync records from a stream","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"},{"title":"Upsert (create or update) records into a stream","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"}]}]},{"group":"Time series and datapoints","pages":[{"title":"Time series and datapoints","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/time-series-data"},{"group":"Datapoints","pages":[{"title":"Datapoints","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/datapoints"},{"title":"Insert data points","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"},{"title":"Retrieve 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"},{"title":"Retrieve latest data point","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"},{"title":"Delete data points","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"}]},{"group":"Synthetic time series","pages":[{"title":"Synthetic time series","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/synthetic-time-series"},{"title":"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"}]},{"group":"Data point subscriptions","pages":[{"title":"Data point subscriptions","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/data-point-subscriptions"},{"title":"Create subscriptions","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"},{"title":"Delete subscriptions","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"},{"title":"List subscription data","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"},{"title":"List subscription members","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"},{"title":"List subscriptions","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"},{"title":"Retrieve subscriptions","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"},{"title":"Update subscriptions","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"}]}]},{"group":"File content","pages":[{"title":"File content","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/file-content"},{"title":"Get upload file link","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"},{"title":"Download files","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"},{"title":"Upload multipart file","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"},{"title":"Get multipart file upload link","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"},{"title":"Complete multipart upload","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"},{"title":"Get icon","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"}]},{"group":"3D","pages":[{"title":"3D","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/3d"},{"group":"3D models","pages":[{"title":"3D Models","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/3d-models"},{"title":"List 3D models","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"},{"title":"Create 3D models","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"},{"title":"Update 3D models","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"},{"title":"Delete 3D models","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"},{"title":"Retrieve a 3D model","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"}]},{"group":"3D model revisions","pages":[{"title":"3D Model Revisions","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/3d-model-revisions"},{"title":"List 3D revisions","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"},{"title":"Create 3D 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"},{"title":"Update 3D revisions","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"},{"title":"Delete 3D revisions","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"},{"title":"Retrieve a 3D revision","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"},{"title":"List 3D revision logs","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"},{"title":"Update 3D revision thumbnail","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"},{"title":"List available 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"},{"title":"List 3D 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"},{"title":"Filter 3D 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"},{"title":"Get 3D nodes by ID","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"},{"title":"List 3D ancestor nodes","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"}]},{"group":"3D files","pages":[{"title":"3D Files","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/3d-files"},{"title":"Retrieve a single 3D file","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"},{"title":"Retrieve a 3D directory file","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"}]},{"group":"3D asset mapping","pages":[{"title":"3D Asset Mapping","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/3d-asset-mapping"},{"title":"List 3D asset mappings","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"},{"title":"Create 3D asset mappings","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"},{"title":"Delete 3D asset mappings","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"},{"title":"Filter 3D asset mappings","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"},{"title":"Filter which nodes are within a boundingbox for a revision.","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /3d/nodes/list","href":"/20230101-alpha/3d-asset-mapping/filter-which-nodes-are-within-a-boundingbox-for-a-revision"},{"title":"List mappings for one assetID across all 3D models","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /3d/mappings/{assetId}/modelnodes","href":"/20230101-alpha/3d-asset-mapping/list-mappings-for-one-assetid-across-all-3d-models"},{"title":"Filter 3D assetInstanceId mappings across all 3D models","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"}]},{"group":"3D jobs","pages":[{"title":"3D Jobs","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/3d-jobs"},{"title":"Create a job using 3D source data","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"},{"title":"List jobs","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"},{"title":"Delete jobs","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"},{"title":"List Job Results","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"},{"title":"Update Job Result Rejections","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"},{"title":"List Job Result Rejections","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"}]},{"group":"3D contextualization","pages":[{"title":"Create CAD contextualization","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"},{"title":"Delete CAD contextualization","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"},{"title":"Create 360 image contextualization","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"},{"title":"Delete 360 image contextualization","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"},{"title":"Create point cloud volume contextualization","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"},{"title":"Delete point cloud volume contextualization","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"}]}]}]},{"group":"Cognite AI","icon":"bot","expanded":true,"pages":[{"title":"Cognite AI","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/cognite-ai"},{"group":"Agents","pages":[{"title":"AI agents","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/ai-agents"},{"title":"List agents","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"},{"title":"Add or update 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"},{"title":"Retrieve agents by external ID","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"},{"title":"Start a chat session with an agent","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"},{"title":"Delete agents","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"}]},{"group":"Chat completions","pages":[{"title":"Chat completions","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/ai-chat-completions"},{"title":"Create chat completions","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"}]},{"group":"Document AI","pages":[{"title":"Document AI","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/document-ai"},{"title":"Ask questions about one or more documents.","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"},{"title":"Summarize documents.","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"}]},{"group":"Models","pages":[{"title":"Language models","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/ai-models"},{"title":"List models","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"}]},{"group":"Skills","pages":[{"title":"AI skills","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/ai-skills"},{"title":"List 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"},{"title":"Add or update Atlas AI project skills","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"},{"title":"Retrieve skills by external ID","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"},{"title":"Upload a skill from a Markdown file","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"},{"title":"Download a skill as a zip archive","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"},{"title":"Delete skills","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"}]}]},{"group":"Compute and automation","icon":"cpu","expanded":true,"pages":[{"group":"Functions","pages":[{"title":"Functions","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/functions-overview"},{"group":"Functions","pages":[{"title":"Functions","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/functions"},{"title":"Activate 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"},{"title":"Get 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"},{"title":"Create functions","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /functions","href":"/20230101-alpha/functions/create-functions"},{"title":"Delete functions","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"},{"title":"Filter 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"},{"title":"Functions limits","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"},{"title":"List 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"},{"title":"Retrieve a function by its id","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"},{"title":"Retrieve functions","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"}]},{"group":"Function calls","pages":[{"title":"Function calls","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/function-calls"},{"title":"Call a function asynchronously","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"},{"title":"Filter 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"},{"title":"List 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"},{"title":"Retrieve calls","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"},{"title":"Retrieve a function call by its id","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"},{"title":"Retrieve logs for 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"},{"title":"Retrieve response for 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"}]},{"group":"Function schedules","pages":[{"title":"Function schedules","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/function-schedules"},{"title":"Create schedules","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"},{"title":"Delete 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"},{"title":"Filter function schedules","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"},{"title":"List schedules","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"},{"title":"Retrieve 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"},{"title":"Retrieve schedules","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"},{"title":"Retrieve function input data","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"}]},{"group":"Function Apps","pages":[{"title":"List Function Apps","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"},{"title":"Get Function App","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"},{"title":"Call Function Endpoint","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"},{"title":"List Calls","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"},{"title":"Get Call Logs","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"},{"title":"Get Call Response","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"}]}]}]},{"group":"Connectors","icon":"plug","expanded":true,"pages":[{"group":"PostgreSQL gateway","pages":[{"title":"PostgreSQL gateway","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/postgresql-gateway"},{"group":"Postgres gateway users","pages":[{"title":"Postgres Gateway Users","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/postgres-gateway-users"},{"title":"Create 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"},{"title":"Filter users","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"},{"title":"Retrieve users","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"},{"title":"Update 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"},{"title":"Delete 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"},{"title":"List users","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"}]},{"group":"Postgres gateway tables","pages":[{"title":"Postgres Gateway Tables","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/postgres-gateway-tables"},{"title":"Create 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"},{"title":"List tables","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"},{"title":"Retrieve tables","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"},{"title":"Delete 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"}]}]},{"group":"SAP writeback","pages":[{"title":"SAP writeback","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/sap-writeback"},{"group":"SAP instances","pages":[{"title":"SAP Instances","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/sap-instances"},{"title":"Create 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"},{"title":"Retrieve SAP Instances","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"},{"title":"Delete SAP Instances","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"}]},{"group":"SAP endpoints","pages":[{"title":"SAP Endpoints","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/sap-endpoints"},{"title":"Create 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"},{"title":"Retrieve SAP Endpoints","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"},{"title":"Delete SAP Endpoints","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"},{"title":"Verify SAP Endpoint","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"}]},{"group":"Schema mappings","pages":[{"title":"Schema Mappings","sidebarTitle":"Schema Mappings","href":"/api-reference/concepts/20230101-alpha/sap-schema-mappings"},{"title":"Create 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"},{"title":"Retrieve Mappings","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"},{"title":"Delete Mappings","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"}]},{"group":"Writeback requests","pages":[{"title":"Writeback Requests","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/writeback-requests"},{"title":"Create Writeback Requests","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"},{"title":"Retrieve Writeback Requests","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"}]}]}]},{"group":"Contextualization","icon":"puzzle","expanded":true,"pages":[{"title":"Contextualization","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/contextualization"},{"group":"Entity matching","pages":[{"title":"Entity matching","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/entity-matching"},{"title":"Create entity matcher model","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"},{"title":"Delete entity matcher model","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"},{"title":"Filter 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"},{"title":"List entity matching models","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"},{"title":"Retrieve an entity matching model by the ID of the model","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/entitymatching/{id}","href":"/20230101-alpha/entity-matching/retrieve-an-entity-matching-model-by-the-id-of-the-model"},{"title":"Predict matches","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /context/entitymatching/predict","href":"/20230101-alpha/entity-matching/predict-matches"},{"title":"Re-fit entity matcher model","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"},{"title":"Retrieve entity matcher predict results","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"},{"title":"Retrieve entity matching models","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"},{"title":"Update entity matching models","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"},{"group":"Pipelines","pages":[{"title":"List 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"},{"title":"Get 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"},{"title":"List pipeline runs","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"},{"title":"Get latest pipeline run results","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"},{"title":"Get pipeline run results","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"},{"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"},{"title":"Retrieve multiple 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"},{"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"},{"title":"Update 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"},{"title":"Run pipeline","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"}]}]},{"group":"Engineering diagrams","pages":[{"title":"Engineering diagrams","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/engineering-diagrams"},{"title":"Convert a diagram to image format","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"},{"title":"Detect annotations in engineering diagrams","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"},{"title":"Retrieve OCR text","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"},{"title":"Get the results for converting an engineering diagram to an image","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/diagram/convert/{jobId}","href":"/20230101-alpha/engineering-diagrams/get-the-results-for-converting-an-engineering-diagram-to-an-image"},{"title":"Retrieve engineering diagram detect results","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /context/diagram/detect/{jobId}","href":"/20230101-alpha/engineering-diagrams/retrieve-engineering-diagram-detect-results"}]},{"group":"Diagram parsing","pages":[{"group":"Parsing","pages":[{"title":"Run parsing with tag detection for files","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"},{"title":"Run an instant parsing job for a file","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"},{"title":"Run parsing for files","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"}]},{"group":"Libraries","pages":[{"title":"List libraries","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"},{"title":"Get a library with symbols","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"},{"title":"Create 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"},{"title":"Retrieve libraries","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"},{"title":"Delete libraries","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"},{"title":"Update 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"},{"title":"Copy library","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"}]},{"group":"Symbols","pages":[{"title":"List symbols","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"},{"title":"Create 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"},{"title":"Retrieve symbols","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"},{"title":"Delete symbols","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"},{"title":"Update 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"}]},{"group":"Geometries","pages":[{"title":"List geometries","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"},{"title":"Create 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"},{"title":"Retrieve geometries","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"},{"title":"Delete geometries","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"},{"title":"Update 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"}]},{"group":"Diagrams","pages":[{"title":"List diagrams","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"},{"title":"Get an extended diagram by external id","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"},{"title":"Get an extended diagram with paths by 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"},{"title":"Get an extended diagram by file reference","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"},{"title":"Retrieve diagrams","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"},{"title":"Filter diagrams","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"}]},{"group":"Entities","pages":[{"title":"List diagram entities","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"},{"title":"Create 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"},{"title":"Retrieve diagram entities","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"},{"title":"Delete diagram entities","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"},{"title":"Update 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"}]},{"group":"Connections","pages":[{"title":"List connections","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"},{"title":"Create connections","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"},{"title":"Retrieve connections","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"},{"title":"Delete connections","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"}]},{"group":"SVG Data","pages":[{"title":"Get SVG data by diagramId","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"},{"title":"Get SVG data by file reference","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"}]}]},{"group":"Vision","pages":[{"title":"Vision","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/vision"},{"title":"Extract features from images","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"},{"title":"Retrieve results from a feature extraction job on images","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"},{"title":"Segment objects in an image","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"},{"title":"Retrieve results from a segmentation job on an image","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"}]},{"group":"Advanced joins","pages":[{"title":"List advanced joins","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"},{"title":"Retrieve estimate quality status","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"},{"title":"List 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"},{"title":"Retrieve mapped percentage status","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"},{"title":"Retrieve advanced join run status","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"},{"title":"Retrieve suggested improvements","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"},{"title":"Create advanced joins","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"},{"title":"Delete advanced joins","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"},{"title":"Estimate contextualization quality","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"},{"title":"Create 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"},{"title":"Delete 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"},{"title":"Measure mapped percentages","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"},{"title":"Run an advanced join","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"},{"title":"Suggest improvements","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"},{"title":"Update advanced joins","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"}]}]},{"group":"Data lifecycle","icon":"git-branch","expanded":true,"pages":[{"group":"Data ingestion","pages":[{"title":"Data ingestion","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/data-ingestion"},{"group":"Raw","pages":[{"title":"Raw","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/raw"},{"title":"Create databases","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"},{"title":"Delete databases","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"},{"title":"Create tables in a database","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"},{"title":"Delete tables in a database","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"},{"title":"Insert rows into a table","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"},{"title":"Delete rows in a table","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"},{"title":"List databases","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"},{"title":"List tables in a database","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"},{"title":"Retrieve cursors for parallel reads","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"},{"title":"Retrieve rows from a table","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"},{"title":"Retrieve row by key","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"}]},{"group":"Extraction pipelines","pages":[{"title":"Extraction Pipelines","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/extraction-pipelines"},{"title":"Create extraction pipelines","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"},{"title":"Delete extraction pipelines","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"},{"title":"Filter 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"},{"title":"Retrieve an extraction pipeline by its ID.","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"},{"title":"Retrieve extraction pipelines","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"},{"title":"Update extraction pipelines","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"}]},{"group":"Extraction pipelines runs","pages":[{"title":"Extraction Pipelines Runs","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/extraction-pipelines-runs"},{"title":"Create extraction pipeline runs","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"},{"title":"Filter extraction pipeline runs","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"}]},{"group":"Extraction pipelines config","pages":[{"title":"Extraction Pipelines Config","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/extraction-pipelines-config"},{"title":"Create extraction configuration revision","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"},{"title":"Get a single configuration revision","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"},{"title":"List configuration revisions","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"},{"title":"Revert configuration 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"}]},{"group":"Extractors","pages":[{"title":"Extractors","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/extractors"},{"title":"List 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"},{"title":"Retrieve Extractors","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"},{"title":"List releases","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"},{"title":"Retrieve Releases","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"},{"title":"List Source Systems","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"},{"title":"Retrieve Source Systems","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"},{"title":"List Solutions","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"},{"title":"Retrieve Solutions","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"},{"title":"Get Config Schema","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"}]},{"group":"Hosted extractors","pages":[{"title":"Hosted extractors","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/hosted-extractors"},{"group":"Sources","pages":[{"title":"Sources","sidebarTitle":"Sources","href":"/api-reference/concepts/20230101-alpha/hosted-extractors-sources"},{"title":"Create 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"},{"title":"Delete Sources","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"},{"title":"List Sources","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"},{"title":"Retrieve Sources","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"},{"title":"Update 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"}]},{"group":"Jobs","pages":[{"title":"Jobs","sidebarTitle":"Jobs","href":"/api-reference/concepts/20230101-alpha/hosted-extractors-jobs"},{"title":"Create 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"},{"title":"Delete Jobs","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"},{"title":"Get Job Logs","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"},{"title":"Get Job DLQ Messages","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"},{"title":"Get Job Metrics","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"},{"title":"Retrieve Jobs","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"},{"title":"Update Jobs","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"}]},{"group":"Destinations","pages":[{"title":"Destinations","sidebarTitle":"Destinations","href":"/api-reference/concepts/20230101-alpha/hosted-extractors-destinations"},{"title":"Create 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"},{"title":"Delete Destinations","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"},{"title":"Retrieve Destinations","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"},{"title":"Update 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"}]},{"group":"Mappings","pages":[{"title":"Mappings","sidebarTitle":"Mappings","href":"/api-reference/concepts/20230101-alpha/hosted-extractors-mappings"},{"title":"Create 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"},{"title":"Delete Mappings","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"},{"title":"Retrieve Mappings","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"},{"title":"Update 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"}]},{"group":"Previews","pages":[{"title":"Create Preview","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"},{"title":"Download preview result","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"},{"title":"Get preview result","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"}]}]}]},{"group":"Data organization","pages":[{"title":"Data organization","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/data-organization"},{"group":"Data products","pages":[{"title":"Data products","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/data-products"},{"title":"Create a data product","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"},{"title":"List data products","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"},{"title":"Get a data product","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"},{"title":"Delete a data product","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"},{"title":"Update a data product","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"},{"title":"Get data products","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"},{"title":"Create a data product version","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"},{"title":"List data product versions","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"},{"title":"Get a data product 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"},{"title":"Delete data product versions","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"},{"title":"Update data product version","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"}]}]},{"group":"Transformations","pages":[{"title":"Transformations","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/transformations-overview"},{"group":"Transformations","pages":[{"title":"Transformations","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/transformations"},{"title":"Create transformations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /transformations","href":"/20230101-alpha/transformations/create-transformations"},{"title":"Cancel a transformation","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"},{"title":"Delete transformations","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"},{"title":"Filter transformations","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"},{"title":"Retrieve transformations","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"},{"title":"Run a transformation","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"},{"title":"Update transformations","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"}]},{"group":"Transformation jobs","pages":[{"title":"Transformation Jobs","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/transformation-jobs"},{"title":"List jobs","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"},{"title":"Retrieve jobs by ids","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"},{"title":"List job metrics by job id","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"}]},{"group":"Transformation schedules","pages":[{"title":"Transformation Schedules","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/transformation-schedules"},{"title":"List all schedules","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"},{"title":"Schedule transformations","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"},{"title":"Retrieve schedules","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"},{"title":"Unschedule transformations","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"},{"title":"Update schedules","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"}]},{"group":"Transformation notifications","pages":[{"title":"Transformation Notifications","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/transformation-notifications"},{"title":"Subscribe for notifications","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"},{"title":"Delete notification subscriptions by notification ID","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"}]},{"group":"Query","pages":[{"title":"Query","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/transformation-query"},{"title":"Run 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"}]},{"group":"Schema","pages":[{"title":"Schema","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/transformation-schema"},{"title":"Get 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"},{"title":"Get the schema of a sequence","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"},{"title":"Get the schema of resource type","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"}]},{"group":"External data sources","pages":[{"title":"Transformation external data sources","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/transformation-external-data"},{"title":"List external data sources","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"},{"title":"Create external data sources","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"},{"title":"Retrieve external data sources by external ids","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"},{"title":"Delete external data sources","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"},{"title":"Rotate external data source 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"},{"title":"Verify external data source usability","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"}]}]}]},{"group":"Documents","icon":"file-text","expanded":true,"pages":[{"group":"Documents","pages":[{"title":"Documents","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/documents-overview"},{"group":"Documents","pages":[{"title":"Documents","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/documents"},{"title":"Aggregate","href":"/api-reference/concepts/20230101-alpha/aggregate"},{"title":"Search","href":"/api-reference/concepts/20230101-alpha/search"},{"title":"Passages search","href":"/api-reference/concepts/20230101-alpha/passages-search"},{"title":"Aggregate documents","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"},{"title":"List documents","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"},{"title":"Document status","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"},{"title":"Retrieve document 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"},{"title":"Retrieve parsed document content","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"},{"title":"Search for documents","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"},{"title":"Semantic search for passages","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"}]},{"group":"Document preview","pages":[{"title":"Document preview","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/document-preview"},{"title":"Retrieve a image preview of a page from a document","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /documents/{documentId}/preview/image/pages/{pageNumber}","href":"/20230101-alpha/document-preview/retrieve-a-image-preview-of-a-page-from-a-document"},{"title":"Retrieve a PDF preview of a document","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /documents/{documentId}/preview/pdf","href":"/20230101-alpha/document-preview/retrieve-a-pdf-preview-of-a-document"},{"title":"Retrieve a temporary link to a PDF preview of a document","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /documents/{documentId}/preview/pdf/temporarylink","href":"/20230101-alpha/document-preview/retrieve-a-temporary-link-to-a-pdf-preview-of-a-document"}]}]}]},{"group":"Integrations","icon":"layers","expanded":true,"pages":[{"title":"Integrations","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/integrations-overview"},{"group":"Integrations","pages":[{"title":"Integrations resource","sidebarTitle":"Integrations","href":"/api-reference/concepts/20230101-alpha/integrations"},{"title":"List Integrations","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /integrations","href":"/20230101-alpha/integrations/list-integrations"},{"title":"Create 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"},{"title":"Retrieve Integrations","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"},{"title":"Delete Integrations","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"},{"title":"Update 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"},{"title":"Report Extractor Info","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"},{"title":"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"}]},{"group":"Tasks","pages":[{"title":"Tasks","sidebarTitle":"Tasks","href":"/api-reference/concepts/20230101-alpha/integrations-tasks"},{"title":"Get Task History","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"},{"title":"Sync Integration History","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"}]},{"group":"Actions","pages":[{"title":"Actions","sidebarTitle":"Actions","href":"/api-reference/concepts/20230101-alpha/integrations-actions"},{"title":"Create Actions","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"},{"title":"List Actions","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"},{"title":"Retrieve Actions","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"},{"title":"Cancel Actions","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"}]},{"group":"Configuration","pages":[{"title":"Configuration","sidebarTitle":"Configuration","href":"/api-reference/concepts/20230101-alpha/integrations-config"},{"title":"Create config revision.","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"},{"title":"Fetch 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"},{"title":"List config revisions","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"}]},{"group":"Errors","pages":[{"title":"Errors","sidebarTitle":"Errors","href":"/api-reference/concepts/20230101-alpha/integrations-errors"},{"title":"List Errors","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"}]}]},{"group":"Signals","icon":"radio","pages":[{"title":"Signals","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/signals"},{"group":"Signal sinks","pages":[{"title":"Create sinks","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"},{"title":"List sinks","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"},{"title":"Retrieve sinks by external IDs","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"},{"title":"Update sinks","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"},{"title":"Delete sinks","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"}]},{"group":"Signal subscriptions","pages":[{"title":"Create subscriptions","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"},{"title":"Filter subscriptions","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"},{"title":"Update subscriptions","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"},{"title":"Delete subscriptions","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"}]},{"group":"List signals","pages":[{"title":"List signals.","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"}]},{"group":"Sync signals","pages":[{"title":"Sync signals","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"}]},{"group":"Signal topics","pages":[{"title":"List topics","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"}]}]},{"group":"Workflows","icon":"workflow","pages":[{"title":"Workflows","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/workflows-overview"},{"group":"Workflows","pages":[{"title":"Workflows","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/workflows"},{"title":"Create or update a workflow","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"},{"title":"Delete workflows","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"},{"title":"Retrieve a workflow","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"}]},{"group":"Workflow versions","pages":[{"title":"Workflow versions","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/workflow-versions"},{"title":"Create or update a workflow version","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"},{"title":"Filter workflow versions","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"},{"title":"Retrieve a workflow version","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"},{"title":"Delete workflow versions","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"}]},{"group":"Workflow executions","pages":[{"title":"Workflow executions","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/workflow-executions"},{"title":"Run 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"},{"title":"Filter workflow executions","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"},{"title":"Retrieve workflow execution details","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"},{"title":"Cancel a workflow execution","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"},{"title":"Retry workflow execution","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"}]},{"group":"Workflow triggers","pages":[{"title":"Workflow triggers","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/workflow-triggers"},{"title":"Create or update triggers","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"},{"title":"Delete triggers","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"},{"title":"Get the run history of a trigger","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"},{"title":"Pause a trigger","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"},{"title":"Resume a trigger","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"}]},{"group":"Tasks","pages":[{"title":"Tasks","sidebarTitle":"Tasks","href":"/api-reference/concepts/20230101-alpha/workflow-tasks"},{"title":"Update task status","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"}]}]},{"group":"Specialized","icon":"sparkles","expanded":true,"pages":[{"group":"Simulators","pages":[{"title":"Simulators","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/simulators-overview"},{"group":"Simulators","pages":[{"title":"Simulators","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/simulators"},{"title":"Filter 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"}]},{"group":"Simulator integrations","pages":[{"title":"Simulator Integrations","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/simulator-integrations"},{"title":"Delete Simulator Integrations","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"},{"title":"Filter Simulator Integrations","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"}]},{"group":"Simulator models","pages":[{"title":"Simulator Models","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/simulator-models"},{"title":"Create 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"},{"title":"Filter Simulator Models","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"},{"title":"Aggregate Simulator Models","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"},{"title":"Delete Simulator Model","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"},{"title":"Update 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"},{"title":"Retrieve Simulator Model","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"},{"title":"Create 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"},{"title":"Filter Simulator Model Revisions","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"},{"title":"Retrieve Simulator Model Revisions","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"},{"title":"Retrieve Simulator Model Revision Data","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"}]},{"group":"Simulator routines","pages":[{"title":"Simulator Routines","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/simulator-routines"},{"title":"Create 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"},{"title":"Filter Simulator Routines","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"},{"title":"Delete Simulator Routine","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"},{"title":"Aggregate Simulator Routines","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"},{"title":"Create Simulator Routine Revision","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"},{"title":"Filter Simulator Routine Revisions","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"},{"title":"Retrieve Simulator Routine Revisions","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"}]},{"group":"Simulation runs","pages":[{"title":"Simulation Runs","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/simulation-runs"},{"title":"Run Simulation","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"},{"title":"Filter Simulation Runs","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"},{"title":"Retrieve Simulation","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"},{"title":"Retrieve Simulation Data","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"}]},{"group":"Simulator logs","pages":[{"title":"Simulator Logs","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/simulator-logs"},{"title":"Retrieve Simulator Logs","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"}]}]},{"group":"Units","pages":[{"title":"Units","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/units-overview"},{"group":"Units","pages":[{"title":"Units","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/units"},{"title":"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"},{"title":"Retrieve unit by 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"},{"title":"Retrieve units by external IDs","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"}]},{"group":"Unit systems","pages":[{"title":"Unit Systems","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/unit-systems"},{"title":"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"}]}]}]},{"group":"Legacy","icon":"archive","expanded":true,"pages":[{"group":"Legacy data modeling","pages":[{"title":"Asset-centric data modeling (legacy)","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/asset-centric"},{"group":"Assets","pages":[{"title":"Assets","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/assets"},{"title":"Aggregate assets","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"},{"title":"Create 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"},{"title":"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"},{"title":"Filter assets","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"},{"title":"List assets","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /assets","href":"/20230101-alpha/assets/list-assets"},{"title":"Retrieve an asset by its ID","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"},{"title":"Retrieve 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"},{"title":"Search assets","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"},{"title":"Update assets","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"}]},{"group":"Time series metadata","pages":[{"title":"Time series","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/time-series"},{"title":"Aggregate time series","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"},{"title":"Create 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"},{"title":"Delete time series","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"},{"title":"Filter time series","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"},{"title":"List time series","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"},{"title":"Retrieve time series","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"},{"title":"Search time series","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"},{"title":"Update 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"}]},{"group":"Events","pages":[{"title":"Events","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/events"},{"title":"Aggregate events","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"},{"title":"Create 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"},{"title":"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"},{"title":"Filter events","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"},{"title":"List events","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /events","href":"/20230101-alpha/events/list-events"},{"title":"Receive an event by its ID","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"},{"title":"Retrieve 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"},{"title":"Search events","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"},{"title":"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"}]},{"group":"File metadata","pages":[{"title":"Files","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/files"},{"title":"Aggregate 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"},{"title":"Upload file","deprecated":null,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /files","href":"/20230101-alpha/files/upload-file"},{"title":"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"},{"title":"Filter 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"},{"title":"List 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"},{"title":"Retrieve a file by its ID","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"},{"title":"Retrieve 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"},{"title":"Search files","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"},{"title":"Update files","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"}]},{"group":"Sequences","pages":[{"title":"Sequences","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/sequences"},{"title":"Aggregate sequences","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"},{"title":"Create 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"},{"title":"Delete rows","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"},{"title":"Delete sequences","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"},{"title":"Filter sequences","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"},{"title":"Insert rows","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"},{"title":"List sequences","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /sequences","href":"/20230101-alpha/sequences/list-sequences"},{"title":"Retrieve last row","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"},{"title":"Retrieve rows","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"},{"title":"Retrieve sequences","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"},{"title":"Search sequences","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"},{"title":"Update sequences","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"}]},{"group":"Data sets","pages":[{"title":"Data sets","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/data-sets"},{"title":"Create data sets","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"},{"title":"Aggregate 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"},{"title":"Filter 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"},{"title":"Retrieve data sets","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"},{"title":"Update data sets.","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"}]},{"group":"Labels","pages":[{"title":"Labels","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/labels"},{"title":"Create label definitions.","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"},{"title":"Filter labels","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"},{"title":"Retrieve labels","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"},{"title":"Delete label definitions.","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"}]},{"group":"Relationships","pages":[{"title":"Relationships","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/relationships"},{"title":"Create relationships","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /relationships","href":"/20230101-alpha/relationships/create-relationships"},{"title":"Delete relationships","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"},{"title":"Filter relationships","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"},{"title":"List relationships","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json get /relationships","href":"/20230101-alpha/relationships/list-relationships"},{"title":"Retrieve relationships","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"},{"title":"Update relationships","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"}]},{"group":"Annotations","pages":[{"title":"Annotations","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/annotations"},{"title":"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"},{"title":"Suggest 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"},{"title":"Get an annotation","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"},{"title":"Filter annotations","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"},{"title":"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"},{"title":"Retrieve annotations","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"},{"title":"Delete annotations","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"},{"title":"Update annotations","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"}]},{"group":"Geospatial","pages":[{"title":"Geospatial","sidebarTitle":"Overview","href":"/api-reference/concepts/20230101-alpha/geospatial"},{"title":"Aggregate features","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"},{"title":"Compute","deprecated":true,"version":null,"openapi":"https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-alpha.json post /geospatial/compute","href":"/20230101-alpha/geospatial/compute"},{"title":"Create 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"},{"title":"Create 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"},{"title":"Create 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"},{"title":"Delete 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"},{"title":"Delete 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"},{"title":"Delete 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"},{"title":"Delete a raster from a feature property","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"},{"title":"Get Coordinate Reference Systems","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"},{"title":"Get features","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"},{"title":"List 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"},{"title":"Put a raster into a feature property","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"},{"title":"Get a raster from a feature property","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"},{"title":"Retrieve feature types","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"},{"title":"Retrieve features","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"},{"title":"Search and stream features","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"},{"title":"Search features","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"},{"title":"Update 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"},{"title":"Update features","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"},{"title":"Filter all features","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"}]}]}]}]}]}]},{"tab":"CogDocs","hidden":true,"searchable":false,"pages":[{"title":"CogDocs","href":"/cogdocs/concepts/platform-overview"}]}]},{"language":"de","pages":[{"title":"de","href":"/de"}]},{"language":"es","pages":[{"title":"es","href":"/es"}]},{"language":"fr","pages":[{"title":"fr","href":"/fr"}]},{"language":"ko","pages":[{"title":"ko","href":"/ko"}]},{"language":"it","pages":[{"title":"it","href":"/it"}]},{"language":"lv","pages":[{"title":"lv","href":"/lv"}]},{"language":"nl","pages":[{"title":"nl","href":"/nl"}]},{"language":"ja","pages":[{"title":"ja","href":"/ja"}]},{"language":"no","pages":[{"title":"no","href":"/no"}]},{"language":"pt","pages":[{"title":"pt","href":"/pt"}]},{"language":"ro","pages":[{"title":"ro","href":"/ro"}]},{"language":"sv","pages":[{"title":"sv","href":"/sv"}]},{"language":"zh","pages":[{"title":"zh","href":"/zh"}]}]},"basePath":"","title":"Retrieve multiple pipelines - Cognite Docs","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["10e4515597","c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["BannerMarkdown-6DXXLlfN.js","dist-CmKHfscc.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-C3kuh_dz.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-D6S0Yh6q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","AssistantPageLink-U3mI6Ljh.js"]}