{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cognite 3D Asset Mapping Data products API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Data products",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List data products",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts",
            "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": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of data products to be returned. The maximum results returned by the server is 100 even if you specify a higher limit. The API may return fewer results than the specified limit. Only if a `nextCursor` is returned in the response are there more results to fetch."
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nList all data products, with pagination."
        },
        {
          "info": {
            "name": "Create a data product",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `dataProductsAcl:CREATE`\n\nCreates a new data product. Maximum 100 data products allowed per project. Request body must contain an 'items' array with up to 1 data product definition per request."
        },
        {
          "info": {
            "name": "Get a data product",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/:externalId",
            "params": [
              {
                "name": "externalId",
                "value": "",
                "type": "path",
                "description": "Data product external identifier\n"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nRetrieves a specific data product by its external identifier."
        },
        {
          "info": {
            "name": "Delete a data product",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/delete",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `dataProductsAcl:DELETE`\n\nPermanently removes a data product. A data product can not be deleted if it contains versions. This operation cannot be undone."
        },
        {
          "info": {
            "name": "Update a data product",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/update",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `dataProductsAcl:UPDATE`\n\nUpdate the attributes of a data product. Fields that aren't included in the request aren't changed.\n"
        },
        {
          "info": {
            "name": "List data product versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/:externalId/versions",
            "params": [
              {
                "name": "externalId",
                "value": "",
                "type": "path",
                "description": "Data product external identifier\n"
              },
              {
                "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": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of data product versions to be returned. The maximum results returned by the server is 10 even if you specify a higher limit. The API may return fewer results than the specified limit. Only if a `nextCursor` is returned in the response are there more results to fetch."
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nList all versions of a data product, with pagination."
        },
        {
          "info": {
            "name": "Create a data product version",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/:externalId/versions",
            "params": [
              {
                "name": "externalId",
                "value": "",
                "type": "path",
                "description": "Data product external identifier\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `dataProductsAcl:UPDATE`\n\nCreates a new data product version that references a collection of data modeling views. Once created, view references cannot be removed or modified, but view references can be added, and other properties can be updated.\nA data product can have up to 10 versions.\nThe request body must contain an `items` array with exactly one data product version definition."
        },
        {
          "info": {
            "name": "Get a data product version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/:externalId/versions/:version",
            "params": [
              {
                "name": "externalId",
                "value": "",
                "type": "path",
                "description": "Data product external identifier\n"
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "The semantic version of the data product version to retrieve."
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `dataProductsAcl:READ`\n\nRetrieves a specific version of a data product by its semantic version."
        },
        {
          "info": {
            "name": "Delete data product versions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/:externalId/versions/delete",
            "params": [
              {
                "name": "externalId",
                "value": "",
                "type": "path",
                "description": "Data product external identifier\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `dataProductsAcl:UPDATE`\n\nDeletes one or more versions of a data product. Accepts a list of semantic versions. This operation cannot be undone.\n"
        },
        {
          "info": {
            "name": "Update data product version",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/dataproducts/:externalId/versions/update",
            "params": [
              {
                "name": "externalId",
                "value": "",
                "type": "path",
                "description": "Data product external identifier\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `dataProductsAcl:UPDATE`\n\nUpdate the attributes of a data product version. Fields that aren't included in the request aren't changed.\n"
        }
      ]
    }
  ],
  "bundled": true
}