{ "opencollection": "1.0.0", "info": { "name": "Cognite 3D Asset Mapping Assets API", "version": "v1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Assets", "type": "folder" }, "items": [ { "info": { "name": "List assets", "type": "http" }, "http": { "method": "GET", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/assets", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Limits the number of results to be returned. The maximum results returned by the server is 1000 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": "includeMetadata", "value": "", "type": "query", "description": "Whether the metadata field should be returned or not." }, { "name": "name", "value": "", "type": "query" }, { "name": "parentIds", "value": "[363848954441724, 793045462540095, 1261042166839739]", "type": "query", "description": "List only assets that have one of the parentIds as a parent. The parentId for root assets is null." }, { "name": "parentExternalIds", "value": "[externalId_1, externalId_2, externalId_3]", "type": "query", "description": "List only assets that have one of the parentExternalIds as a parent. The parentId for root assets is null." }, { "name": "rootIds", "value": "[363848954441724, 793045462540095, 1261042166839739]", "type": "query", "description": "This parameter is deprecated. Use assetSubtreeIds instead. List only assets that have one of the rootIds as a root asset. A root asset is its own root asset." }, { "name": "assetSubtreeIds", "value": "[363848954441724, 793045462540095, 1261042166839739]", "type": "query", "description": "List only assets that are in a subtree rooted at any of these assetIds (including the roots given). If the total size of the given subtrees exceeds 100,000 assets, an error will be returned." }, { "name": "assetSubtreeExternalIds", "value": "[externalId_1, externalId_2, externalId_3]", "type": "query", "description": "List only assets that are in a subtree rooted at any of these assetExternalIds. If the total size of the given subtrees exceeds 100,000 assets, an error will be returned." }, { "name": "source", "value": "", "type": "query" }, { "name": "root", "value": "", "type": "query" }, { "name": "minCreatedTime", "value": "", "type": "query" }, { "name": "maxCreatedTime", "value": "", "type": "query" }, { "name": "minLastUpdatedTime", "value": "", "type": "query" }, { "name": "maxLastUpdatedTime", "value": "", "type": "query" }, { "name": "externalIdPrefix", "value": "", "type": "query" }, { "name": "partition", "value": "", "type": "query", "description": "Splits the data set into `N` partitions.\nThe attribute is specified as a \"M/N\" string, where `M` is a natural number in the interval of `[1, N]`.\nYou need to follow the cursors within each partition in order to receive all the data.\n\nThe maximum number of allowed partitions (`N`) is 10.\n\nCognite rejects requests if you specify more than 10 partitions.\nWhen Cognite enforces this behavior, the requests result in a 400 Bad Request status.\n" } ] }, "docs": "\n\n> **Required capabilities:** `assetsAcl:READ`\n\nList all assets, or only the assets matching the specified query.\n\n### Request throttling\nThis endpoint is meant for data analytics/exploration usage and is not suitable for high load data retrieval usage.\nIt is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Assets resource description](../../) for more information." }, { "info": { "name": "Create assets", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/assets", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `assetsAcl:WRITE`\n\nCreate multiple asset objects in the same project.\nIt is possible to create a maximum of 1000 assets per request.\n\n### Request throttling\nThis endpoint is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Assets resource description](../../) for more information." }, { "info": { "name": "Retrieve an asset by its ID", "type": "http" }, "http": { "method": "GET", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/assets/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "\n\n> **Required capabilities:** `assetsAcl:READ`\n\nRetrieve an asset by its internal ID. If you want to retrieve assets by externalIds, use Retrieve assets instead.\n\n### Request throttling\nThis endpoint is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Assets resource description](../../) for more information." }, { "info": { "name": "Filter assets", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/assets/list", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `assetsAcl:READ`\n\nRetrieve a list of assets in the same project. This operation supports pagination by cursor.\nApply Filtering and Advanced filtering criteria to select a subset of assets.\n\n### Advanced filtering\nAdvanced filter lets you create complex filtering expressions that combine simple operations,\nsuch as `equals`, `prefix`, `exists`, etc., using boolean operators `and`, `or`, and `not`.\nIt applies to basic fields as well as metadata.\n\nSee the `advancedFilt" }, { "info": { "name": "Aggregate assets", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/assets/aggregate", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `assetsAcl:READ`\n\nThe aggregation API lets you compute aggregated results on assets,\nsuch as getting the count of all assets in a project, checking\ndifferent names and descriptions of assets in your project, etc.\n\n#### Aggregate filtering\n##### Filter (filter & advancedFilter) data for aggregates\nFilters behave the same way as for the `Filter assets` endpoint.\nIn text properties, the values are aggregated in a case-insensitive manner.\n\n##### aggregateFilter to filt" }, { "info": { "name": "Retrieve assets", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/assets/byids", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `assetsAcl:READ`\n\nRetrieve assets by IDs or external IDs.\nIf you specify to get aggregates, then be aware that the aggregates are eventually consistent.\n\n### Request throttling\nThis endpoint is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Assets resource description](../../) for more information." }, { "info": { "name": "Update assets", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/assets/update", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `assetsAcl:WRITE`\n\nUpdate the attributes of assets.\n\n### Request throttling\nThis endpoint is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Assets resource description](../../) for more information." }, { "info": { "name": "Search assets", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/assets/search", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `assetsAcl:READ`\n\nFulltext search for assets based on result relevance. Primarily meant\nfor human-centric use-cases, not for programs, since matching and\nordering may change over time. Additional filters can also be\nspecified. This operation doesn't support pagination.\n\n### Request throttling\nThis endpoint is meant for data analytics/exploration usage and is not suitable for high load data retrieval usage.\nIt is a subject of the new throttling schema (limited reque" }, { "info": { "name": "Delete assets", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/assets/delete", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `assetsAcl:WRITE`\n\nDelete assets. By default, `recursive=false` and the request would fail if attempting to delete assets that are referenced as parent by other assets.\nTo delete such assets and all its descendants, set recursive to true.\nThe limit of the request does not include the number of descendants that are deleted.\n\n### Request throttling\nThis endpoint is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Assets res" } ] } ], "bundled": true }