{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cognite 3D Asset Mapping Data point subscriptions API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Data point subscriptions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List subscriptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/timeseries/subscriptions",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit on the number of results to return."
              },
              {
                "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"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:READ`\n\nList all subscriptions for the tenant. Use nextCursor to paginate through the results."
        },
        {
          "info": {
            "name": "Create subscriptions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/timeseries/subscriptions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:WRITE`\n\nCreate one or more subscriptions that can be used to listen for changes in data points for a set of time series."
        },
        {
          "info": {
            "name": "List subscription members",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/timeseries/subscriptions/members",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit on the number of results to return."
              },
              {
                "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": "externalId",
                "value": "",
                "type": "query",
                "description": "External id of the subscription."
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:READ`\n\nList all member time series for a subscription.\n\nFor non-filter subscriptions, either `externalId` or `instanceId` will be set. This is to be\nable to see if each time series was added by external id or instance id. If a time series\nhas been added to a subscription both by external id and by instance id, it will be listed\ntwice in the output. If a time series that belonged to the subscription has been deleted,\n`id` will not be set."
        },
        {
          "info": {
            "name": "Retrieve subscriptions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/timeseries/subscriptions/byids",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:READ`\n\nRetrieve one or more subscriptions by external ID."
        },
        {
          "info": {
            "name": "Update subscriptions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/timeseries/subscriptions/update",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:WRITE`\n\nUpdates one or more subscriptions. Fields that are not included in the request, are not changed.\n\nIf both `instanceIds` and `timeSeriesIds` are set, they must either both be add/remove or\nboth be set operations."
        },
        {
          "info": {
            "name": "Delete subscriptions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/timeseries/subscriptions/delete",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:WRITE`\n\nDelete subscription(s). This operation cannot be undone"
        },
        {
          "info": {
            "name": "List subscription data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/timeseries/subscriptions/data/list",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `timeSeriesSubscriptionsAcl:READ`\n\nFetch the next batch of data from a given subscription and partition(s).\nData can be ingested datapoints and time ranges where data is deleted.\nThis endpoint will also return changes to the subscription itself, that is, if time series\nare added or removed from the subscription.\n\nThe data can be returned multiple times, there is no mechanism to acknowledge or delete data.\nUse cursors to paginate through the results."
        }
      ]
    }
  ],
  "bundled": true
}