{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cognite 3D Asset Mapping Records API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Records",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Ingest records into a stream",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/:streamId/records",
            "params": [
              {
                "name": "streamId",
                "value": "",
                "type": "path",
                "description": "An identifier of the stream where the records are stored.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `streamRecordsAcl:WRITE` `dataModelsAcl:READ`\n\nBefore a user can add records, all referenced schema elements (Spaces, Containers, Properties) must be defined/created in [Data Modeling](https://docs.cognite.com/cdf/dm)\n\nTo add records, the user must have capabilities to access (read) the referenced containers as well as capabilities to access (write) the referenced record ```space```.\n\nBatches of records are ingested into a ```stream```.\n\nUnder normal ingestion oper"
        },
        {
          "info": {
            "name": "Upsert (create or update) records into a stream",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/:streamId/records/upsert",
            "params": [
              {
                "name": "streamId",
                "value": "",
                "type": "path",
                "description": "An identifier of the stream where the records are stored.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `streamRecordsAcl:WRITE` `dataModelsAcl:READ`\n\n**Note:** This endpoint is only available for mutable streams.\n\nBefore a user can upsert records, all referenced schema elements (Spaces, Containers, Properties) must be defined/created in [Data Modeling](https://docs.cognite.com/cdf/dm).\n\nTo upsert records, the user must have capabilities to access (read) the referenced containers as well as capabilities to access (write) the referenced record ```space```.\n\nBatches of"
        },
        {
          "info": {
            "name": "Delete records from a stream",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/:streamId/records/delete",
            "params": [
              {
                "name": "streamId",
                "value": "",
                "type": "path",
                "description": "An identifier of the stream where the records are stored.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `streamRecordsAcl:WRITE`\n\n**Note:** This endpoint is only available for mutable streams.\n\nTo delete records, the user must have capabilities to access (write to) the referenced record ```space```.\n\nBatches of records are deleted from a ```stream``` with implicit `ignoreUnknownIds=true` semantic.\n\nThe record operations are eventually consistent,\nbut under normal conditions deleted records stop being returned by other endpoints within a few seconds.\nSync endpoint is "
        },
        {
          "info": {
            "name": "Retrieve records from a stream",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/:streamId/records/filter",
            "params": [
              {
                "name": "streamId",
                "value": "",
                "type": "path",
                "description": "An identifier of the stream where the records are stored.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `streamRecordsAcl:READ` `dataModelsAcl:READ`\n\nFilter the records from the ```stream```.\n"
        },
        {
          "info": {
            "name": "Aggregate records data from a stream",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/:streamId/records/aggregate",
            "params": [
              {
                "name": "streamId",
                "value": "",
                "type": "path",
                "description": "An identifier of the stream where the records are stored.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `streamRecordsAcl:READ` `dataModelsAcl:READ`\n\nAggregate data for records from the ```stream```.\n\nYou can use an optional filter specification to limit the results.\n\nThe Records API supports three main groups of aggregates:\n\n*Metric aggregates*: ```sum```, ```min```, ```max```, ```count```, etc.\n\n*Bucket aggregates* (result records are aggregated into groups (buckets) — similar to the Data Model Instances ```groupBy``` concept):\n  ```uniqueValues``` (group by prop"
        },
        {
          "info": {
            "name": "Sync records from a stream",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/:streamId/records/sync",
            "params": [
              {
                "name": "streamId",
                "value": "",
                "type": "path",
                "description": "An identifier of the stream where the records are stored.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `streamRecordsAcl:READ` `dataModelsAcl:READ`\n\nSubscribe to changes for records from the ```stream```, matching a supplied filter.\n"
        }
      ]
    }
  ],
  "bundled": true
}