{ "opencollection": "1.0.0", "info": { "name": "Cognite 3D Asset Mapping Sequences API", "version": "v1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Sequences", "type": "folder" }, "items": [ { "info": { "name": "List sequences", "type": "http" }, "http": { "method": "GET", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences", "params": [ { "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": "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\nTo prevent unexpected problems and maximize read throughput, you should at most use 10 (N <= 10) partitions.\n\nWhen using more than 10 partitions, CDF may reduce the number of partitions silently.\nFor example, CDF may reduce the number of partitions to `K = 10` so if you specify an `X/N` `partition` value where `X = 8` and `N = 20` - i.e. `\"partition\": \"8/20\"`- then\nCDF will change `N` to `N = K = 10` and process the request.\nBut if you specify the `X/N` `partition` value where `X = 11` (`X > K`) and `N = 20` - i.e. `\"partition\": \"11/20\"`- then\nCDF will reply with an empty result list and no cursor in the response.\n\nIn future releases of the resource APIs, Cognite may reject requests if you specify more than 10 partitions.\nWhen Cognite enforces this behavior, the requests will result in a 400 Bad Request status.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limits the number of results to be returned. The server returns a maximum of 1000 results even if you specify a higher limit." } ] }, "docs": "\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nList sequences. Use `nextCursor` to paginate through the results." }, { "info": { "name": "Create sequences", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nCreate one or more sequences." }, { "info": { "name": "Filter sequences", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/list", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `sequencesAcl:READ`\n\n
\n\nRetrieves a list of sequences that match the given criteria.\n\n\n### Advanced filtering\n\nThe `advancedFilter`\nfield lets you create complex filtering expressions that combine simple operations,\nsuch as `equals`, `prefix`, and `exists`, by using the Boolean operators `and`, `or`, and `not`.\nFiltering applies to basic fields as well as metadata. See the `advancedFilter` syntax in the request example.\n\n\n\n#### Supported " }, { "info": { "name": "Aggregate sequences", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/aggregate", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nThe aggregation API allows you to compute aggregated results from a set of sequences, such as\r\ngetting the number of sequences in a project or checking what assets the different sequences\r\nin your project are associated with (along with the number of sequences for each asset).\r\nBy specifying `filter` and/or `advancedFilter`, the aggregation will take place only over those\r\nsequences that match the filters. `filter` and `advancedFilter` behave t" }, { "info": { "name": "Retrieve sequences", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/byids", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nRetrieves one or more sequences by ID or external ID. The response returns the sequences in the same order as in the request." }, { "info": { "name": "Search sequences", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/search", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nRetrieves a list of sequences matching the given criteria. This operation doesn't support pagination." }, { "info": { "name": "Update sequences", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/update", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nUpdates one or more sequences. Fields outside of the request remain unchanged." }, { "info": { "name": "Delete sequences", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/delete", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nDeletes the sequences with the specified IDs. If one or more of the sequences do not exist, the `ignoreUnknownIds` parameter controls what will happen: if it is `true`, the sequences that do exist will be deleted, and the request succeeds; if it is `false` or absent, nothing will be deleted, and the request fails." }, { "info": { "name": "Insert rows", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/data", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nInserts rows into a sequence. This overwrites data in rows and columns that exist." }, { "info": { "name": "Retrieve rows", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/data/list", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nProcesses data requests and returns the result. Note that this operation uses a dynamic limit on the number of rows returned based on the number and type of columns; use the provided cursor to paginate and retrieve all data." }, { "info": { "name": "Retrieve last row", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/data/latest", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `sequencesAcl:READ`\n\nRetrieves the last row in one or more sequences. Note that the last row in a sequence is the\none with the highest row number, which is not necessarily the one that was ingested most\nrecently.\n" }, { "info": { "name": "Delete rows", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/sequences/data/delete", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `sequencesAcl:WRITE`\n\nDeletes the given rows of the sequence. All columns are affected." } ] } ], "bundled": true }