{ "opencollection": "1.0.0", "info": { "name": "Cognite 3D Asset Mapping Containers API", "version": "v1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Containers", "type": "folder" }, "items": [ { "info": { "name": "List containers defined in the project", "type": "http" }, "http": { "method": "GET", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results returned. The largest result-set returned by the server will be 1000 items, even if you specify a higher limit." }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor for paging through results. In general, if a response contains a `nextCursor`\nproperty, it means that there may be more results, and you should pass that value as the\n`cursor` parameter in the next request.\n\nNote that the cursor may or may not be encrypted, but either way, it is not intended to be\ndecoded. Its internal structure is not a part of the public API, and may change without\nnotice. You should treat it as an opaque string and not attempt to craft your own cursors.\n" }, { "name": "space", "value": "", "type": "query", "description": "The space to query." }, { "name": "includeGlobal", "value": "", "type": "query", "description": "If the global items of the entity should be returned. Defaults to false which excludes global items." }, { "name": "usedFor", "value": "", "type": "query", "description": "Only include containers that have been marked as used for the specified purposes. Defaults to [node, edge, all]" } ] }, "docs": "\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nList of containers defined in the current project. You can filter the list by specifying a space." }, { "info": { "name": "Create or update containers", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nAdd or update (upsert) containers. For unchanged container specifications, the operation completes without making any changes. We will not update the ```lastUpdatedTime``` value for containers that remain unchanged." }, { "info": { "name": "Retrieve containers by their external ids", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers/byids", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `dataModelsAcl:READ`\n\nRetrieve up to 100 containers by their specified external ids." }, { "info": { "name": "Delete containers", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers/delete", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more containers. Currently limited to 100 containers at a time." }, { "info": { "name": "Delete indexes from containers", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers/indexes/delete", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more container indexes. Currently limited to 10 indexes at a time." }, { "info": { "name": "Retry failed indexes", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers/indexes/retry", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nTriggers a retry of the given failed container indexes. This will usually entail scanning through all the data in the container, so use this sparingly. There are strict limits as to how often a given index can be retried, and how many schema entities can be in a retrying state simultaneously." }, { "info": { "name": "Delete constraints from containers", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers/constraints/delete", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nDelete one or more container constraints. Currently limited to 10 constraints at a time." }, { "info": { "name": "Retry failed container constraints", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers/constraints/retry", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nTriggers a revalidation of the given failed container constraints. This will usually entail scanning through all the data in the container, so use this sparingly. There are strict limits as to how often a given constraint can be revalidated, and how many schema entities can be in a retrying state simultaneously." }, { "info": { "name": "Retry failed property constraints", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers/properties/retry", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `dataModelsAcl:WRITE`\n\nTriggers a revalidation of failed constraints on the given properties. This includes `nullable`, `maxListSize` and `maxTextSize`. Revalidation usually entails scanning through all the data in the container, so use this sparingly. There are strict limits as to how often a given property can be revalidated, and how many schema entities can be in a retrying simultaneously." }, { "info": { "name": "Inspect containers", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/models/containers/inspect", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `dataModelsAcl:READ`\n" } ] } ], "bundled": true }