{ "opencollection": "1.0.0", "info": { "name": "Cognite 3D Asset Mapping Events API", "version": "v1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Events", "type": "folder" }, "items": [ { "info": { "name": "List events", "type": "http" }, "http": { "method": "GET", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/events", "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": "minStartTime", "value": "", "type": "query" }, { "name": "maxStartTime", "value": "", "type": "query" }, { "name": "minEndTime", "value": "", "type": "query" }, { "name": "maxEndTime", "value": "", "type": "query" }, { "name": "minActiveAtTime", "value": "", "type": "query" }, { "name": "maxActiveAtTime", "value": "", "type": "query" }, { "name": "assetIds", "value": "[363848954441724, 793045462540095, 1261042166839739]", "type": "query", "description": "Asset IDs of equipment that this event relates to. Format is list of IDs serialized as JSON array(int64). Takes [ 1 .. 100 ] of unique items." }, { "name": "assetExternalIds", "value": "[\"externalId1\", \"externalId2\", \"externalId3\"]", "type": "query", "description": "Asset external IDs of equipment that this event relates to. Takes 1..100 unique items." }, { "name": "assetSubtreeIds", "value": "[363848954441724, 793045462540095, 1261042166839739]", "type": "query", "description": "Only include events that have a related asset 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": "[\"externalId1\", \"externalId2\", \"externalId3\"]", "type": "query", "description": "Only include events that have a related asset in a subtree rooted at any of these assetExternalIds (including the roots given). If the total size of the given subtrees exceeds 100,000 assets, an error will be returned." }, { "name": "source", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "subtype", "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" }, { "name": "includeMetadata", "value": "", "type": "query", "description": "Whether the metadata field should be returned or not." }, { "name": "sort", "value": "endTime:desc", "type": "query", "description": "Sort by an array of the selected fields. Syntax: `[\":asc|desc\"]`. Default sort order is `asc` with short syntax: `[\"\"]`.\nFilter accepts the following field names:\n `dataSetId`,\n `externalId`,\n `type`,\n `subtype`,\n `startTime`,\n `endTime`,\n `createdTime`,\n `lastUpdatedTime`,\n `source`,\n `description`,\n `metadata`.\nPartitions are done independently of sorting, there's no guarantee on sort order between elements from different partitions.\n" } ] }, "docs": "\n\n> **Required capabilities:** `eventsAcl:READ`\n\nList events optionally filtered on query parameters\n\n### Request throttling\nThis endpoint is meant for data analytics/exploration usage and is not suitable for high load data retrieval usage.\nIt is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Events resource description](../../) for more information." }, { "info": { "name": "Create events", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/events", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `eventsAcl:WRITE`\n\nCreates multiple event objects in the same project.\nIt is possible to post a maximum of 1000 events per request.\n\n### Request throttling\nThis endpoint is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Events resource description](../../) for more information." }, { "info": { "name": "Receive an event by its ID", "type": "http" }, "http": { "method": "GET", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/events/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "\n\n> **Required capabilities:** `eventsAcl:READ`\n\nRetrieves an event by its internal (service-generated) ID.\n\n### Request throttling\nThis endpoint is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Events resource description](../../) for more information." }, { "info": { "name": "Filter events", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/events/list", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `eventsAcl:READ`\n\nRetrieve a list of events in the same project. This operation supports pagination by cursor.\nApply Filtering and Advanced filtering criteria to select a subset of events.\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 events", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/events/aggregate", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `eventsAcl:READ`\n\nThe aggregation API lets you compute aggregated results on events,\nsuch as getting the count of all Events in a project, checking\ndifferent descriptions of events in your project, etc.\n\n#### Aggregate filtering\n##### Filter (filter & advancedFilter) data for aggregates\nFilters behave the same way as for the `Filter events` endpoint.\nIn text properties, the values are aggregated in a case-insensitive manner.\n\n##### aggregateFilter to filter aggrega" }, { "info": { "name": "Retrieve events", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/events/byids", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `eventsAcl:READ`\n\nRetrieves information about events in the same project. Events\nare returned in the same order as the ids listed in the query.\n\nA maximum of 1000 event IDs may be listed per request and all of them\nmust be unique.\n\n### Request throttling\nThis endpoint is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Events resource description](../../) for more information." }, { "info": { "name": "Update events", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/events/update", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `eventsAcl:WRITE`\n\nUpdates events in the same project. This operation supports\npartial updates; Fields omitted from queries will remain unchanged on\nobjects.\n\nFor primitive fields (String, Long, Int), use 'set': 'value' to update\nvalue; use 'setNull': true to set that field to null.\n\nFor the Json Array field (e.g. assetIds), use 'set': [value1, value2] to\nupdate value; use 'add': [v1, v2] to add values to current list of\nvalues; use 'remove': [v1, v2] to remove the" }, { "info": { "name": "Search events", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/events/search", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `eventsAcl:READ`\n\nFulltext search for events 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 events", "type": "http" }, "http": { "method": "POST", "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/events/delete", "body": { "type": "json", "data": "{}" } }, "docs": "\n\n> **Required capabilities:** `eventsAcl:WRITE`\n\nDeletes events with the given ids.\nA maximum of 1000 events can be deleted per request.\n\n### Request throttling\nThis endpoint is a subject of the new throttling schema (limited request rate and concurrency).\nPlease check [Events resource description](../../) for more information." } ] } ], "bundled": true }