{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cognite 3D Asset Mapping Geospatial API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Geospatial",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Coordinate Reference Systems",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/crs",
            "params": [
              {
                "name": "filterOnlyCustom",
                "value": "",
                "type": "query",
                "description": "Optional parameter to only list custom Coordinate Reference Systems. Defaults to false."
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `geospatialCrsAcl:READ`\n\nList the defined Coordinate Reference Systems. The list can be limited to the custom Coordinate Reference Systems defined for the tenant."
        },
        {
          "info": {
            "name": "Create Coordinate Reference Systems",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/crs",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialCrsAcl:WRITE`\n\nCreates custom Coordinate Reference Systems."
        },
        {
          "info": {
            "name": "Get Coordinate Reference Systems",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/crs/byids",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialCrsAcl:READ`\n\nGet Coordinate Reference Systems by their Spatial Reference IDs"
        },
        {
          "info": {
            "name": "Delete Coordinate Reference Systems",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/crs/delete",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialCrsAcl:WRITE`\n\nDelete custom Coordinate Reference Systems."
        },
        {
          "info": {
            "name": "Create feature types",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:WRITE`\n\nCreates feature types. Each tenant can have up to 100 feature types."
        },
        {
          "info": {
            "name": "Retrieve feature types",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/byids",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nRetrieves feature types by external ids. It is possible to retrieve up to 100 items per request, i.e. the maximum number of feature types for a tenant."
        },
        {
          "info": {
            "name": "List feature types",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/list"
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nList all feature types"
        },
        {
          "info": {
            "name": "Update feature types",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/update",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nUpdate one or more feature types"
        },
        {
          "info": {
            "name": "Delete feature types",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/delete",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:WRITE`\n\nDelete feature types."
        },
        {
          "info": {
            "name": "Get features",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/:featureTypeExternalId/features",
            "params": [
              {
                "name": "featureTypeExternalId",
                "value": "",
                "type": "path",
                "description": "External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project."
              },
              {
                "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"
              },
              {
                "name": "allowCrsTransformation",
                "value": "",
                "type": "query"
              },
              {
                "name": "allowDimensionalityMismatch",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nGet features with paging support"
        },
        {
          "info": {
            "name": "Create features",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/:featureTypeExternalId/features",
            "params": [
              {
                "name": "featureTypeExternalId",
                "value": "",
                "type": "path",
                "description": "External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nCreate features"
        },
        {
          "info": {
            "name": "Filter all features",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/:featureTypeExternalId/features/list",
            "params": [
              {
                "name": "featureTypeExternalId",
                "value": "",
                "type": "path",
                "description": "External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nList features based on the feature property filter passed in the body of the request. This operation supports pagination by cursor."
        },
        {
          "info": {
            "name": "Retrieve features",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/:featureTypeExternalId/features/byids",
            "params": [
              {
                "name": "featureTypeExternalId",
                "value": "",
                "type": "path",
                "description": "External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nRetrieves features by external ids. It is possible to retrieve up to 1000 items per request."
        },
        {
          "info": {
            "name": "Update features",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/:featureTypeExternalId/features/update",
            "params": [
              {
                "name": "featureTypeExternalId",
                "value": "",
                "type": "path",
                "description": "External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nUpdate features. This is a replace operation, i.e., all feature properties have to be sent in the request body even if their values do not change."
        },
        {
          "info": {
            "name": "Delete features",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/:featureTypeExternalId/features/delete",
            "params": [
              {
                "name": "featureTypeExternalId",
                "value": "",
                "type": "path",
                "description": "External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nDelete features."
        },
        {
          "info": {
            "name": "Search features",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/:featureTypeExternalId/features/search",
            "params": [
              {
                "name": "featureTypeExternalId",
                "value": "",
                "type": "path",
                "description": "External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nSearch for features based on the feature property filter passed in the body of the request. The result of the search is limited to a maximum of 1000 items. Results in excess of the limit are truncated. This means that the complete result set of the search cannot be retrieved with this method. However, for a given unmodified feature collection, the result of the search is deterministic and does not change over time."
        },
        {
          "info": {
            "name": "Search and stream features",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/:featureTypeExternalId/features/search-streaming",
            "params": [
              {
                "name": "featureTypeExternalId",
                "value": "",
                "type": "path",
                "description": "External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nSearch for features based on the feature property filter passed in the body of the request. The streaming response format can be length prefixed, new line delimited, record separator delimited or concatenated depending on requested output (see https://en.wikipedia.org/wiki/JSON_streaming)."
        },
        {
          "info": {
            "name": "Aggregate features",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/:featureTypeExternalId/features/aggregate",
            "params": [
              {
                "name": "featureTypeExternalId",
                "value": "",
                "type": "path",
                "description": "External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nSearch for features based on the feature property filter and perform requested aggregations on a given property. Aggregations are supported for all filters that do not contain `stWithin`, `stWithinProperly`, `stContains` and `stContainsProperly` search in 3D geometries."
        },
        {
          "info": {
            "name": "Compute",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/compute",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialCrsAcl:READ`\n\nCompute custom json output structures or well known binary format responses based on calculation or selection of feature properties or direct values given in the request."
        },
        {
          "info": {
            "name": "Get a raster from a feature property",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/:featureTypeExternalId/features/:featureExternalId/rasters/:rasterPropertyName",
            "params": [
              {
                "name": "featureTypeExternalId",
                "value": "",
                "type": "path",
                "description": "External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project."
              },
              {
                "name": "featureExternalId",
                "value": "",
                "type": "path",
                "description": "External Id of the type provided by client. Must be unique among all feature external ids within a CDF project and feature type."
              },
              {
                "name": "rasterPropertyName",
                "value": "",
                "type": "path",
                "description": "Raster Id of the raster property provided by client. Must be unique among all feature property names within a feature type."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ`\n\nGet a raster from a feature property. The feature property must be of type RASTER."
        },
        {
          "info": {
            "name": "Put a raster into a feature property",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/:featureTypeExternalId/features/:featureExternalId/rasters/:rasterPropertyName",
            "params": [
              {
                "name": "featureTypeExternalId",
                "value": "",
                "type": "path",
                "description": "External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project."
              },
              {
                "name": "featureExternalId",
                "value": "",
                "type": "path",
                "description": "External Id of the type provided by client. Must be unique among all feature external ids within a CDF project and feature type."
              },
              {
                "name": "rasterPropertyName",
                "value": "",
                "type": "path",
                "description": "Raster Id of the raster property provided by client. Must be unique among all feature property names within a feature type."
              },
              {
                "name": "srid",
                "value": "",
                "type": "query",
                "description": "mandatory parameter that specifies the SRID of the coordinate reference system of a raster."
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "mandatory parameter that specifies the format of the input raster."
              },
              {
                "name": "scaleX",
                "value": "",
                "type": "query",
                "description": "optional parameter that specifies the pixel scale x in storage. If not specified, the pixel scale remains the same as the input raster."
              },
              {
                "name": "scaleY",
                "value": "",
                "type": "query",
                "description": "optional parameter that specifies the pixel scale y in storage. If not specified, the pixel scale remains the same as the input raster."
              },
              {
                "name": "allowCrsTransformation",
                "value": "",
                "type": "query",
                "description": "Optional parameter indicating if the input raster coordinates should be transformed into the Coordinate Reference Systems defined for the raster property in the feature type specification. The transformation will typically impact the pixel values. When the parameter is false, requests with rasters in Coordinate Reference System different from the ones defined in the feature type will result in bad request response code."
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nPut a raster into a feature property. The feature property must be of type RASTER."
        },
        {
          "info": {
            "name": "Delete a raster from a feature property",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster}.cognitedata.com/api/v1/projects/{project}/geospatial/featuretypes/:featureTypeExternalId/features/:featureExternalId/rasters/:rasterPropertyName/delete",
            "params": [
              {
                "name": "featureTypeExternalId",
                "value": "",
                "type": "path",
                "description": "External Id of the feature type provided by client. Must be unique among all feature type external ids within a CDF project."
              },
              {
                "name": "featureExternalId",
                "value": "",
                "type": "path",
                "description": "External Id of the type provided by client. Must be unique among all feature external ids within a CDF project and feature type."
              },
              {
                "name": "rasterPropertyName",
                "value": "",
                "type": "path",
                "description": "Raster Id of the raster property provided by client. Must be unique among all feature property names within a feature type."
              }
            ]
          },
          "docs": "\n\n> **Required capabilities:** `geospatialAcl:READ` `geospatialAcl:WRITE`\n\nDelete a raster from a feature property. If there is no raster already, the operation is a no-op."
        }
      ]
    }
  ],
  "bundled": true
}