{ "swagger": "2.0", "info": { "title": "Microsoft Planetary Computer Pro", "version": "2025-04-30-preview", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "x-ms-parameterized-host": { "hostTemplate": "{endpoint}", "useSchemePrefix": false, "parameters": [ { "name": "endpoint", "in": "path", "description": "GeoCatalog endpoint, e.g. https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com", "required": true, "type": "string", "format": "uri", "x-ms-skip-url-encoding": true } ] }, "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "OAuth2Auth": [ "https://geocatalog.spatio.azure.com/.default" ] } ], "securityDefinitions": { "OAuth2Auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "https://geocatalog.spatio.azure.com/.default": "" } } }, "tags": [ { "name": "SpatioTemporal Asset Catalog (STAC) API" }, { "name": "STAC Collection Configuration" }, { "name": "Image Exports for STAC Collections" }, { "name": "Tiles for STAC Items" }, { "name": "Map Legends" }, { "name": "Tiles for STAC Collections Mosaics" }, { "name": "Tiles for STAC Searches" }, { "name": "Tile Matrix Sets" }, { "name": "Shared Access Signature (SAS) Tokens for GeoCatalog Asset Access" }, { "name": "Ingestion Management" }, { "name": "Ingestion Sources" } ], "paths": { "/data/collections/{collectionId}/image/static": { "post": { "operationId": "TilerStaticImages_Create", "tags": [ "Image Exports for STAC Collections" ], "summary": "Create Static Image (Deprecated)", "description": "Create a new image export.\n\nNote: This endpoint has been deprecated and will be removed in a future API version.\nPlease use `/data/collections/{collectionId}/bbox` for image generation instead.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "STAC Collection ID", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "body", "in": "body", "description": "Image request body", "required": true, "schema": { "$ref": "#/definitions/ImageParameters" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ImageResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerStaticImages_Create": { "$ref": "./examples/TilerStaticImages_Create.json" } } } }, "/data/collections/{collectionId}/image/static/{id}": { "get": { "operationId": "TilerStaticImages_Get", "tags": [ "Image Exports for STAC Collections" ], "summary": "Get Static Image (Deprecated)", "description": "Fetch an existing image export by ID.\n\nNote: This endpoint has been deprecated and will be removed in a future API version.\nPlease use `/data/collections/{collectionId}/bbox` for image generation instead.", "produces": [ "image/png", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "STAC Collection ID", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "id", "in": "path", "description": "Image export ID", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "Return an image.", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerStaticImages_Get": { "$ref": "./examples/TilerStaticImages_Get.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/{tileMatrixSetId}/WMTSCapabilities.xml": { "get": { "operationId": "TilerWmtsTileMatrixSets_GetCapabilitiesXml", "tags": [ "Tiles for STAC Items" ], "summary": "Wmts Tilematrixsetid As Path (Deprecated)", "description": "OGC WMTS endpoint.\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/{tileMatrixSetId}/WMTSCapabilities.xml` instead.", "produces": [ "application/xml", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "tileMatrixSetId", "in": "path", "description": "Identifier selecting one of the TileMatrixSetId supported", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "tile_format", "in": "query", "description": "Output image type. Default is png.", "required": false, "type": "string", "default": "png", "enum": [ "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw" ], "x-ms-enum": { "name": "TilerImageFormat", "modelAsString": true, "values": [ { "name": "png", "value": "png", "description": "Portable Network Graphics format - supports transparency" }, { "name": "npy", "value": "npy", "description": "NumPy array format for raw data access" }, { "name": "tif", "value": "tif", "description": "GeoTIFF format for georeferenced raster data" }, { "name": "jpeg", "value": "jpeg", "description": "JPEG format - smaller file size but lossy compression" }, { "name": "jpg", "value": "jpg", "description": "Alternate extension for JPEG format" }, { "name": "jp2", "value": "jp2", "description": "JPEG 2000 format - supports both lossy and lossless compression" }, { "name": "webp", "value": "webp", "description": "WebP format - modern image format with good compression" }, { "name": "pngraw", "value": "pngraw", "description": "Raw PNG format for access to unprocessed data" } ] }, "x-ms-client-name": "tileFormat" }, { "name": "tile_scale", "in": "query", "description": "Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512).", "required": false, "type": "integer", "format": "int32", "default": 1, "x-ms-client-name": "tileScale" }, { "$ref": "#/parameters/ZoomQueryParameters.minZoom" }, { "$ref": "#/parameters/ZoomQueryParameters.maxZoom" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.buffer" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.colorFormula" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.resampling" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" } ], "responses": { "200": { "description": "Successful Response", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerWmtsTileMatrixSets_GetCapabilitiesXml": { "$ref": "./examples/TilerWmtsTileMatrixSets_GetCapabilitiesXml.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/{tileMatrixSetId}/tilejson.json": { "get": { "operationId": "TilerTileJsonTileMatrixSets_Get", "tags": [ "Tiles for STAC Items" ], "summary": "TileJson Tilematrixsetid As Path (Deprecated)", "description": "Return the TileJson Tilematrixsetid As a path\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/{tileMatrixSetId}/tilejson.json` instead.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "tileMatrixSetId", "in": "path", "description": "Identifier selecting one of the TileMatrixSetId supported", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "tile_format", "in": "query", "description": "Default will be automatically defined if the output image needs a mask (png) or\nnot (jpeg).", "required": false, "type": "string", "enum": [ "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw" ], "x-ms-enum": { "name": "TilerImageFormat", "modelAsString": true, "values": [ { "name": "png", "value": "png", "description": "Portable Network Graphics format - supports transparency" }, { "name": "npy", "value": "npy", "description": "NumPy array format for raw data access" }, { "name": "tif", "value": "tif", "description": "GeoTIFF format for georeferenced raster data" }, { "name": "jpeg", "value": "jpeg", "description": "JPEG format - smaller file size but lossy compression" }, { "name": "jpg", "value": "jpg", "description": "Alternate extension for JPEG format" }, { "name": "jp2", "value": "jp2", "description": "JPEG 2000 format - supports both lossy and lossless compression" }, { "name": "webp", "value": "webp", "description": "WebP format - modern image format with good compression" }, { "name": "pngraw", "value": "pngraw", "description": "Raw PNG format for access to unprocessed data" } ] }, "x-ms-client-name": "tileFormat" }, { "name": "tile_scale", "in": "query", "description": "Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512).", "required": false, "type": "integer", "format": "int32", "default": 1, "x-ms-client-name": "tileScale" }, { "$ref": "#/parameters/ZoomQueryParameters.minZoom" }, { "$ref": "#/parameters/ZoomQueryParameters.maxZoom" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.buffer" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.colorFormula" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.resampling" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TileJsonMetadata" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerTileJsonTileMatrixSets_Get": { "$ref": "./examples/TilerTileJsonTileMatrixSets_Get.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/WMTSCapabilities.xml": { "get": { "operationId": "TilerWmts_GetCapabilitiesXml", "tags": [ "Tiles for STAC Items" ], "summary": "Wmts (Deprecated)", "description": "OGC WMTS endpoint.\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/WMTSCapabilities.xml` instead.", "produces": [ "application/xml", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "tileMatrixSetId", "in": "query", "description": "Identifier selecting one of the TileMatrixSetId supported (default:\n'WebMercatorQuad')", "required": false, "type": "string", "default": "WebMercatorQuad", "enum": [ "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "x-ms-enum": { "name": "TileMatrixSetId", "modelAsString": true, "values": [ { "name": "CanadianNAD83_LCC", "value": "CanadianNAD83_LCC", "description": "Canadian NAD83 Lambert Conformal Conic projection tile matrix set" }, { "name": "EuropeanETRS89_LAEAQuad", "value": "EuropeanETRS89_LAEAQuad", "description": "European ETRS89 Lambert Azimuthal Equal Area Quad tile matrix set" }, { "name": "LINZAntarticaMapTilegrid", "value": "LINZAntarticaMapTilegrid", "description": "Land Information New Zealand (LINZ) Antarctica Map tile grid matrix set" }, { "name": "NZTM2000Quad", "value": "NZTM2000Quad", "description": "New Zealand Transverse Mercator 2000 Quad tile matrix set" }, { "name": "UPSAntarcticWGS84Quad", "value": "UPSAntarcticWGS84Quad", "description": "Universal Polar Stereographic Antarctic WGS84 Quad tile matrix set" }, { "name": "UPSArcticWGS84Quad", "value": "UPSArcticWGS84Quad", "description": "Universal Polar Stereographic Arctic WGS84 Quad tile matrix set" }, { "name": "UTM31WGS84Quad", "value": "UTM31WGS84Quad", "description": "Universal Transverse Mercator Zone 31 WGS84 Quad tile matrix set" }, { "name": "WGS1984Quad", "value": "WGS1984Quad", "description": "WGS 1984 Quad tile matrix set" }, { "name": "WebMercatorQuad", "value": "WebMercatorQuad", "description": "Web Mercator Quad tile matrix set" }, { "name": "WorldCRS84Quad", "value": "WorldCRS84Quad", "description": "World CRS84 Quad tile matrix set" }, { "name": "WorldMercatorWGS84Quad", "value": "WorldMercatorWGS84Quad", "description": "World Mercator WGS84 Quad tile matrix set" } ] } }, { "name": "tile_format", "in": "query", "description": "Output image type. Default is png.", "required": false, "type": "string", "default": "png", "enum": [ "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw" ], "x-ms-enum": { "name": "TilerImageFormat", "modelAsString": true, "values": [ { "name": "png", "value": "png", "description": "Portable Network Graphics format - supports transparency" }, { "name": "npy", "value": "npy", "description": "NumPy array format for raw data access" }, { "name": "tif", "value": "tif", "description": "GeoTIFF format for georeferenced raster data" }, { "name": "jpeg", "value": "jpeg", "description": "JPEG format - smaller file size but lossy compression" }, { "name": "jpg", "value": "jpg", "description": "Alternate extension for JPEG format" }, { "name": "jp2", "value": "jp2", "description": "JPEG 2000 format - supports both lossy and lossless compression" }, { "name": "webp", "value": "webp", "description": "WebP format - modern image format with good compression" }, { "name": "pngraw", "value": "pngraw", "description": "Raw PNG format for access to unprocessed data" } ] }, "x-ms-client-name": "tileFormat" }, { "name": "tile_scale", "in": "query", "description": "Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512).", "required": false, "type": "integer", "format": "int32", "default": 1, "x-ms-client-name": "tileScale" }, { "$ref": "#/parameters/ZoomQueryParameters.minZoom" }, { "$ref": "#/parameters/ZoomQueryParameters.maxZoom" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.buffer" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.colorFormula" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.resampling" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" } ], "responses": { "200": { "description": "Successful Response", "schema": { "type": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerWmts_GetCapabilitiesXml": { "$ref": "./examples/TilerWmts_GetCapabilitiesXml.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/asset_statistics": { "get": { "operationId": "TilerAssetStatistics_GetAll", "tags": [ "Tiles for STAC Items" ], "summary": "Asset Statistics (Deprecated)", "description": "Per Asset statistics\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/asset_statistics` instead.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/StatisticsQueryParameters.resampling" }, { "$ref": "#/parameters/StatisticsQueryParameters.maxSize" }, { "$ref": "#/parameters/StatisticsQueryParameters.categorical" }, { "$ref": "#/parameters/StatisticsQueryParameters.categoriesPixels" }, { "$ref": "#/parameters/StatisticsQueryParameters.percentiles" }, { "$ref": "#/parameters/StatisticsQueryParameters.histogramBins" }, { "$ref": "#/parameters/StatisticsQueryParameters.histogramRange" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AssetStatisticsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerAssetStatistics_GetAll": { "$ref": "./examples/TilerAssetStatistics_GetAll.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/assets": { "get": { "operationId": "TilerAvailableAssets_GetAll", "tags": [ "Tiles for STAC Items" ], "summary": "Available Assets (Deprecated)", "description": "Return a list of supported assets.\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/assets` instead.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "Return a list of supported assets.", "schema": { "type": "array", "items": { "type": "string" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerAvailableAssets_GetAll": { "$ref": "./examples/TilerAvailableAssets_GetAll.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/bounds": { "get": { "operationId": "TilerBound_GetAll", "tags": [ "Tiles for STAC Items" ], "summary": "Bounds (Deprecated)", "description": "Return all Bounds\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/bounds` instead.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacItemBounds" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerBound_GetAll": { "$ref": "./examples/TilerBound_GetAll.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/crop/{minx},{miny},{maxx},{maxy}.{format}": { "get": { "operationId": "TilerParts_GetCroppedToBoundingBox", "tags": [ "Tiles for STAC Items" ], "summary": "Part (Deprecated)", "description": "Create image from part of a dataset.\n\nNote: The old endpoint using `/crop/` has been deprecated. Please use `/data/collections/{collectionId}/items/{itemId}/bbox/{minx},{miny},{maxx},{maxy}.{format}` instead.", "produces": [ "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/BoundingBoxPathParameters.minx" }, { "$ref": "#/parameters/BoundingBoxPathParameters.miny" }, { "$ref": "#/parameters/BoundingBoxPathParameters.maxx" }, { "$ref": "#/parameters/BoundingBoxPathParameters.maxy" }, { "name": "format", "in": "path", "description": "Output format for the tile or image (e.g., png, jpeg, webp)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "color_formula", "in": "query", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)", "required": false, "type": "string", "x-ms-client-name": "colorFormula" }, { "name": "dst-crs", "in": "query", "description": "Output Coordinate Reference System.", "required": false, "type": "string", "x-ms-client-name": "dstCrs" }, { "name": "coord-crs", "in": "query", "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "required": false, "type": "string", "x-ms-client-name": "coordinateReferenceSystem" }, { "name": "resampling", "in": "query", "description": "Resampling method.", "required": false, "type": "string", "default": "nearest", "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "x-ms-enum": { "name": "Resampling", "modelAsString": true, "values": [ { "name": "nearest", "value": "nearest", "description": "Nearest neighbor - fastest method that selects the closest pixel value" }, { "name": "bilinear", "value": "bilinear", "description": "Bilinear interpolation - calculates output values using a weighted average of 2x2 input cells" }, { "name": "cubic", "value": "cubic", "description": "Cubic interpolation - uses a weighted average of 4x4 input cells for smoother results" }, { "name": "cubic_spline", "value": "cubic_spline", "description": "Cubic spline interpolation - similar to cubic but preserves edges better" }, { "name": "lanczos", "value": "lanczos", "description": "Lanczos windowed sinc resampling - high-quality with minimal artifacts" }, { "name": "average", "value": "average", "description": "Average resampling - calculates the mean of all contributing pixels" }, { "name": "mode", "value": "mode", "description": "Mode resampling - selects the most common value from contributing pixels" }, { "name": "gauss", "value": "gauss", "description": "Gaussian weighted resampling - applies a gaussian weighting to contributing pixels" }, { "name": "rms", "value": "rms", "description": "Root mean square resampling - useful for resampling error or deviation grids" } ] } }, { "name": "max_size", "in": "query", "description": "Image output size limit if width and height limits are not set.", "required": false, "type": "integer", "format": "int32", "default": 1024, "x-ms-client-name": "maxSize" }, { "$ref": "#/parameters/DimensionsQueryParameters.height" }, { "$ref": "#/parameters/DimensionsQueryParameters.width" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" } ], "responses": { "200": { "description": "Return an image.", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerParts_GetCroppedToBoundingBox": { "$ref": "./examples/TilerParts_GetCroppedToBoundingBox.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/crop/{width}x{height}.{format}": { "post": { "operationId": "TilerGeoJsons_CropWidthByHeightFormat", "tags": [ "Tiles for STAC Items" ], "summary": "Geojson Crop (Deprecated)", "description": "Create image from a geojson feature.\n\nNote: The old endpoint using `/crop` has been deprecated. Please use `/data/collections/{collectionId}/items/{itemId}/feature/{width}x{height}.{format}` instead.", "produces": [ "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "width", "in": "path", "description": "Width in pixels for the output image.", "required": true, "type": "integer", "format": "int32" }, { "name": "height", "in": "path", "description": "Height in pixels for the output image.", "required": true, "type": "integer", "format": "int32" }, { "name": "format", "in": "path", "description": "Output format for the tile or image (e.g., png, jpeg, webp)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "color_formula", "in": "query", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)", "required": false, "type": "string", "x-ms-client-name": "colorFormula" }, { "name": "coord-crs", "in": "query", "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "required": false, "type": "string", "x-ms-client-name": "coordinateReferenceSystem" }, { "name": "resampling", "in": "query", "description": "Resampling method.", "required": false, "type": "string", "default": "nearest", "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "x-ms-enum": { "name": "Resampling", "modelAsString": true, "values": [ { "name": "nearest", "value": "nearest", "description": "Nearest neighbor - fastest method that selects the closest pixel value" }, { "name": "bilinear", "value": "bilinear", "description": "Bilinear interpolation - calculates output values using a weighted average of 2x2 input cells" }, { "name": "cubic", "value": "cubic", "description": "Cubic interpolation - uses a weighted average of 4x4 input cells for smoother results" }, { "name": "cubic_spline", "value": "cubic_spline", "description": "Cubic spline interpolation - similar to cubic but preserves edges better" }, { "name": "lanczos", "value": "lanczos", "description": "Lanczos windowed sinc resampling - high-quality with minimal artifacts" }, { "name": "average", "value": "average", "description": "Average resampling - calculates the mean of all contributing pixels" }, { "name": "mode", "value": "mode", "description": "Mode resampling - selects the most common value from contributing pixels" }, { "name": "gauss", "value": "gauss", "description": "Gaussian weighted resampling - applies a gaussian weighting to contributing pixels" }, { "name": "rms", "value": "rms", "description": "Root mean square resampling - useful for resampling error or deviation grids" } ] } }, { "name": "max_size", "in": "query", "description": "Image output size limit if width and height limits are not set.", "required": false, "type": "integer", "format": "int32", "default": 1024, "x-ms-client-name": "maxSize" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" }, { "name": "body", "in": "body", "description": "Request GeoJson body.", "required": true, "schema": { "$ref": "#/definitions/Feature" } } ], "responses": { "200": { "description": "Return an image.", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerGeoJsons_CropWidthByHeightFormat": { "$ref": "./examples/TilerGeoJsons_CropWidthByHeightFormat.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/crop/{minx},{miny},{maxx},{maxy}/{width}x{height}.{format}": { "get": { "operationId": "TilerParts_GetCroppedToBoundingBoxWidthByHeight", "tags": [ "Tiles for STAC Items" ], "summary": "Part (Deprecated)", "description": "Create image from part of a dataset.\n\nNote: The old endpoint using `/crop/` has been deprecated. Please use `/data/collections/{collectionId}/items/{itemId}/bbox/{minx},{miny},{maxx},{maxy}/{width}x{height}.{format}` instead.", "produces": [ "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/BoundingBoxPathParameters.minx" }, { "$ref": "#/parameters/BoundingBoxPathParameters.miny" }, { "$ref": "#/parameters/BoundingBoxPathParameters.maxx" }, { "$ref": "#/parameters/BoundingBoxPathParameters.maxy" }, { "name": "width", "in": "path", "description": "Width in pixels for the output image.", "required": true, "type": "integer", "format": "int32" }, { "name": "height", "in": "path", "description": "Height in pixels for the output image.", "required": true, "type": "integer", "format": "int32" }, { "name": "format", "in": "path", "description": "Output format for the tile or image (e.g., png, jpeg, webp)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "color_formula", "in": "query", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)", "required": false, "type": "string", "x-ms-client-name": "colorFormula" }, { "name": "dst-crs", "in": "query", "description": "Output Coordinate Reference System.", "required": false, "type": "string", "x-ms-client-name": "dstCrs" }, { "name": "coord-crs", "in": "query", "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "required": false, "type": "string", "x-ms-client-name": "coordinateReferenceSystem" }, { "name": "resampling", "in": "query", "description": "Resampling method.", "required": false, "type": "string", "default": "nearest", "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "x-ms-enum": { "name": "Resampling", "modelAsString": true, "values": [ { "name": "nearest", "value": "nearest", "description": "Nearest neighbor - fastest method that selects the closest pixel value" }, { "name": "bilinear", "value": "bilinear", "description": "Bilinear interpolation - calculates output values using a weighted average of 2x2 input cells" }, { "name": "cubic", "value": "cubic", "description": "Cubic interpolation - uses a weighted average of 4x4 input cells for smoother results" }, { "name": "cubic_spline", "value": "cubic_spline", "description": "Cubic spline interpolation - similar to cubic but preserves edges better" }, { "name": "lanczos", "value": "lanczos", "description": "Lanczos windowed sinc resampling - high-quality with minimal artifacts" }, { "name": "average", "value": "average", "description": "Average resampling - calculates the mean of all contributing pixels" }, { "name": "mode", "value": "mode", "description": "Mode resampling - selects the most common value from contributing pixels" }, { "name": "gauss", "value": "gauss", "description": "Gaussian weighted resampling - applies a gaussian weighting to contributing pixels" }, { "name": "rms", "value": "rms", "description": "Root mean square resampling - useful for resampling error or deviation grids" } ] } }, { "name": "max_size", "in": "query", "description": "Image output size limit if width and height limits are not set.", "required": false, "type": "integer", "format": "int32", "default": 1024, "x-ms-client-name": "maxSize" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" } ], "responses": { "200": { "description": "Return an image.", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerParts_GetCroppedToBoundingBoxWidthByHeight": { "$ref": "./examples/TilerParts_GetCroppedToBoundingBoxWidthByHeight.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/crop.{format}": { "post": { "operationId": "TilerGeoJsons_CropFormat", "tags": [ "Tiles for STAC Items" ], "summary": "Geojson Crop (Deprecated)", "description": "Create image from a geojson feature.\n\nNote: The old endpoint using `/crop` has been deprecated. Please use `/data/collections/{collectionId}/items/{itemId}/feature.{format}` instead.", "produces": [ "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "format", "in": "path", "description": "Output format for the tile or image (e.g., png, jpeg, webp)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "color_formula", "in": "query", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)", "required": false, "type": "string", "x-ms-client-name": "colorFormula" }, { "name": "coord-crs", "in": "query", "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "required": false, "type": "string", "x-ms-client-name": "coordinateReferenceSystem" }, { "name": "resampling", "in": "query", "description": "Resampling method.", "required": false, "type": "string", "default": "nearest", "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "x-ms-enum": { "name": "Resampling", "modelAsString": true, "values": [ { "name": "nearest", "value": "nearest", "description": "Nearest neighbor - fastest method that selects the closest pixel value" }, { "name": "bilinear", "value": "bilinear", "description": "Bilinear interpolation - calculates output values using a weighted average of 2x2 input cells" }, { "name": "cubic", "value": "cubic", "description": "Cubic interpolation - uses a weighted average of 4x4 input cells for smoother results" }, { "name": "cubic_spline", "value": "cubic_spline", "description": "Cubic spline interpolation - similar to cubic but preserves edges better" }, { "name": "lanczos", "value": "lanczos", "description": "Lanczos windowed sinc resampling - high-quality with minimal artifacts" }, { "name": "average", "value": "average", "description": "Average resampling - calculates the mean of all contributing pixels" }, { "name": "mode", "value": "mode", "description": "Mode resampling - selects the most common value from contributing pixels" }, { "name": "gauss", "value": "gauss", "description": "Gaussian weighted resampling - applies a gaussian weighting to contributing pixels" }, { "name": "rms", "value": "rms", "description": "Root mean square resampling - useful for resampling error or deviation grids" } ] } }, { "name": "max_size", "in": "query", "description": "Image output size limit if width and height limits are not set.", "required": false, "type": "integer", "format": "int32", "default": 1024, "x-ms-client-name": "maxSize" }, { "$ref": "#/parameters/DimensionsQueryParameters.height" }, { "$ref": "#/parameters/DimensionsQueryParameters.width" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" }, { "name": "body", "in": "body", "description": "Request GeoJson body.", "required": true, "schema": { "$ref": "#/definitions/Feature" } } ], "responses": { "200": { "description": "Return an image.", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerGeoJsons_CropFormat": { "$ref": "./examples/TilerGeoJsons_CropFormat.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/info": { "get": { "operationId": "TilerInfoOperations_Get", "tags": [ "Tiles for STAC Items" ], "summary": "Info (Deprecated)", "description": "Return dataset's basic info.\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/info` instead.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "assets", "in": "query", "description": "Asset's names.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TilerInfoMapResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerInfoOperations_Get": { "$ref": "./examples/TilerInfoOperations_Get.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/info.geojson": { "get": { "operationId": "TilerInfoGeoJsonOperations_Get", "tags": [ "Tiles for STAC Items" ], "summary": "Info Geojson (Deprecated)", "description": "Return Info Geojson\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/info.geojson` instead.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "assets", "in": "query", "description": "Asset's names.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TilerInfoGeoJsonFeature" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerInfoGeoJsonOperations_Get": { "$ref": "./examples/TilerInfoGeoJsonOperations_Get.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/point/{longitude},{latitude}": { "get": { "operationId": "TilerPoints_GetPoint", "tags": [ "Tiles for STAC Items" ], "summary": "Point (Deprecated)", "description": "Get Point value for a dataset.\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/point/{longitude},{latitude}` instead.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "longitude", "in": "path", "description": "Longitude", "required": true, "type": "number", "format": "float" }, { "name": "latitude", "in": "path", "description": "Latitude", "required": true, "type": "number", "format": "float" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "name": "coord-crs", "in": "query", "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "required": false, "type": "string", "x-ms-client-name": "coordinateReferenceSystem" }, { "name": "resampling", "in": "query", "description": "Resampling method.", "required": false, "type": "string", "default": "nearest", "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "x-ms-enum": { "name": "Resampling", "modelAsString": true, "values": [ { "name": "nearest", "value": "nearest", "description": "Nearest neighbor - fastest method that selects the closest pixel value" }, { "name": "bilinear", "value": "bilinear", "description": "Bilinear interpolation - calculates output values using a weighted average of 2x2 input cells" }, { "name": "cubic", "value": "cubic", "description": "Cubic interpolation - uses a weighted average of 4x4 input cells for smoother results" }, { "name": "cubic_spline", "value": "cubic_spline", "description": "Cubic spline interpolation - similar to cubic but preserves edges better" }, { "name": "lanczos", "value": "lanczos", "description": "Lanczos windowed sinc resampling - high-quality with minimal artifacts" }, { "name": "average", "value": "average", "description": "Average resampling - calculates the mean of all contributing pixels" }, { "name": "mode", "value": "mode", "description": "Mode resampling - selects the most common value from contributing pixels" }, { "name": "gauss", "value": "gauss", "description": "Gaussian weighted resampling - applies a gaussian weighting to contributing pixels" }, { "name": "rms", "value": "rms", "description": "Root mean square resampling - useful for resampling error or deviation grids" } ] } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TilerCoreModelsResponsesPoint" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerPoints_GetPoint": { "$ref": "./examples/TilerPoints_GetPoint.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/preview": { "get": { "operationId": "TilerPreviews_Get", "tags": [ "Tiles for STAC Items" ], "summary": "Preview (Deprecated)", "description": "Create preview of a dataset.\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/preview` instead.", "produces": [ "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "format", "in": "query", "description": "Output format for the tile or image (e.g., png, jpeg, webp).", "required": false, "type": "string", "enum": [ "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw" ], "x-ms-enum": { "name": "TilerImageFormat", "modelAsString": true, "values": [ { "name": "png", "value": "png", "description": "Portable Network Graphics format - supports transparency" }, { "name": "npy", "value": "npy", "description": "NumPy array format for raw data access" }, { "name": "tif", "value": "tif", "description": "GeoTIFF format for georeferenced raster data" }, { "name": "jpeg", "value": "jpeg", "description": "JPEG format - smaller file size but lossy compression" }, { "name": "jpg", "value": "jpg", "description": "Alternate extension for JPEG format" }, { "name": "jp2", "value": "jp2", "description": "JPEG 2000 format - supports both lossy and lossless compression" }, { "name": "webp", "value": "webp", "description": "WebP format - modern image format with good compression" }, { "name": "pngraw", "value": "pngraw", "description": "Raw PNG format for access to unprocessed data" } ] } }, { "name": "color_formula", "in": "query", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)", "required": false, "type": "string", "x-ms-client-name": "colorFormula" }, { "name": "dst-crs", "in": "query", "description": "Output Coordinate Reference System.", "required": false, "type": "string", "x-ms-client-name": "dstCrs" }, { "name": "resampling", "in": "query", "description": "Resampling method.", "required": false, "type": "string", "default": "nearest", "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "x-ms-enum": { "name": "Resampling", "modelAsString": true, "values": [ { "name": "nearest", "value": "nearest", "description": "Nearest neighbor - fastest method that selects the closest pixel value" }, { "name": "bilinear", "value": "bilinear", "description": "Bilinear interpolation - calculates output values using a weighted average of 2x2 input cells" }, { "name": "cubic", "value": "cubic", "description": "Cubic interpolation - uses a weighted average of 4x4 input cells for smoother results" }, { "name": "cubic_spline", "value": "cubic_spline", "description": "Cubic spline interpolation - similar to cubic but preserves edges better" }, { "name": "lanczos", "value": "lanczos", "description": "Lanczos windowed sinc resampling - high-quality with minimal artifacts" }, { "name": "average", "value": "average", "description": "Average resampling - calculates the mean of all contributing pixels" }, { "name": "mode", "value": "mode", "description": "Mode resampling - selects the most common value from contributing pixels" }, { "name": "gauss", "value": "gauss", "description": "Gaussian weighted resampling - applies a gaussian weighting to contributing pixels" }, { "name": "rms", "value": "rms", "description": "Root mean square resampling - useful for resampling error or deviation grids" } ] } }, { "name": "max_size", "in": "query", "description": "Image output size limit if width and height limits are not set.", "required": false, "type": "integer", "format": "int32", "default": 1024, "x-ms-client-name": "maxSize" }, { "$ref": "#/parameters/DimensionsQueryParameters.height" }, { "$ref": "#/parameters/DimensionsQueryParameters.width" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" } ], "responses": { "200": { "description": "Return an image.", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerPreviews_Get": { "$ref": "./examples/TilerPreviews_Get.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/preview.{format}": { "get": { "operationId": "TilerPreviews_GetFormat", "tags": [ "Tiles for STAC Items" ], "summary": "Preview (Deprecated)", "description": "Create preview of a dataset.\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/preview.{format}` instead.", "produces": [ "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "format", "in": "path", "description": "Output format for the tile or image (e.g., png, jpeg, webp)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "color_formula", "in": "query", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)", "required": false, "type": "string", "x-ms-client-name": "colorFormula" }, { "name": "dst-crs", "in": "query", "description": "Output Coordinate Reference System.", "required": false, "type": "string", "x-ms-client-name": "dstCrs" }, { "name": "resampling", "in": "query", "description": "Resampling method.", "required": false, "type": "string", "default": "nearest", "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "x-ms-enum": { "name": "Resampling", "modelAsString": true, "values": [ { "name": "nearest", "value": "nearest", "description": "Nearest neighbor - fastest method that selects the closest pixel value" }, { "name": "bilinear", "value": "bilinear", "description": "Bilinear interpolation - calculates output values using a weighted average of 2x2 input cells" }, { "name": "cubic", "value": "cubic", "description": "Cubic interpolation - uses a weighted average of 4x4 input cells for smoother results" }, { "name": "cubic_spline", "value": "cubic_spline", "description": "Cubic spline interpolation - similar to cubic but preserves edges better" }, { "name": "lanczos", "value": "lanczos", "description": "Lanczos windowed sinc resampling - high-quality with minimal artifacts" }, { "name": "average", "value": "average", "description": "Average resampling - calculates the mean of all contributing pixels" }, { "name": "mode", "value": "mode", "description": "Mode resampling - selects the most common value from contributing pixels" }, { "name": "gauss", "value": "gauss", "description": "Gaussian weighted resampling - applies a gaussian weighting to contributing pixels" }, { "name": "rms", "value": "rms", "description": "Root mean square resampling - useful for resampling error or deviation grids" } ] } }, { "name": "max_size", "in": "query", "description": "Image output size limit if width and height limits are not set.", "required": false, "type": "integer", "format": "int32", "default": 1024, "x-ms-client-name": "maxSize" }, { "$ref": "#/parameters/DimensionsQueryParameters.height" }, { "$ref": "#/parameters/DimensionsQueryParameters.width" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" } ], "responses": { "200": { "description": "Return an image.", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerPreviews_GetFormat": { "$ref": "./examples/TilerPreviews_GetFormat.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/statistics": { "get": { "operationId": "TilerStatistics_GetAll", "tags": [ "Tiles for STAC Items" ], "summary": "Statistics (Deprecated)", "description": "Merged assets statistics.\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/statistics` (GET) instead.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/StatisticsQueryParameters.resampling" }, { "$ref": "#/parameters/StatisticsQueryParameters.maxSize" }, { "$ref": "#/parameters/StatisticsQueryParameters.categorical" }, { "$ref": "#/parameters/StatisticsQueryParameters.categoriesPixels" }, { "$ref": "#/parameters/StatisticsQueryParameters.percentiles" }, { "$ref": "#/parameters/StatisticsQueryParameters.histogramBins" }, { "$ref": "#/parameters/StatisticsQueryParameters.histogramRange" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TilerStacItemStatistics" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerStatistics_GetAll": { "$ref": "./examples/TilerStatistics_GetAll.json" } } }, "post": { "operationId": "TilerGeoJsonStatistics_Get", "tags": [ "Tiles for STAC Items" ], "summary": "Geojson Statistics (Deprecated)", "description": "Get Statistics from a geojson feature.\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/statistics` (POST) instead.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "coord-crs", "in": "query", "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "required": false, "type": "string", "x-ms-client-name": "coordinateReferenceSystem" }, { "$ref": "#/parameters/StatisticsQueryParameters.resampling" }, { "$ref": "#/parameters/StatisticsQueryParameters.maxSize" }, { "$ref": "#/parameters/StatisticsQueryParameters.categorical" }, { "$ref": "#/parameters/StatisticsQueryParameters.categoriesPixels" }, { "$ref": "#/parameters/StatisticsQueryParameters.percentiles" }, { "$ref": "#/parameters/StatisticsQueryParameters.histogramBins" }, { "$ref": "#/parameters/StatisticsQueryParameters.histogramRange" }, { "name": "body", "in": "body", "description": "Request GeoJson body", "required": true, "schema": { "$ref": "#/definitions/Feature" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacItemStatisticsGeoJson" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerGeoJsonStatistics_Get": { "$ref": "./examples/TilerGeoJsonStatistics_Get.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/tilejson.json": { "get": { "operationId": "TilerTileJsonOperations_Get", "tags": [ "Tiles for STAC Items" ], "summary": "TileJson (Deprecated)", "description": "Return TileJson\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/tilejson.json` instead.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "tileMatrixSetId", "in": "query", "description": "Identifier selecting one of the TileMatrixSetId supported (default:\n'WebMercatorQuad')", "required": false, "type": "string", "default": "WebMercatorQuad", "enum": [ "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "x-ms-enum": { "name": "TileMatrixSetId", "modelAsString": true, "values": [ { "name": "CanadianNAD83_LCC", "value": "CanadianNAD83_LCC", "description": "Canadian NAD83 Lambert Conformal Conic projection tile matrix set" }, { "name": "EuropeanETRS89_LAEAQuad", "value": "EuropeanETRS89_LAEAQuad", "description": "European ETRS89 Lambert Azimuthal Equal Area Quad tile matrix set" }, { "name": "LINZAntarticaMapTilegrid", "value": "LINZAntarticaMapTilegrid", "description": "Land Information New Zealand (LINZ) Antarctica Map tile grid matrix set" }, { "name": "NZTM2000Quad", "value": "NZTM2000Quad", "description": "New Zealand Transverse Mercator 2000 Quad tile matrix set" }, { "name": "UPSAntarcticWGS84Quad", "value": "UPSAntarcticWGS84Quad", "description": "Universal Polar Stereographic Antarctic WGS84 Quad tile matrix set" }, { "name": "UPSArcticWGS84Quad", "value": "UPSArcticWGS84Quad", "description": "Universal Polar Stereographic Arctic WGS84 Quad tile matrix set" }, { "name": "UTM31WGS84Quad", "value": "UTM31WGS84Quad", "description": "Universal Transverse Mercator Zone 31 WGS84 Quad tile matrix set" }, { "name": "WGS1984Quad", "value": "WGS1984Quad", "description": "WGS 1984 Quad tile matrix set" }, { "name": "WebMercatorQuad", "value": "WebMercatorQuad", "description": "Web Mercator Quad tile matrix set" }, { "name": "WorldCRS84Quad", "value": "WorldCRS84Quad", "description": "World CRS84 Quad tile matrix set" }, { "name": "WorldMercatorWGS84Quad", "value": "WorldMercatorWGS84Quad", "description": "World Mercator WGS84 Quad tile matrix set" } ] } }, { "name": "tile_format", "in": "query", "description": "Default will be automatically defined if the output image needs a mask (png) or\nnot (jpeg).", "required": false, "type": "string", "enum": [ "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw" ], "x-ms-enum": { "name": "TilerImageFormat", "modelAsString": true, "values": [ { "name": "png", "value": "png", "description": "Portable Network Graphics format - supports transparency" }, { "name": "npy", "value": "npy", "description": "NumPy array format for raw data access" }, { "name": "tif", "value": "tif", "description": "GeoTIFF format for georeferenced raster data" }, { "name": "jpeg", "value": "jpeg", "description": "JPEG format - smaller file size but lossy compression" }, { "name": "jpg", "value": "jpg", "description": "Alternate extension for JPEG format" }, { "name": "jp2", "value": "jp2", "description": "JPEG 2000 format - supports both lossy and lossless compression" }, { "name": "webp", "value": "webp", "description": "WebP format - modern image format with good compression" }, { "name": "pngraw", "value": "pngraw", "description": "Raw PNG format for access to unprocessed data" } ] }, "x-ms-client-name": "tileFormat" }, { "name": "tile_scale", "in": "query", "description": "Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512).", "required": false, "type": "integer", "format": "int32", "default": 1, "x-ms-client-name": "tileScale" }, { "$ref": "#/parameters/ZoomQueryParameters.minZoom" }, { "$ref": "#/parameters/ZoomQueryParameters.maxZoom" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.buffer" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.colorFormula" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.resampling" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TileJsonMetadata" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerTileJsonOperations_Get": { "$ref": "./examples/TilerTileJsonOperations_Get.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/tiles/{z}/{x}/{y}@{scale}x.{format}": { "get": { "operationId": "TilerTiles_GetZxyScaleByFormat", "tags": [ "Tiles for STAC Items" ], "summary": "Tile (Deprecated)", "description": "Create map tile from a dataset.\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/tiles/{z}/{x}/{y}@{scale}x.{format}` instead.", "produces": [ "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/ZxyPathParameters.z" }, { "$ref": "#/parameters/ZxyPathParameters.x" }, { "$ref": "#/parameters/ZxyPathParameters.y" }, { "name": "scale", "in": "path", "description": "Numeric scale factor for the tile. Higher values produce larger tiles (default: \"1\")", "required": true, "type": "number", "format": "float" }, { "name": "format", "in": "path", "description": "Output format for the tile or image (e.g., png, jpeg, webp) (default: \"png\").", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "tileMatrixSetId", "in": "query", "description": "Identifier selecting one of the TileMatrixSetId supported (default:\n'WebMercatorQuad')", "required": false, "type": "string", "default": "WebMercatorQuad", "enum": [ "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "x-ms-enum": { "name": "TileMatrixSetId", "modelAsString": true, "values": [ { "name": "CanadianNAD83_LCC", "value": "CanadianNAD83_LCC", "description": "Canadian NAD83 Lambert Conformal Conic projection tile matrix set" }, { "name": "EuropeanETRS89_LAEAQuad", "value": "EuropeanETRS89_LAEAQuad", "description": "European ETRS89 Lambert Azimuthal Equal Area Quad tile matrix set" }, { "name": "LINZAntarticaMapTilegrid", "value": "LINZAntarticaMapTilegrid", "description": "Land Information New Zealand (LINZ) Antarctica Map tile grid matrix set" }, { "name": "NZTM2000Quad", "value": "NZTM2000Quad", "description": "New Zealand Transverse Mercator 2000 Quad tile matrix set" }, { "name": "UPSAntarcticWGS84Quad", "value": "UPSAntarcticWGS84Quad", "description": "Universal Polar Stereographic Antarctic WGS84 Quad tile matrix set" }, { "name": "UPSArcticWGS84Quad", "value": "UPSArcticWGS84Quad", "description": "Universal Polar Stereographic Arctic WGS84 Quad tile matrix set" }, { "name": "UTM31WGS84Quad", "value": "UTM31WGS84Quad", "description": "Universal Transverse Mercator Zone 31 WGS84 Quad tile matrix set" }, { "name": "WGS1984Quad", "value": "WGS1984Quad", "description": "WGS 1984 Quad tile matrix set" }, { "name": "WebMercatorQuad", "value": "WebMercatorQuad", "description": "Web Mercator Quad tile matrix set" }, { "name": "WorldCRS84Quad", "value": "WorldCRS84Quad", "description": "World CRS84 Quad tile matrix set" }, { "name": "WorldMercatorWGS84Quad", "value": "WorldMercatorWGS84Quad", "description": "World Mercator WGS84 Quad tile matrix set" } ] } }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.buffer" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.colorFormula" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.resampling" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" }, { "$ref": "#/parameters/SubDatasetQueryParameters.subdatasetName" }, { "$ref": "#/parameters/SubDatasetQueryParameters.subdatasetBands" } ], "responses": { "200": { "description": "Return an image.", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerTiles_GetZxyScaleByFormat": { "$ref": "./examples/TilerTiles_GetZxyScaleByFormat.json" } } } }, "/data/collections/{collectionId}/items/{itemId}/tiles/{tileMatrixSetId}/{z}/{x}/{y}@{scale}x.{format}": { "get": { "operationId": "TilerTileMatrixSets_GetZxyScaleByFormat", "tags": [ "Tiles for STAC Items" ], "summary": "Tile Tilematrixsetid As Path (Deprecated)", "description": "Create map tile from a dataset.\n\nNote: This endpoint has been deprecated. Please use `/data/mosaic/collections/{collectionId}/items/{itemId}/tiles/{tileMatrixSetId}/{z}/{x}/{y}@{scale}x.{format}` instead.", "produces": [ "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "collectionId", "in": "path", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "itemId", "in": "path", "description": "STAC Item Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "tileMatrixSetId", "in": "path", "description": "Identifier selecting one of the TileMatrixSetId supported", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/ZxyPathParameters.z" }, { "$ref": "#/parameters/ZxyPathParameters.x" }, { "$ref": "#/parameters/ZxyPathParameters.y" }, { "name": "scale", "in": "path", "description": "Numeric scale factor for the tile. Higher values produce larger tiles", "required": true, "type": "number", "format": "float" }, { "name": "format", "in": "path", "description": "Output format for the tile or image (e.g., png, jpeg, webp)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.buffer" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.colorFormula" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.resampling" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" }, { "$ref": "#/parameters/SubDatasetQueryParameters.subdatasetName" }, { "$ref": "#/parameters/SubDatasetQueryParameters.subdatasetBands" } ], "responses": { "200": { "description": "Return an image.", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "TilerTileMatrixSets_GetZxyScaleByFormat": { "$ref": "./examples/TilerTileMatrixSets_GetZxyScaleByFormat.json" } } } }, "/data/legend/classmap/{classmapName}": { "get": { "operationId": "MapsClassMapLegends_Get", "tags": [ "Map Legends" ], "summary": "Get ClassMap Legend", "description": "Generate values and color swatches mapping for a given classmap.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "classmapName", "in": "path", "description": "classmap name", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "trim_start", "in": "query", "description": "Number of items to trim from the start of the cmap", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "trimStart" }, { "name": "trim_end", "in": "query", "description": "Number of items to trim from the end of the cmap", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "trimEnd" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ClassMapLegendResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "MapsClassMapLegends_Get": { "$ref": "./examples/MapsClassMapLegends_Get.json" } } } }, "/data/legend/colormap/{colorMapName}": { "get": { "operationId": "MapsLegends_Get", "tags": [ "Map Legends" ], "summary": "Get Legend", "description": "Generate a legend image for a given colormap.\n\nIf the colormap has non-contiguous values at the beginning or end,\nwhich aren't desired in the output image, they can be trimmed by specifying\nthe number of values to trim.", "produces": [ "image/png", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "colorMapName", "in": "path", "description": "The name of the registered colormap to generate a legend for", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "height", "in": "query", "description": "The output height of the legend image", "required": false, "type": "number", "format": "float", "default": 0.15 }, { "name": "width", "in": "query", "description": "The output width of the legend image", "required": false, "type": "number", "format": "float", "default": 5 }, { "name": "trim_start", "in": "query", "description": "Number of items to trim from the start of the cmap", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "trimStart" }, { "name": "trim_end", "in": "query", "description": "Number of items to trim from the end of the cmap", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "trimEnd" } ], "responses": { "200": { "description": "Return an image.", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "MapsLegends_Get": { "$ref": "./examples/MapsLegends_Get.json" } } } }, "/data/legend/interval/{classmapName}": { "get": { "operationId": "MapsIntervalLegends_GetByClassMapName", "tags": [ "Map Legends" ], "summary": "Get Interval Legend", "description": "Generate values and color swatches mapping for a given interval classmap.\n\nReturns a color map for intervals, where each interval is defined by:\n- A numeric range `[min, max]` representing the interval boundaries.\n- An RGBA color `[red, green, blue, alpha]` associated with the interval.\n\nThe response is a 2D array of interval definitions, where each element is a pair:\n- The first element is an array of two numbers `[min, max]` defining the interval.\n- The second element is an array of four numbers `[red, green, blue, alpha]` defining the RGBA color.\n\nExample:\n```json\n[\n [\n [-2, 0], [0, 0, 0, 0]\n ],\n [\n [1, 32], [255, 255, 178, 255]\n ]\n]\n```\nThis example defines two intervals:\n- The interval `[-2, 0]` is mapped to the color `[0, 0, 0, 0]` (transparent black).\n- The interval `[1, 32]` is mapped to the color `[255, 255, 178, 255]` (opaque yellow).", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "classmapName", "in": "path", "description": "classmap name", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "trim_start", "in": "query", "description": "Number of items to trim from the start of the cmap", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "trimStart" }, { "name": "trim_end", "in": "query", "description": "Number of items to trim from the end of the cmap", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "trimEnd" } ], "responses": { "200": { "description": "Interval legend response model.\n\nRepresents a color map for intervals, where each interval is defined by:\n- A numeric range `[min, max]` representing the interval boundaries.\n- An RGBA color `[red, green, blue, alpha]` associated with the interval.\n\nThe response is a 2D array of interval definitions, where each element is a pair:\n- The first element is an array of two numbers `[min, max]` defining the interval.\n- The second element is an array of four numbers `[red, green, blue, alpha]` defining the RGBA color.\n\nExample:\n```json\n[\n [\n [-2, 0], [0, 0, 0, 0]\n ],\n [\n [1, 32], [255, 255, 178, 255]\n ]\n]\n```\nThis example defines two intervals:\n- The interval `[-2, 0]` is mapped to the color `[0, 0, 0, 0]` (transparent black).\n- The interval `[1, 32]` is mapped to the color `[255, 255, 178, 255]` (opaque yellow).", "schema": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "integer", "format": "int64" } } } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "MapsIntervalLegends_GetByClassMapName": { "$ref": "./examples/MapsIntervalLegends_GetByClassMapName.json" } } } }, "/data/mosaic/{searchId}/{tileMatrixSetId}/WMTSCapabilities.xml": { "get": { "operationId": "MosaicsWmtsMosaicsTileMatrixSets_GetCapabilitiesXml", "tags": [ "Tiles for STAC Collections Mosaics" ], "summary": "Wmts Tilematrixsetid As Path (Deprecated)", "description": "OGC WMTS endpoint.\n\nNote: If you are using stable API version 2026-04-15, please use `/data/mosaic/searches/{searchId}/{tileMatrixSetId}/WMTSCapabilities.xml` instead. The old endpoint is associated with the preview API version, which is deprecated and will be removed in a future release.", "produces": [ "application/xml", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "searchId", "in": "path", "description": "Search Id (pgSTAC Search Hash)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "tileMatrixSetId", "in": "path", "description": "Identifier selecting one of the TileMatrixSetId supported", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "tile_format", "in": "query", "description": "Output image type. Default is png.", "required": false, "type": "string", "default": "png", "enum": [ "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw" ], "x-ms-enum": { "name": "TilerImageFormat", "modelAsString": true, "values": [ { "name": "png", "value": "png", "description": "Portable Network Graphics format - supports transparency" }, { "name": "npy", "value": "npy", "description": "NumPy array format for raw data access" }, { "name": "tif", "value": "tif", "description": "GeoTIFF format for georeferenced raster data" }, { "name": "jpeg", "value": "jpeg", "description": "JPEG format - smaller file size but lossy compression" }, { "name": "jpg", "value": "jpg", "description": "Alternate extension for JPEG format" }, { "name": "jp2", "value": "jp2", "description": "JPEG 2000 format - supports both lossy and lossless compression" }, { "name": "webp", "value": "webp", "description": "WebP format - modern image format with good compression" }, { "name": "pngraw", "value": "pngraw", "description": "Raw PNG format for access to unprocessed data" } ] }, "x-ms-client-name": "tileFormat" }, { "name": "tile_scale", "in": "query", "description": "Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512).", "required": false, "type": "integer", "format": "int32", "default": 1, "x-ms-client-name": "tileScale" }, { "$ref": "#/parameters/ZoomQueryParameters.minZoom" }, { "$ref": "#/parameters/ZoomQueryParameters.maxZoom" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.buffer" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.colorFormula" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.resampling" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" } ], "responses": { "200": { "description": "Successful Response", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "MosaicsWmtsMosaicsTileMatrixSets_GetCapabilitiesXml": { "$ref": "./examples/MosaicsWmtsMosaicsTileMatrixSets_GetCapabilitiesXml.json" } } } }, "/data/mosaic/{searchId}/{longitude},{latitude}/assets": { "get": { "operationId": "MosaicsAssetsForPoints_GetPointAssets", "tags": [ "Tiles for STAC Collections Mosaics" ], "summary": "Assets For Point (Deprecated)", "description": "Return a list of assets for a given point.\n\nNote: If you are using stable API version 2026-04-15, please use `/data/mosaic/searches/{searchId}/{longitude},{latitude}/assets` instead. The old endpoint is associated with the preview API version, which is deprecated and will be removed in a future release.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "searchId", "in": "path", "description": "Search Id (pgSTAC Search Hash)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.scanLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.itemsLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.timeLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.exitWhenFull" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.skipCovered" }, { "name": "longitude", "in": "path", "description": "Longitude", "required": true, "type": "number", "format": "float" }, { "name": "latitude", "in": "path", "description": "Latitude", "required": true, "type": "number", "format": "float" }, { "name": "coord-crs", "in": "query", "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "required": false, "type": "string", "x-ms-client-name": "coordinateReferenceSystem" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "type": "array", "items": { "$ref": "#/definitions/StacItemPointAsset" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "MosaicsAssetsForPoints_GetPointAssets": { "$ref": "./examples/MosaicsAssetsForPoints_GetPointAssets.json" } } } }, "/data/mosaic/{searchId}/{tileMatrixSetId}/tilejson.json": { "get": { "operationId": "MosaicsTileMatrixSetsTileJson_Get", "tags": [ "Tiles for STAC Collections Mosaics" ], "summary": "TileJson Tilematrixsetid As Path (Deprecated)", "description": "Return TileJSON document for a searchId.\n\nNote: If you are using stable API version 2026-04-15, please use `/data/mosaic/searches/{searchId}/{tileMatrixSetId}/tilejson.json` instead. The old endpoint is associated with the preview API version, which is deprecated and will be removed in a future release.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.scanLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.itemsLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.timeLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.exitWhenFull" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.skipCovered" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "searchId", "in": "path", "description": "Search Id (pgSTAC Search Hash)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "tileMatrixSetId", "in": "path", "description": "Identifier selecting one of the TileMatrixSetId supported", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/ZoomQueryParameters.minZoom" }, { "$ref": "#/parameters/ZoomQueryParameters.maxZoom" }, { "name": "tile_format", "in": "query", "description": "Default will be automatically defined if the output image needs a mask (png) or\nnot (jpeg).", "required": false, "type": "string", "enum": [ "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw" ], "x-ms-enum": { "name": "TilerImageFormat", "modelAsString": true, "values": [ { "name": "png", "value": "png", "description": "Portable Network Graphics format - supports transparency" }, { "name": "npy", "value": "npy", "description": "NumPy array format for raw data access" }, { "name": "tif", "value": "tif", "description": "GeoTIFF format for georeferenced raster data" }, { "name": "jpeg", "value": "jpeg", "description": "JPEG format - smaller file size but lossy compression" }, { "name": "jpg", "value": "jpg", "description": "Alternate extension for JPEG format" }, { "name": "jp2", "value": "jp2", "description": "JPEG 2000 format - supports both lossy and lossless compression" }, { "name": "webp", "value": "webp", "description": "WebP format - modern image format with good compression" }, { "name": "pngraw", "value": "pngraw", "description": "Raw PNG format for access to unprocessed data" } ] }, "x-ms-client-name": "tileFormat" }, { "name": "tile_scale", "in": "query", "description": "Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512).", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "tileScale" }, { "$ref": "#/parameters/MosaicTileQueryParameters.buffer" }, { "$ref": "#/parameters/MosaicTileQueryParameters.colorFormula" }, { "$ref": "#/parameters/MosaicTileQueryParameters.collection" }, { "$ref": "#/parameters/MosaicTileQueryParameters.resampling" }, { "$ref": "#/parameters/MosaicTileQueryParameters.pixelSelection" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TileJsonMetadata" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "MosaicsTileMatrixSetsTileJson_Get": { "$ref": "./examples/MosaicsTileMatrixSetsTileJson_Get.json" } } } }, "/data/mosaic/{searchId}/WMTSCapabilities.xml": { "get": { "operationId": "MosaicsWmtsMosaics_GetCapabilitiesXml", "tags": [ "Tiles for STAC Collections Mosaics" ], "summary": "Wmts (Deprecated)", "description": "OGC WMTS endpoint.\n\nNote: If you are using stable API version 2026-04-15, please use `/data/mosaic/searches/{searchId}/WMTSCapabilities.xml` instead. The old endpoint is associated with the preview API version, which is deprecated and will be removed in a future release.", "produces": [ "application/xml", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "searchId", "in": "path", "description": "Search Id (pgSTAC Search Hash)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "tileMatrixSetId", "in": "query", "description": "Identifier selecting one of the TileMatrixSetId supported (default:\n'WebMercatorQuad')", "required": false, "type": "string", "default": "WebMercatorQuad", "enum": [ "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "x-ms-enum": { "name": "TileMatrixSetId", "modelAsString": true, "values": [ { "name": "CanadianNAD83_LCC", "value": "CanadianNAD83_LCC", "description": "Canadian NAD83 Lambert Conformal Conic projection tile matrix set" }, { "name": "EuropeanETRS89_LAEAQuad", "value": "EuropeanETRS89_LAEAQuad", "description": "European ETRS89 Lambert Azimuthal Equal Area Quad tile matrix set" }, { "name": "LINZAntarticaMapTilegrid", "value": "LINZAntarticaMapTilegrid", "description": "Land Information New Zealand (LINZ) Antarctica Map tile grid matrix set" }, { "name": "NZTM2000Quad", "value": "NZTM2000Quad", "description": "New Zealand Transverse Mercator 2000 Quad tile matrix set" }, { "name": "UPSAntarcticWGS84Quad", "value": "UPSAntarcticWGS84Quad", "description": "Universal Polar Stereographic Antarctic WGS84 Quad tile matrix set" }, { "name": "UPSArcticWGS84Quad", "value": "UPSArcticWGS84Quad", "description": "Universal Polar Stereographic Arctic WGS84 Quad tile matrix set" }, { "name": "UTM31WGS84Quad", "value": "UTM31WGS84Quad", "description": "Universal Transverse Mercator Zone 31 WGS84 Quad tile matrix set" }, { "name": "WGS1984Quad", "value": "WGS1984Quad", "description": "WGS 1984 Quad tile matrix set" }, { "name": "WebMercatorQuad", "value": "WebMercatorQuad", "description": "Web Mercator Quad tile matrix set" }, { "name": "WorldCRS84Quad", "value": "WorldCRS84Quad", "description": "World CRS84 Quad tile matrix set" }, { "name": "WorldMercatorWGS84Quad", "value": "WorldMercatorWGS84Quad", "description": "World Mercator WGS84 Quad tile matrix set" } ] } }, { "name": "tile_format", "in": "query", "description": "Output image type. Default is png.", "required": false, "type": "string", "default": "png", "enum": [ "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw" ], "x-ms-enum": { "name": "TilerImageFormat", "modelAsString": true, "values": [ { "name": "png", "value": "png", "description": "Portable Network Graphics format - supports transparency" }, { "name": "npy", "value": "npy", "description": "NumPy array format for raw data access" }, { "name": "tif", "value": "tif", "description": "GeoTIFF format for georeferenced raster data" }, { "name": "jpeg", "value": "jpeg", "description": "JPEG format - smaller file size but lossy compression" }, { "name": "jpg", "value": "jpg", "description": "Alternate extension for JPEG format" }, { "name": "jp2", "value": "jp2", "description": "JPEG 2000 format - supports both lossy and lossless compression" }, { "name": "webp", "value": "webp", "description": "WebP format - modern image format with good compression" }, { "name": "pngraw", "value": "pngraw", "description": "Raw PNG format for access to unprocessed data" } ] }, "x-ms-client-name": "tileFormat" }, { "name": "tile_scale", "in": "query", "description": "Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512).", "required": false, "type": "integer", "format": "int32", "default": 1, "x-ms-client-name": "tileScale" }, { "$ref": "#/parameters/ZoomQueryParameters.minZoom" }, { "$ref": "#/parameters/ZoomQueryParameters.maxZoom" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.buffer" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.colorFormula" }, { "$ref": "#/parameters/TileMatrixSetQueryParameters.resampling" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" } ], "responses": { "200": { "description": "Successful Response", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "MosaicsWmtsMosaics_GetCapabilitiesXml": { "$ref": "./examples/MosaicsWmtsMosaics_GetCapabilitiesXml.json" } } } }, "/data/mosaic/{searchId}/info": { "get": { "operationId": "MosaicsInfoSearch_Get", "tags": [ "Tiles for STAC Collections Mosaics" ], "summary": "Info Search (Deprecated)", "description": "Get Search query metadata.\n\nNote: If you are using stable API version 2026-04-15, please use `/data/mosaic/searches/{searchId}/info` instead. The old endpoint is associated with the preview API version, which is deprecated and will be removed in a future release.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "searchId", "in": "path", "description": "Search Id (pgSTAC Search Hash)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TilerStacSearchRegistration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "MosaicsInfoSearch_Get": { "$ref": "./examples/MosaicsInfoSearch_Get.json" } } } }, "/data/mosaic/{searchId}/tilejson.json": { "get": { "operationId": "MosaicsTileJsonOperations_Get", "tags": [ "Tiles for STAC Collections Mosaics" ], "summary": "TileJson (Deprecated)", "description": "Return TileJSON document for a searchId.\n\nNote: If you are using stable API version 2026-04-15, please use `/data/mosaic/searches/{searchId}/tilejson.json` endpoints instead. The old endpoint is associated with the preview API version, which is deprecated and will be removed in a future release.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "searchId", "in": "path", "description": "Search Id (pgSTAC Search Hash)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.scanLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.itemsLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.timeLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.exitWhenFull" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.skipCovered" }, { "name": "tileMatrixSetId", "in": "query", "description": "Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad').", "required": false, "type": "string", "default": "WebMercatorQuad", "enum": [ "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "x-ms-enum": { "name": "TileMatrixSetId", "modelAsString": true, "values": [ { "name": "CanadianNAD83_LCC", "value": "CanadianNAD83_LCC", "description": "Canadian NAD83 Lambert Conformal Conic projection tile matrix set" }, { "name": "EuropeanETRS89_LAEAQuad", "value": "EuropeanETRS89_LAEAQuad", "description": "European ETRS89 Lambert Azimuthal Equal Area Quad tile matrix set" }, { "name": "LINZAntarticaMapTilegrid", "value": "LINZAntarticaMapTilegrid", "description": "Land Information New Zealand (LINZ) Antarctica Map tile grid matrix set" }, { "name": "NZTM2000Quad", "value": "NZTM2000Quad", "description": "New Zealand Transverse Mercator 2000 Quad tile matrix set" }, { "name": "UPSAntarcticWGS84Quad", "value": "UPSAntarcticWGS84Quad", "description": "Universal Polar Stereographic Antarctic WGS84 Quad tile matrix set" }, { "name": "UPSArcticWGS84Quad", "value": "UPSArcticWGS84Quad", "description": "Universal Polar Stereographic Arctic WGS84 Quad tile matrix set" }, { "name": "UTM31WGS84Quad", "value": "UTM31WGS84Quad", "description": "Universal Transverse Mercator Zone 31 WGS84 Quad tile matrix set" }, { "name": "WGS1984Quad", "value": "WGS1984Quad", "description": "WGS 1984 Quad tile matrix set" }, { "name": "WebMercatorQuad", "value": "WebMercatorQuad", "description": "Web Mercator Quad tile matrix set" }, { "name": "WorldCRS84Quad", "value": "WorldCRS84Quad", "description": "World CRS84 Quad tile matrix set" }, { "name": "WorldMercatorWGS84Quad", "value": "WorldMercatorWGS84Quad", "description": "World Mercator WGS84 Quad tile matrix set" } ] } }, { "name": "tile_format", "in": "query", "description": "Default will be automatically defined if the output image needs a mask (png) or\nnot (jpeg).", "required": false, "type": "string", "enum": [ "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw" ], "x-ms-enum": { "name": "TilerImageFormat", "modelAsString": true, "values": [ { "name": "png", "value": "png", "description": "Portable Network Graphics format - supports transparency" }, { "name": "npy", "value": "npy", "description": "NumPy array format for raw data access" }, { "name": "tif", "value": "tif", "description": "GeoTIFF format for georeferenced raster data" }, { "name": "jpeg", "value": "jpeg", "description": "JPEG format - smaller file size but lossy compression" }, { "name": "jpg", "value": "jpg", "description": "Alternate extension for JPEG format" }, { "name": "jp2", "value": "jp2", "description": "JPEG 2000 format - supports both lossy and lossless compression" }, { "name": "webp", "value": "webp", "description": "WebP format - modern image format with good compression" }, { "name": "pngraw", "value": "pngraw", "description": "Raw PNG format for access to unprocessed data" } ] }, "x-ms-client-name": "tileFormat" }, { "name": "tile_scale", "in": "query", "description": "Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512).", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "tileScale" }, { "$ref": "#/parameters/ZoomQueryParameters.minZoom" }, { "$ref": "#/parameters/ZoomQueryParameters.maxZoom" }, { "name": "buffer", "in": "query", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output\n**tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,\n1.0 = 258x258).", "required": false, "type": "number", "format": "float" }, { "name": "color_formula", "in": "query", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)", "required": false, "type": "string", "x-ms-client-name": "colorFormula" }, { "name": "collection", "in": "query", "description": "STAC Collection ID", "required": false, "type": "string", "x-ms-client-name": "collectionId" }, { "name": "resampling", "in": "query", "description": "Resampling method", "required": false, "type": "string", "default": "nearest", "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "x-ms-enum": { "name": "Resampling", "modelAsString": true, "values": [ { "name": "nearest", "value": "nearest", "description": "Nearest neighbor - fastest method that selects the closest pixel value" }, { "name": "bilinear", "value": "bilinear", "description": "Bilinear interpolation - calculates output values using a weighted average of 2x2 input cells" }, { "name": "cubic", "value": "cubic", "description": "Cubic interpolation - uses a weighted average of 4x4 input cells for smoother results" }, { "name": "cubic_spline", "value": "cubic_spline", "description": "Cubic spline interpolation - similar to cubic but preserves edges better" }, { "name": "lanczos", "value": "lanczos", "description": "Lanczos windowed sinc resampling - high-quality with minimal artifacts" }, { "name": "average", "value": "average", "description": "Average resampling - calculates the mean of all contributing pixels" }, { "name": "mode", "value": "mode", "description": "Mode resampling - selects the most common value from contributing pixels" }, { "name": "gauss", "value": "gauss", "description": "Gaussian weighted resampling - applies a gaussian weighting to contributing pixels" }, { "name": "rms", "value": "rms", "description": "Root mean square resampling - useful for resampling error or deviation grids" } ] } }, { "name": "pixel_selection", "in": "query", "description": "Pixel selection method.", "required": false, "type": "string", "default": "first", "enum": [ "first", "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh" ], "x-ms-enum": { "name": "PixelSelection", "modelAsString": true, "values": [ { "name": "first", "value": "first", "description": "Select pixel from the first available image" }, { "name": "highest", "value": "highest", "description": "Select pixel with the highest value" }, { "name": "lowest", "value": "lowest", "description": "Select pixel with the lowest value" }, { "name": "mean", "value": "mean", "description": "Calculate mean of available pixels" }, { "name": "median", "value": "median", "description": "Calculate median of available pixels" }, { "name": "standardDeviation", "value": "stdev", "description": "Calculate standard deviation of available pixels" }, { "name": "lastBandLow", "value": "lastbandlow", "description": "Select image with lowest value in the last band" }, { "name": "lastBandHigh", "value": "lastbandhigh", "description": "Select image with highest value in the last band" } ] }, "x-ms-client-name": "pixelSelection" }, { "name": "algorithm", "in": "query", "description": "Terrain algorithm name", "required": false, "type": "string", "enum": [ "hillshade", "contours", "normalizedIndex", "terrarium", "terrainrgb" ], "x-ms-enum": { "name": "TerrainAlgorithm", "modelAsString": true, "values": [ { "name": "hillshade", "value": "hillshade", "description": "Creates hillshade visualization from elevation data" }, { "name": "contours", "value": "contours", "description": "Generates elevation contour lines" }, { "name": "normalizedIndex", "value": "normalizedIndex", "description": "Calculates normalized difference index between bands" }, { "name": "terrarium", "value": "terrarium", "description": "Encodes elevation data in Mapbox Terrarium RGB format" }, { "name": "terrainrgb", "value": "terrainrgb", "description": "Encodes elevation data in Mapbox TerrainRGB format" } ] } }, { "name": "algorithm_params", "in": "query", "description": "Terrain algorithm parameters", "required": false, "type": "string", "x-ms-client-name": "algorithmParams" }, { "name": "rescale", "in": "query", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "colormap_name", "in": "query", "description": "Colormap name", "required": false, "type": "string", "enum": [ "accent", "accent_r", "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r", "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r", "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass", "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r", "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r", "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar", "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r", "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r", "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc", "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence", "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative", "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1", "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF", "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges", "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink", "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r", "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r", "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds", "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r", "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r", "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted", "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat", "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter", "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd", "ylorrd_r" ], "x-ms-enum": { "name": "ColorMapNames", "modelAsString": true, "values": [ { "name": "accent", "value": "accent", "description": "Accent colormap - qualitative colormap with distinct colors" }, { "name": "accent_r", "value": "accent_r", "description": "Reversed accent colormap" }, { "name": "afmhot", "value": "afmhot", "description": "Afmhot colormap - sequential black-red-yellow-white colormap" }, { "name": "afmhot_r", "value": "afmhot_r", "description": "Reversed afmhot colormap" }, { "name": "ai4g-lulc", "value": "ai4g-lulc", "description": "AI for Good land use/land cover colormap" }, { "name": "alos-fnf", "value": "alos-fnf", "description": "ALOS forest/non-forest colormap" }, { "name": "alos-palsar-mask", "value": "alos-palsar-mask", "description": "ALOS PALSAR mask colormap" }, { "name": "autumn", "value": "autumn", "description": "Autumn colormap - sequential red-orange-yellow colormap" }, { "name": "autumn_r", "value": "autumn_r", "description": "Reversed autumn colormap" }, { "name": "binary", "value": "binary", "description": "Binary colormap - simple black and white colormap" }, { "name": "binary_r", "value": "binary_r", "description": "Reversed binary colormap" }, { "name": "blues", "value": "blues", "description": "Blues colormap - sequential white to dark blue" }, { "name": "blues_r", "value": "blues_r", "description": "Reversed blues colormap" }, { "name": "bone", "value": "bone", "description": "Bone colormap - grayscale with slight blue tint" }, { "name": "bone_r", "value": "bone_r", "description": "Reversed bone colormap" }, { "name": "brbg", "value": "brbg", "description": "BrBG colormap - diverging brown to blue-green" }, { "name": "brbg_r", "value": "brbg_r", "description": "Reversed BrBG colormap" }, { "name": "brg", "value": "brg", "description": "BrG colormap - diverging brown to green" }, { "name": "brg_r", "value": "brg_r", "description": "Reversed BrG colormap" }, { "name": "bugn", "value": "bugn", "description": "BuGn colormap - sequential white to dark green" }, { "name": "bugn_r", "value": "bugn_r", "description": "Reversed BuGn colormap" }, { "name": "bupu", "value": "bupu", "description": "BuPu colormap - sequential white to dark purple" }, { "name": "bupu_r", "value": "bupu_r", "description": "Reversed BuPu colormap" }, { "name": "bwr", "value": "bwr", "description": "BWR colormap - diverging blue to red" }, { "name": "bwr_r", "value": "bwr_r", "description": "Reversed BWR colormap" }, { "name": "c-cap", "value": "c-cap", "description": "C-CAP colormap - land cover classification" }, { "name": "cfastie", "value": "cfastie", "description": "Cfastie colormap - high contrast colormap" }, { "name": "chesapeake-lc-13", "value": "chesapeake-lc-13", "description": "Chesapeake land cover 13-class colormap" }, { "name": "chesapeake-lc-7", "value": "chesapeake-lc-7", "description": "Chesapeake land cover 7-class colormap" }, { "name": "chesapeake-lu", "value": "chesapeake-lu", "description": "Chesapeake land use colormap" }, { "name": "chloris-biomass", "value": "chloris-biomass", "description": "Chloris biomass colormap" }, { "name": "cividis", "value": "cividis", "description": "Cividis colormap - sequential yellow to blue" }, { "name": "cividis_r", "value": "cividis_r", "description": "Reversed cividis colormap" }, { "name": "cmrmap", "value": "cmrmap", "description": "CMRmap colormap - perceptually uniform colormap" }, { "name": "cmrmap_r", "value": "cmrmap_r", "description": "Reversed CMRmap colormap" }, { "name": "cool", "value": "cool", "description": "Cool colormap - sequential cyan to magenta" }, { "name": "cool_r", "value": "cool_r", "description": "Reversed cool colormap" }, { "name": "coolwarm", "value": "coolwarm", "description": "Coolwarm colormap - diverging blue to red" }, { "name": "coolwarm_r", "value": "coolwarm_r", "description": "Reversed coolwarm colormap" }, { "name": "copper", "value": "copper", "description": "Copper colormap - sequential black to copper" }, { "name": "copper_r", "value": "copper_r", "description": "Reversed copper colormap" }, { "name": "cubehelix", "value": "cubehelix", "description": "Cubehelix colormap - sequential black to white with hue rotation" }, { "name": "cubehelix_r", "value": "cubehelix_r", "description": "Reversed cubehelix colormap" }, { "name": "dark2", "value": "dark2", "description": "Dark2 colormap - qualitative colormap with distinct colors" }, { "name": "dark2_r", "value": "dark2_r", "description": "Reversed dark2 colormap" }, { "name": "drcog-lulc", "value": "drcog-lulc", "description": "DRCog land use/land cover colormap" }, { "name": "esa-cci-lc", "value": "esa-cci-lc", "description": "ESA CCI land cover colormap" }, { "name": "esa-worldcover", "value": "esa-worldcover", "description": "ESA WorldCover colormap" }, { "name": "flag", "value": "flag", "description": "Flag colormap - qualitative colormap with distinct colors" }, { "name": "flag_r", "value": "flag_r", "description": "Reversed flag colormap" }, { "name": "gap-lulc", "value": "gap-lulc", "description": "GAP land use/land cover colormap" }, { "name": "gist_earth", "value": "gist_earth", "description": "Gist_earth colormap - perceptually uniform colormap" }, { "name": "gist_earth_r", "value": "gist_earth_r", "description": "Reversed gist_earth colormap" }, { "name": "gist_gray", "value": "gist_gray", "description": "Gist_gray colormap - grayscale colormap" }, { "name": "gist_gray_r", "value": "gist_gray_r", "description": "Reversed gist_gray colormap" }, { "name": "gist_heat", "value": "gist_heat", "description": "Gist_heat colormap - sequential black-red-yellow-white colormap" }, { "name": "gist_heat_r", "value": "gist_heat_r", "description": "Reversed gist_heat colormap" }, { "name": "gist_ncar", "value": "gist_ncar", "description": "Gist_ncar colormap - perceptually uniform colormap" }, { "name": "gist_ncar_r", "value": "gist_ncar_r", "description": "Reversed gist_ncar colormap" }, { "name": "gist_rainbow", "value": "gist_rainbow", "description": "Gist_rainbow colormap - perceptually uniform colormap" }, { "name": "gist_rainbow_r", "value": "gist_rainbow_r", "description": "Reversed gist_rainbow colormap" }, { "name": "gist_stern", "value": "gist_stern", "description": "Gist_stern colormap - perceptually uniform colormap" }, { "name": "gist_stern_r", "value": "gist_stern_r", "description": "Reversed gist_stern colormap" }, { "name": "gist_yarg", "value": "gist_yarg", "description": "Gist_yarg colormap - grayscale colormap" }, { "name": "gist_yarg_r", "value": "gist_yarg_r", "description": "Reversed gist_yarg colormap" }, { "name": "gnbu", "value": "gnbu", "description": "GnBu colormap - sequential white to dark blue-green" }, { "name": "gnbu_r", "value": "gnbu_r", "description": "Reversed GnBu colormap" }, { "name": "gnuplot", "value": "gnuplot", "description": "Gnuplot colormap - sequential black to white with hue rotation" }, { "name": "gnuplot2", "value": "gnuplot2", "description": "Gnuplot2 colormap - sequential black to white with hue rotation" }, { "name": "gnuplot2_r", "value": "gnuplot2_r", "description": "Reversed gnuplot2 colormap" }, { "name": "gnuplot_r", "value": "gnuplot_r", "description": "Reversed gnuplot colormap" }, { "name": "gray", "value": "gray", "description": "Gray colormap - grayscale colormap" }, { "name": "gray_r", "value": "gray_r", "description": "Reversed gray colormap" }, { "name": "greens", "value": "greens", "description": "Greens colormap - sequential white to dark green" }, { "name": "greens_r", "value": "greens_r", "description": "Reversed greens colormap" }, { "name": "greys", "value": "greys", "description": "Greys colormap - sequential white to dark gray" }, { "name": "greys_r", "value": "greys_r", "description": "Reversed greys colormap" }, { "name": "hot", "value": "hot", "description": "Hot colormap - sequential black-red-yellow-white colormap" }, { "name": "hot_r", "value": "hot_r", "description": "Reversed hot colormap" }, { "name": "hsv", "value": "hsv", "description": "HSV colormap - hue-saturation-value colormap" }, { "name": "hsv_r", "value": "hsv_r", "description": "Reversed HSV colormap" }, { "name": "inferno", "value": "inferno", "description": "Inferno colormap - sequential black to yellow colormap" }, { "name": "inferno_r", "value": "inferno_r", "description": "Reversed inferno colormap" }, { "name": "io-bii", "value": "io-bii", "description": "IO-BII colormap - biodiversity index colormap" }, { "name": "io-lulc", "value": "io-lulc", "description": "IO-LULC colormap - land use/land cover colormap" }, { "name": "io-lulc-9-class", "value": "io-lulc-9-class", "description": "IO-LULC 9-class colormap" }, { "name": "jet", "value": "jet", "description": "Jet colormap - sequential blue-green-yellow-red colormap" }, { "name": "jet_r", "value": "jet_r", "description": "Reversed jet colormap" }, { "name": "jrc-change", "value": "jrc-change", "description": "JRC change colormap" }, { "name": "jrc-extent", "value": "jrc-extent", "description": "JRC extent colormap" }, { "name": "jrc-occurrence", "value": "jrc-occurrence", "description": "JRC occurrence colormap" }, { "name": "jrc-recurrence", "value": "jrc-recurrence", "description": "JRC recurrence colormap" }, { "name": "jrc-seasonality", "value": "jrc-seasonality", "description": "JRC seasonality colormap" }, { "name": "jrc-transitions", "value": "jrc-transitions", "description": "JRC transitions colormap" }, { "name": "lidar-classification", "value": "lidar-classification", "description": "Lidar classification colormap" }, { "name": "lidar-hag", "value": "lidar-hag", "description": "Lidar height above ground colormap" }, { "name": "lidar-hag-alternative", "value": "lidar-hag-alternative", "description": "Alternative lidar height above ground colormap" }, { "name": "lidar-intensity", "value": "lidar-intensity", "description": "Lidar intensity colormap" }, { "name": "lidar-returns", "value": "lidar-returns", "description": "Lidar returns colormap" }, { "name": "magma", "value": "magma", "description": "Magma colormap - sequential black to yellow colormap" }, { "name": "magma_r", "value": "magma_r", "description": "Reversed magma colormap" }, { "name": "modis-10A1", "value": "modis-10A1", "description": "MODIS 10A1 colormap" }, { "name": "modis-10A2", "value": "modis-10A2", "description": "MODIS 10A2 colormap" }, { "name": "modis-13A1|Q1", "value": "modis-13A1|Q1", "description": "MODIS 13A1|Q1 colormap" }, { "name": "modis-14A1|A2", "value": "modis-14A1|A2", "description": "MODIS 14A1|A2 colormap" }, { "name": "modis-15A2H|A3H", "value": "modis-15A2H|A3H", "description": "MODIS 15A2H|A3H colormap" }, { "name": "modis-16A3GF-ET", "value": "modis-16A3GF-ET", "description": "MODIS 16A3GF-ET colormap" }, { "name": "modis-16A3GF-PET", "value": "modis-16A3GF-PET", "description": "MODIS 16A3GF-PET colormap" }, { "name": "modis-17A2H|A2HGF", "value": "modis-17A2H|A2HGF", "description": "MODIS 17A2H|A2HGF colormap" }, { "name": "modis-17A3HGF", "value": "modis-17A3HGF", "description": "MODIS 17A3HGF colormap" }, { "name": "modis-64A1", "value": "modis-64A1", "description": "MODIS 64A1 colormap" }, { "name": "mtbs-severity", "value": "mtbs-severity", "description": "MTBS severity colormap" }, { "name": "nipy_spectral", "value": "nipy_spectral", "description": "Nipy_spectral colormap - perceptually uniform colormap" }, { "name": "nipy_spectral_r", "value": "nipy_spectral_r", "description": "Reversed nipy_spectral colormap" }, { "name": "nrcan-lulc", "value": "nrcan-lulc", "description": "NRCAN land use/land cover colormap" }, { "name": "ocean", "value": "ocean", "description": "Ocean colormap - sequential blue to white colormap" }, { "name": "ocean_r", "value": "ocean_r", "description": "Reversed ocean colormap" }, { "name": "oranges", "value": "oranges", "description": "Oranges colormap - sequential white to dark orange" }, { "name": "oranges_r", "value": "oranges_r", "description": "Reversed oranges colormap" }, { "name": "orrd", "value": "orrd", "description": "OrRd colormap - sequential white to dark red-orange" }, { "name": "orrd_r", "value": "orrd_r", "description": "Reversed OrRd colormap" }, { "name": "paired", "value": "paired", "description": "Paired colormap - qualitative colormap with distinct colors" }, { "name": "paired_r", "value": "paired_r", "description": "Reversed paired colormap" }, { "name": "pastel1", "value": "pastel1", "description": "Pastel1 colormap - qualitative colormap with pastel colors" }, { "name": "pastel1_r", "value": "pastel1_r", "description": "Reversed pastel1 colormap" }, { "name": "pastel2", "value": "pastel2", "description": "Pastel2 colormap - qualitative colormap with pastel colors" }, { "name": "pastel2_r", "value": "pastel2_r", "description": "Reversed pastel2 colormap" }, { "name": "pink", "value": "pink", "description": "Pink colormap - sequential white to dark pink" }, { "name": "pink_r", "value": "pink_r", "description": "Reversed pink colormap" }, { "name": "piyg", "value": "piyg", "description": "PiYG colormap - diverging pink to green" }, { "name": "piyg_r", "value": "piyg_r", "description": "Reversed PiYG colormap" }, { "name": "plasma", "value": "plasma", "description": "Plasma colormap - sequential black to yellow colormap" }, { "name": "plasma_r", "value": "plasma_r", "description": "Reversed plasma colormap" }, { "name": "prgn", "value": "prgn", "description": "PRGn colormap - diverging purple to green" }, { "name": "prgn_r", "value": "prgn_r", "description": "Reversed PRGn colormap" }, { "name": "prism", "value": "prism", "description": "Prism colormap - qualitative colormap with distinct colors" }, { "name": "prism_r", "value": "prism_r", "description": "Reversed prism colormap" }, { "name": "pubu", "value": "pubu", "description": "PuBu colormap - sequential white to dark blue" }, { "name": "pubu_r", "value": "pubu_r", "description": "Reversed PuBu colormap" }, { "name": "pubugn", "value": "pubugn", "description": "PuBuGn colormap - sequential white to dark blue-green" }, { "name": "pubugn_r", "value": "pubugn_r", "description": "Reversed PuBuGn colormap" }, { "name": "puor", "value": "puor", "description": "PuOr colormap - diverging purple to orange" }, { "name": "puor_r", "value": "puor_r", "description": "Reversed PuOr colormap" }, { "name": "purd", "value": "purd", "description": "PuRd colormap - sequential white to dark purple-red" }, { "name": "purd_r", "value": "purd_r", "description": "Reversed PuRd colormap" }, { "name": "purples", "value": "purples", "description": "Purples colormap - sequential white to dark purple" }, { "name": "purples_r", "value": "purples_r", "description": "Reversed purples colormap" }, { "name": "qpe", "value": "qpe", "description": "QPE colormap - qualitative colormap with distinct colors" }, { "name": "rainbow", "value": "rainbow", "description": "Rainbow colormap - qualitative colormap with distinct colors" }, { "name": "rainbow_r", "value": "rainbow_r", "description": "Reversed rainbow colormap" }, { "name": "rdbu", "value": "rdbu", "description": "RdBu colormap - diverging red to blue" }, { "name": "rdbu_r", "value": "rdbu_r", "description": "Reversed RdBu colormap" }, { "name": "rdgy", "value": "rdgy", "description": "RdGy colormap - diverging red to gray" }, { "name": "rdgy_r", "value": "rdgy_r", "description": "Reversed RdGy colormap" }, { "name": "rdpu", "value": "rdpu", "description": "RdPu colormap - sequential white to dark red-purple" }, { "name": "rdpu_r", "value": "rdpu_r", "description": "Reversed RdPu colormap" }, { "name": "rdylbu", "value": "rdylbu", "description": "RdYlBu colormap - diverging red to yellow to blue" }, { "name": "rdylbu_r", "value": "rdylbu_r", "description": "Reversed RdYlBu colormap" }, { "name": "rdylgn", "value": "rdylgn", "description": "RdYlGn colormap - diverging red to yellow to green" }, { "name": "rdylgn_r", "value": "rdylgn_r", "description": "Reversed RdYlGn colormap" }, { "name": "reds", "value": "reds", "description": "Reds colormap - sequential white to dark red" }, { "name": "reds_r", "value": "reds_r", "description": "Reversed reds colormap" }, { "name": "rplumbo", "value": "rplumbo", "description": "Rplumbo colormap - qualitative colormap with distinct colors" }, { "name": "schwarzwald", "value": "schwarzwald", "description": "Schwarzwald colormap - qualitative colormap with distinct colors" }, { "name": "seismic", "value": "seismic", "description": "Seismic colormap - diverging blue to red" }, { "name": "seismic_r", "value": "seismic_r", "description": "Reversed seismic colormap" }, { "name": "set1", "value": "set1", "description": "Set1 colormap - qualitative colormap with distinct colors" }, { "name": "set1_r", "value": "set1_r", "description": "Reversed set1 colormap" }, { "name": "set2", "value": "set2", "description": "Set2 colormap - qualitative colormap with distinct colors" }, { "name": "set2_r", "value": "set2_r", "description": "Reversed set2 colormap" }, { "name": "set3", "value": "set3", "description": "Set3 colormap - qualitative colormap with distinct colors" }, { "name": "set3_r", "value": "set3_r", "description": "Reversed set3 colormap" }, { "name": "spectral", "value": "spectral", "description": "Spectral colormap - diverging red to yellow to blue" }, { "name": "spectral_r", "value": "spectral_r", "description": "Reversed spectral colormap" }, { "name": "spring", "value": "spring", "description": "Spring colormap - sequential magenta to yellow" }, { "name": "spring_r", "value": "spring_r", "description": "Reversed spring colormap" }, { "name": "summer", "value": "summer", "description": "Summer colormap - sequential green to yellow" }, { "name": "summer_r", "value": "summer_r", "description": "Reversed summer colormap" }, { "name": "tab10", "value": "tab10", "description": "Tab10 colormap - qualitative colormap with distinct colors" }, { "name": "tab10_r", "value": "tab10_r", "description": "Reversed tab10 colormap" }, { "name": "tab20", "value": "tab20", "description": "Tab20 colormap - qualitative colormap with distinct colors" }, { "name": "tab20_r", "value": "tab20_r", "description": "Reversed tab20 colormap" }, { "name": "tab20b", "value": "tab20b", "description": "Tab20b colormap - qualitative colormap with distinct colors" }, { "name": "tab20b_r", "value": "tab20b_r", "description": "Reversed tab20b colormap" }, { "name": "tab20c", "value": "tab20c", "description": "Tab20c colormap - qualitative colormap with distinct colors" }, { "name": "tab20c_r", "value": "tab20c_r", "description": "Reversed tab20c colormap" }, { "name": "terrain", "value": "terrain", "description": "Terrain colormap - sequential black to white with hue rotation" }, { "name": "terrain_r", "value": "terrain_r", "description": "Reversed terrain colormap" }, { "name": "twilight", "value": "twilight", "description": "Twilight colormap - diverging blue to red" }, { "name": "twilight_r", "value": "twilight_r", "description": "Reversed twilight colormap" }, { "name": "twilight_shifted", "value": "twilight_shifted", "description": "Twilight shifted colormap - diverging blue to red" }, { "name": "twilight_shifted_r", "value": "twilight_shifted_r", "description": "Reversed twilight shifted colormap" }, { "name": "usda-cdl", "value": "usda-cdl", "description": "USDA CDL colormap - land cover classification" }, { "name": "usda-cdl-corn", "value": "usda-cdl-corn", "description": "USDA CDL corn colormap" }, { "name": "usda-cdl-cotton", "value": "usda-cdl-cotton", "description": "USDA CDL cotton colormap" }, { "name": "usda-cdl-soybeans", "value": "usda-cdl-soybeans", "description": "USDA CDL soybeans colormap" }, { "name": "usda-cdl-wheat", "value": "usda-cdl-wheat", "description": "USDA CDL wheat colormap" }, { "name": "usgs-lcmap", "value": "usgs-lcmap", "description": "USGS LCMAP colormap" }, { "name": "viirs-10a1", "value": "viirs-10a1", "description": "VIIRS 10A1 colormap" }, { "name": "viirs-13a1", "value": "viirs-13a1", "description": "VIIRS 13A1 colormap" }, { "name": "viirs-14a1", "value": "viirs-14a1", "description": "VIIRS 14A1 colormap" }, { "name": "viirs-15a2H", "value": "viirs-15a2H", "description": "VIIRS 15A2H colormap" }, { "name": "viridis", "value": "viridis", "description": "Viridis colormap - sequential black to yellow colormap" }, { "name": "viridis_r", "value": "viridis_r", "description": "Reversed viridis colormap" }, { "name": "winter", "value": "winter", "description": "Winter colormap - sequential blue to green" }, { "name": "winter_r", "value": "winter_r", "description": "Reversed winter colormap" }, { "name": "wistia", "value": "wistia", "description": "Wistia colormap - sequential white to yellow" }, { "name": "wistia_r", "value": "wistia_r", "description": "Reversed wistia colormap" }, { "name": "ylgn", "value": "ylgn", "description": "YlGn colormap - sequential white to dark green" }, { "name": "ylgn_r", "value": "ylgn_r", "description": "Reversed YlGn colormap" }, { "name": "ylgnbu", "value": "ylgnbu", "description": "YlGnBu colormap - sequential white to dark blue-green" }, { "name": "ylgnbu_r", "value": "ylgnbu_r", "description": "Reversed YlGnBu colormap" }, { "name": "ylorbr", "value": "ylorbr", "description": "YlOrBr colormap - sequential white to dark orange-brown" }, { "name": "ylorbr_r", "value": "ylorbr_r", "description": "Reversed YlOrBr colormap" }, { "name": "ylorrd", "value": "ylorrd", "description": "YlOrRd colormap - sequential white to dark red-orange" }, { "name": "ylorrd_r", "value": "ylorrd_r", "description": "Reversed YlOrRd colormap" } ] }, "x-ms-client-name": "colormapName" }, { "name": "colormap", "in": "query", "description": "JSON encoded custom Colormap", "required": false, "type": "string" }, { "name": "return_mask", "in": "query", "description": "Add mask to the output data.", "required": false, "type": "boolean", "default": true, "x-ms-client-name": "returnMask" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TileJsonMetadata" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "MosaicsTileJsonOperations_Get": { "$ref": "./examples/MosaicsTileJsonOperations_Get.json" } } } }, "/data/mosaic/{searchId}/tiles/{z}/{x}/{y}@{scale}x.{format}": { "get": { "operationId": "MosaicsTiles_GetZxyScaleByFormat", "tags": [ "Tiles for STAC Collections Mosaics" ], "summary": "Tile (Deprecated)", "description": "Create map tile.\n\nNote: If you are using stable API version 2026-04-15, please use `/data/mosaic/searches/{searchId}/tiles/{z}/{x}/{y}@{scale}x.{format}` endpoints instead. The old endpoint is associated with the preview API version, which is deprecated and will be removed in a future release.", "produces": [ "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "searchId", "in": "path", "description": "Search Id (pgSTAC Search Hash)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.scanLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.itemsLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.timeLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.exitWhenFull" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.skipCovered" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "$ref": "#/parameters/ZxyPathParameters.z" }, { "$ref": "#/parameters/ZxyPathParameters.x" }, { "$ref": "#/parameters/ZxyPathParameters.y" }, { "name": "tileMatrixSetId", "in": "query", "description": "Identifier selecting one of the TileMatrixSetId supported (default:\n'WebMercatorQuad')", "required": false, "type": "string", "default": "WebMercatorQuad", "enum": [ "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "x-ms-enum": { "name": "TileMatrixSetId", "modelAsString": true, "values": [ { "name": "CanadianNAD83_LCC", "value": "CanadianNAD83_LCC", "description": "Canadian NAD83 Lambert Conformal Conic projection tile matrix set" }, { "name": "EuropeanETRS89_LAEAQuad", "value": "EuropeanETRS89_LAEAQuad", "description": "European ETRS89 Lambert Azimuthal Equal Area Quad tile matrix set" }, { "name": "LINZAntarticaMapTilegrid", "value": "LINZAntarticaMapTilegrid", "description": "Land Information New Zealand (LINZ) Antarctica Map tile grid matrix set" }, { "name": "NZTM2000Quad", "value": "NZTM2000Quad", "description": "New Zealand Transverse Mercator 2000 Quad tile matrix set" }, { "name": "UPSAntarcticWGS84Quad", "value": "UPSAntarcticWGS84Quad", "description": "Universal Polar Stereographic Antarctic WGS84 Quad tile matrix set" }, { "name": "UPSArcticWGS84Quad", "value": "UPSArcticWGS84Quad", "description": "Universal Polar Stereographic Arctic WGS84 Quad tile matrix set" }, { "name": "UTM31WGS84Quad", "value": "UTM31WGS84Quad", "description": "Universal Transverse Mercator Zone 31 WGS84 Quad tile matrix set" }, { "name": "WGS1984Quad", "value": "WGS1984Quad", "description": "WGS 1984 Quad tile matrix set" }, { "name": "WebMercatorQuad", "value": "WebMercatorQuad", "description": "Web Mercator Quad tile matrix set" }, { "name": "WorldCRS84Quad", "value": "WorldCRS84Quad", "description": "World CRS84 Quad tile matrix set" }, { "name": "WorldMercatorWGS84Quad", "value": "WorldMercatorWGS84Quad", "description": "World Mercator WGS84 Quad tile matrix set" } ] } }, { "name": "scale", "in": "path", "description": "Numeric scale factor for the tile. Higher values produce larger tiles (default: \"1\")", "required": true, "type": "number", "format": "float" }, { "name": "format", "in": "path", "description": "Output format for the tile or image (e.g., png, jpeg, webp) (default: \"png\").", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/MosaicTileQueryParameters.buffer" }, { "$ref": "#/parameters/MosaicTileQueryParameters.colorFormula" }, { "$ref": "#/parameters/MosaicTileQueryParameters.collection" }, { "$ref": "#/parameters/MosaicTileQueryParameters.resampling" }, { "$ref": "#/parameters/MosaicTileQueryParameters.pixelSelection" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" } ], "responses": { "200": { "description": "Return an image.", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "MosaicsTiles_GetZxyScaleByFormat": { "$ref": "./examples/MosaicsTiles_GetZxyScaleByFormat.json" } } } }, "/data/mosaic/{searchId}/tiles/{tileMatrixSetId}/{z}/{x}/{y}@{scale}x.{format}": { "get": { "operationId": "MosaicsTileMatrixSets_GetZxyScaleByFormat", "tags": [ "Tiles for STAC Collections Mosaics" ], "summary": "Tile Tilematrixsetid As Path (Deprecated)", "description": "Create map tile.\n\nNote: If you are using stable API version 2026-04-15, please use `/data/mosaic/searches/{searchId}/tiles/{tileMatrixSetId}/{z}/{x}/{y}@{scale}x.{format}` endpoints instead. The old endpoint is associated with the preview API version, which is deprecated and will be removed in a future release.", "produces": [ "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/AssetQueryParameters.assets" }, { "$ref": "#/parameters/AssetQueryParameters.expression" }, { "$ref": "#/parameters/AssetQueryParameters.assetBandIndices" }, { "$ref": "#/parameters/AssetQueryParameters.assetAsBand" }, { "$ref": "#/parameters/AssetQueryParameters.noData" }, { "$ref": "#/parameters/AssetQueryParameters.unscale" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.scanLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.itemsLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.timeLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.exitWhenFull" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.skipCovered" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithm" }, { "$ref": "#/parameters/TerrainAlgorithmQueryParameters.algorithmParams" }, { "name": "searchId", "in": "path", "description": "Search Id (pgSTAC Search Hash)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "tileMatrixSetId", "in": "path", "description": "Identifier selecting one of the TileMatrixSetId supported", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/ZxyPathParameters.z" }, { "$ref": "#/parameters/ZxyPathParameters.x" }, { "$ref": "#/parameters/ZxyPathParameters.y" }, { "name": "scale", "in": "path", "description": "Numeric scale factor for the tile. Higher values produce larger tiles", "required": true, "type": "number", "format": "float" }, { "name": "format", "in": "path", "description": "Output format for the tile or image (e.g., png, jpeg, webp)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/MosaicTileQueryParameters.buffer" }, { "$ref": "#/parameters/MosaicTileQueryParameters.colorFormula" }, { "$ref": "#/parameters/MosaicTileQueryParameters.collection" }, { "$ref": "#/parameters/MosaicTileQueryParameters.resampling" }, { "$ref": "#/parameters/MosaicTileQueryParameters.pixelSelection" }, { "$ref": "#/parameters/MiscTileQueryParameters.rescale" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMapName" }, { "$ref": "#/parameters/MiscTileQueryParameters.colorMap" }, { "$ref": "#/parameters/MiscTileQueryParameters.returnMask" } ], "responses": { "200": { "description": "Return an image.", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "MosaicsTileMatrixSets_GetZxyScaleByFormat": { "$ref": "./examples/MosaicsTileMatrixSets_GetZxyScaleByFormat.json" } } } }, "/data/mosaic/{searchId}/tiles/{tileMatrixSetId}/{z}/{x}/{y}/assets": { "get": { "operationId": "MosaicsAssetsForTileMatrixSets_GetZxyAssets", "tags": [ "Tiles for STAC Collections Mosaics" ], "summary": "Assets For Tile Tilematrixsetid As Path (Deprecated)", "description": "Return a list of assets which overlap a given tile\n\nNote: If you are using stable API version 2026-04-15, please use `/data/mosaic/searches/{searchId}/tiles/{tileMatrixSetId}/{z}/{x}/{y}/assets` instead. The old endpoint is associated with the preview API version, which is deprecated and will be removed in a future release.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "searchId", "in": "path", "description": "Search Id (pgSTAC Search Hash)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.scanLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.itemsLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.timeLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.exitWhenFull" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.skipCovered" }, { "name": "tileMatrixSetId", "in": "path", "description": "Identifier selecting one of the TileMatrixSetId supported", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "collection", "in": "query", "description": "STAC Collection Identifier", "required": true, "type": "string", "maxLength": 500, "pattern": ".*", "x-ms-client-name": "collectionId" }, { "$ref": "#/parameters/ZxyPathParameters.z" }, { "$ref": "#/parameters/ZxyPathParameters.x" }, { "$ref": "#/parameters/ZxyPathParameters.y" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "type": "array", "items": { "$ref": "#/definitions/TilerAssetGeoJson" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "MosaicsAssetsForTileMatrixSets_GetZxyAssets": { "$ref": "./examples/MosaicsAssetsForTileMatrixSets_GetZxyAssets.json" } } } }, "/data/mosaic/{searchId}/tiles/{z}/{x}/{y}/assets": { "get": { "operationId": "MosaicsAssetsForTiles_GetZxyAssets", "tags": [ "Tiles for STAC Collections Mosaics" ], "summary": "Assets For Tile (Deprecated)", "description": "Return a list of assets which overlap a given tile\n\nNote: If you are using stable API version 2026-04-15, please use `/data/mosaic/searches/{searchId}/tiles/{z}/{x}/{y}/assets` instead. The old endpoint is associated with the preview API version, which is deprecated and will be removed in a future release.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "searchId", "in": "path", "description": "Search Id (pgSTAC Search Hash)", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.scanLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.itemsLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.timeLimit" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.exitWhenFull" }, { "$ref": "#/parameters/MosaicSearchQueryParameters.skipCovered" }, { "$ref": "#/parameters/ZxyPathParameters.z" }, { "$ref": "#/parameters/ZxyPathParameters.x" }, { "$ref": "#/parameters/ZxyPathParameters.y" }, { "name": "tileMatrixSetId", "in": "query", "description": "Identifier selecting one of the TileMatrixSetId supported (default:\n'WebMercatorQuad')", "required": false, "type": "string", "default": "WebMercatorQuad", "enum": [ "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "x-ms-enum": { "name": "TileMatrixSetId", "modelAsString": true, "values": [ { "name": "CanadianNAD83_LCC", "value": "CanadianNAD83_LCC", "description": "Canadian NAD83 Lambert Conformal Conic projection tile matrix set" }, { "name": "EuropeanETRS89_LAEAQuad", "value": "EuropeanETRS89_LAEAQuad", "description": "European ETRS89 Lambert Azimuthal Equal Area Quad tile matrix set" }, { "name": "LINZAntarticaMapTilegrid", "value": "LINZAntarticaMapTilegrid", "description": "Land Information New Zealand (LINZ) Antarctica Map tile grid matrix set" }, { "name": "NZTM2000Quad", "value": "NZTM2000Quad", "description": "New Zealand Transverse Mercator 2000 Quad tile matrix set" }, { "name": "UPSAntarcticWGS84Quad", "value": "UPSAntarcticWGS84Quad", "description": "Universal Polar Stereographic Antarctic WGS84 Quad tile matrix set" }, { "name": "UPSArcticWGS84Quad", "value": "UPSArcticWGS84Quad", "description": "Universal Polar Stereographic Arctic WGS84 Quad tile matrix set" }, { "name": "UTM31WGS84Quad", "value": "UTM31WGS84Quad", "description": "Universal Transverse Mercator Zone 31 WGS84 Quad tile matrix set" }, { "name": "WGS1984Quad", "value": "WGS1984Quad", "description": "WGS 1984 Quad tile matrix set" }, { "name": "WebMercatorQuad", "value": "WebMercatorQuad", "description": "Web Mercator Quad tile matrix set" }, { "name": "WorldCRS84Quad", "value": "WorldCRS84Quad", "description": "World CRS84 Quad tile matrix set" }, { "name": "WorldMercatorWGS84Quad", "value": "WorldMercatorWGS84Quad", "description": "World Mercator WGS84 Quad tile matrix set" } ] } } ], "responses": { "200": { "description": "Return list of assets", "schema": { "type": "array", "items": {} } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "deprecated": true, "x-ms-examples": { "MosaicsAssetsForTiles_GetZxyAssets": { "$ref": "./examples/MosaicsAssetsForTiles_GetZxyAssets.json" } } } }, "/data/mosaic/register": { "post": { "operationId": "MosaicsRegisterSearch_Register", "tags": [ "Tiles for STAC Searches" ], "summary": "Register Search", "description": "Register a Search query", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RegisterMosaic" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TilerMosaicSearchRegistrationResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "MosaicsRegisterSearch_Register": { "$ref": "./examples/MosaicsRegisterSearch_Register.json" } } } }, "/data/tile-matrix-sets": { "get": { "operationId": "TileMatrixList_Get", "tags": [ "Tile Matrix Sets" ], "summary": "Matrix List", "description": "Return Matrix List", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "type": "array", "items": { "type": "string" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "TileMatrixList_Get": { "$ref": "./examples/TileMatrixList_Get.json" } } } }, "/data/tile-matrix-sets/{tileMatrixSetId}": { "get": { "operationId": "TileMatrixDefinitions_Get", "tags": [ "Tile Matrix Sets" ], "summary": "Matrix Definition", "description": "Return Matrix Definition", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "tileMatrixSetId", "in": "path", "description": "Identifier selecting one of the TileMatrixSetId supported", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TileMatrixSet" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "TileMatrixDefinitions_Get": { "$ref": "./examples/TileMatrixDefinitions_Get.json" } } } }, "/inma/collections/{collectionId}/ingestions": { "get": { "operationId": "Ingestions_List", "tags": [ "Ingestion Management" ], "description": "Get ingestions of a catalog", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" }, { "$ref": "#/parameters/OdataQuery.top" }, { "$ref": "#/parameters/OdataQuery.skip" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/IngestionDefinitionPagedResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Ingestions_List": { "$ref": "./examples/Ingestions_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } }, "post": { "operationId": "Ingestions_Create", "tags": [ "Ingestion Management" ], "description": "Create a new ingestion", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" }, { "name": "body", "in": "body", "description": "Definition of the ingestion", "required": true, "schema": { "$ref": "#/definitions/IngestionDefinition" } } ], "responses": { "201": { "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "$ref": "#/definitions/IngestionDefinition" }, "headers": { "location": { "type": "string", "format": "uri", "description": "Url of the created ingestion" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Ingestions_Create": { "$ref": "./examples/Ingestions_Create.json" } } } }, "/inma/collections/{collectionId}/ingestions/{ingestionId}": { "get": { "operationId": "Ingestions_Get", "tags": [ "Ingestion Management" ], "description": "Get the definition of an ingestion", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" }, { "$ref": "#/parameters/IngestionParameters.ingestionId" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/IngestionDefinition" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Ingestions_Get": { "$ref": "./examples/Ingestions_Get.json" } } }, "patch": { "operationId": "Ingestions_Update", "tags": [ "Ingestion Management" ], "description": "Update an existing ingestion", "consumes": [ "application/merge-patch+json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" }, { "$ref": "#/parameters/IngestionParameters.ingestionId" }, { "name": "body", "in": "body", "description": "Ingestion properties to update", "required": true, "schema": { "$ref": "#/definitions/IngestionDefinitionUpdate" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/IngestionDefinition" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Ingestions_Update": { "$ref": "./examples/Ingestions_Update.json" } } }, "delete": { "operationId": "Ingestions_Delete", "tags": [ "Ingestion Management" ], "description": "Delete an ingestion from a catalog. All runs of the ingestion will be deleted. Ingestion must not have any runs in progress or queued.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" }, { "$ref": "#/parameters/IngestionParameters.ingestionId" } ], "responses": { "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/Operation" }, "headers": { "location": { "type": "string", "format": "uri", "description": "Url used to monitor the background operation" }, "operation-location": { "type": "string", "format": "uri", "description": "Url used to monitor the background operation" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Ingestions_Delete": { "$ref": "./examples/Ingestions_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/inma/collections/{collectionId}/ingestions/{ingestionId}/runs": { "get": { "operationId": "IngestionRuns_List", "tags": [ "Ingestion Management" ], "description": "Get the runs of an ingestion", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" }, { "$ref": "#/parameters/IngestionParameters.ingestionId" }, { "$ref": "#/parameters/OdataQuery.top" }, { "$ref": "#/parameters/OdataQuery.skip" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/IngestionRunPagedResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IngestionRuns_List": { "$ref": "./examples/IngestionRuns_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } }, "post": { "operationId": "IngestionRuns_Create", "tags": [ "Ingestion Management" ], "description": "Create a new run of an ingestion", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" }, { "$ref": "#/parameters/IngestionParameters.ingestionId" } ], "responses": { "201": { "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "$ref": "#/definitions/IngestionRun" }, "headers": { "location": { "type": "string", "format": "uri", "description": "Url of the created ingestion run" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IngestionRuns_Create": { "$ref": "./examples/IngestionRuns_Create.json" } } } }, "/inma/collections/{collectionId}/ingestions/{ingestionId}/runs/{runId}": { "get": { "operationId": "IngestionRuns_Get", "tags": [ "Ingestion Management" ], "description": "Get a run of an ingestion", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" }, { "$ref": "#/parameters/IngestionParameters.ingestionId" }, { "$ref": "#/parameters/IngestionRunParameters.runId" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/IngestionRun" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IngestionRuns_Get": { "$ref": "./examples/IngestionRuns_Get.json" } } } }, "/inma/ingestion-sources": { "get": { "operationId": "IngestionSources_List", "tags": [ "Ingestion Sources" ], "description": "Get ingestion sources in a geo-catalog", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/OdataQuery.top" }, { "$ref": "#/parameters/OdataQuery.skip" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/IngestionSourceSummaryPagedResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IngestionSources_List": { "$ref": "./examples/IngestionSources_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } }, "post": { "operationId": "IngestionSources_Create", "tags": [ "Ingestion Sources" ], "description": "Create a new ingestion source in a geo-catalog", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "body", "in": "body", "description": "Definition of the ingestion source", "required": true, "schema": { "$ref": "#/definitions/IngestionSource" } } ], "responses": { "201": { "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "$ref": "#/definitions/IngestionSource" }, "headers": { "location": { "type": "string", "format": "uri", "description": "Url of the created ingestion source" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IngestionSources_Create": { "$ref": "./examples/IngestionSources_Create.json" } } } }, "/inma/ingestion-sources/{id}": { "get": { "operationId": "IngestionSources_Get", "tags": [ "Ingestion Sources" ], "description": "Get an ingestion source in a geo-catalog", "parameters": [ { "$ref": "#/parameters/IngestionSourceParameters" }, { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/IngestionSource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IngestionSources_Get": { "$ref": "./examples/IngestionSources_Get.json" } } }, "put": { "operationId": "IngestionSources_Replace", "tags": [ "Ingestion Sources" ], "description": "Update an existing ingestion source in a geo-catalog", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "id", "in": "path", "description": "Ingestion source id", "required": true, "type": "string", "format": "uuid" }, { "name": "body", "in": "body", "description": "Definition of the ingestion source", "required": true, "schema": { "$ref": "#/definitions/IngestionSource" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/IngestionSource" }, "headers": { "location": { "type": "string", "format": "uri", "description": "Url of the created ingestion source" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IngestionSources_Replace": { "$ref": "./examples/IngestionSources_Replace.json" } } }, "delete": { "operationId": "IngestionSources_Delete", "tags": [ "Ingestion Sources" ], "description": "Delete an ingestion source from a geo-catalog", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "id", "in": "path", "description": "Ingestion source id", "required": true, "type": "string", "format": "uuid" } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IngestionSources_Delete": { "$ref": "./examples/IngestionSources_Delete.json" } } } }, "/inma/ingestion-sources/managed-identities": { "get": { "operationId": "IngestionSources_ListManagedIdentities", "tags": [ "Ingestion Sources" ], "description": "Get all managed identities with access to storage accounts configured for a geo-catalog", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ManagedIdentityMetadataPagedResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IngestionSources_ListManagedIdentities": { "$ref": "./examples/IngestionSources_ListManagedIdentities.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/inma/operations": { "get": { "operationId": "IngestionOperations_List", "tags": [ "Ingestion Management" ], "description": "Get operations of a geo-catalog collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/OdataQuery.top" }, { "$ref": "#/parameters/OdataQuery.skip" }, { "name": "collectionId", "in": "query", "description": "Operation id used to filter the results", "required": false, "type": "string" }, { "name": "status", "in": "query", "description": "Operation status used to filter the results", "required": false, "type": "string", "enum": [ "Pending", "Running", "Succeeded", "Canceled", "Canceling", "Failed" ], "x-ms-enum": { "name": "OperationStatus", "modelAsString": true, "values": [ { "name": "Pending", "value": "Pending", "description": "Operation accepted and ready to be run" }, { "name": "Running", "value": "Running", "description": "Operation is running" }, { "name": "Succeeded", "value": "Succeeded", "description": "Operation has already finished its execution" }, { "name": "Canceled", "value": "Canceled", "description": "Operation canceled by the user" }, { "name": "Canceling", "value": "Canceling", "description": "Operation is being canceling" }, { "name": "Failed", "value": "Failed", "description": "Operation failed" } ] } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/OperationPagedResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IngestionOperations_List": { "$ref": "./examples/IngestionOperations_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } }, "delete": { "operationId": "IngestionOperations_DeleteAll", "tags": [ "Ingestion Management" ], "description": "Cancel all running operations of a geo-catalog collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IngestionOperations_DeleteAll": { "$ref": "./examples/IngestionOperations_DeleteAll.json" } } } }, "/inma/operations/{operationId}": { "get": { "operationId": "IngestionOperations_Get", "tags": [ "Ingestion Management" ], "description": "Get an operation of a geo-catalog collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "operationId", "in": "path", "description": "Operation id", "required": true, "type": "string", "format": "uuid", "maxLength": 500 } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Operation" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IngestionOperations_Get": { "$ref": "./examples/IngestionOperations_Get.json" } } }, "delete": { "operationId": "IngestionOperations_Delete", "tags": [ "Ingestion Management" ], "description": "Cancel a running operation of a geo-catalog collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "operationId", "in": "path", "description": "Operation id", "required": true, "type": "string", "format": "uuid", "maxLength": 500 } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IngestionOperations_Delete": { "$ref": "./examples/IngestionOperations_Delete.json" } } } }, "/sas/sign": { "get": { "operationId": "Sas_GetSign", "tags": [ "Shared Access Signature (SAS) Tokens for GeoCatalog Asset Access" ], "summary": "sign an HREF in the format of a URL and returns a SharedAccessSignatureSignedHrefResponse", "description": "Signs a HREF (a link URL) by appending a [SAS Token](https://docs.microsoft.com//azure/storage/common/storage-sas-overview#how-a-shared-access-signature-works).\nIf the HREF is not a Azure Blob Storage HREF, then pass back the HREF unsigned.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "href", "in": "query", "description": "HREF (URL) to sign", "required": true, "type": "string", "format": "uri" }, { "name": "duration", "in": "query", "description": "The duration, in minutes, that the SAS token will be valid. Only valid for approved users.", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "durationInMinutes" } ], "responses": { "200": { "description": "Successful Response", "schema": { "$ref": "#/definitions/SharedAccessSignatureSignedLink" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Sas_GetSign": { "$ref": "./examples/Sas_GetSign.json" } } } }, "/sas/token/{collectionId}": { "get": { "operationId": "Sas_GetToken", "tags": [ "Shared Access Signature (SAS) Tokens for GeoCatalog Asset Access" ], "summary": "generate a SAS Token for the given Azure Blob storage account and container.", "description": "Generate a [SAS Token](https://docs.microsoft.com//azure/storage/common/storage-sas-overview#how-a-shared-access-signature-works)\nfor the given storage account and container. The storage account and container\nmust be associated with a Planetary Computer dataset indexed by the STAC API.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "The name of the Collection that the SAS token will be issued for.", "required": true, "type": "string" }, { "name": "duration", "in": "query", "description": "The duration, in minutes, that the SAS token will be valid. Only valid for approved users.", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "durationInMinutes" } ], "responses": { "200": { "description": "Successful Response", "schema": { "$ref": "#/definitions/SharedAccessSignatureToken" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Sas_GetToken": { "$ref": "./examples/Sas_GetToken.json" } } } }, "/sas/token/revoke": { "post": { "operationId": "Sas_RevokeToken", "tags": [ "Shared Access Signature (SAS) Tokens for GeoCatalog Asset Access" ], "summary": "Revoke SAS token for the managed storage account of this GeoCatalog.", "description": "Revoke a [SAS Token](https://docs.microsoft.com//azure/storage/common/storage-sas-overview#how-a-shared-access-signature-works)\nfor managed storage account of this GeoCatalog.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "duration", "in": "query", "description": "The duration, in minutes, that the SAS token will be valid. Only valid for approved users.", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "durationInMinutes" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Sas_RevokeToken": { "$ref": "./examples/Sas_RevokeToken.json" } } } }, "/stac": { "get": { "operationId": "StacLandingPages_Get", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "summary": "Landing Page", "description": "Return the STAC landing page.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacLandingPage" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacLandingPages_Get": { "$ref": "./examples/StacLandingPages_Get.json" } } } }, "/stac/collections": { "get": { "operationId": "StacCollections_GetAll", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "summary": "Get Collections", "description": "List all collections in the GeoCatalog instance", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "sign", "in": "query", "description": "Whether to sign asset URLs in the response.", "required": false, "type": "string", "enum": [ "true", "false" ], "x-ms-enum": { "name": "StacAssetUrlSigningMode", "modelAsString": true, "values": [ { "name": "True", "value": "true", "description": "Sign asset URLs in the response." }, { "name": "False", "value": "false", "description": "Do not sign asset URLs in the response." } ] } }, { "name": "duration", "in": "query", "description": "URL signature duration in minutes.", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "durationInMinutes" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacCatalogCollections" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollections_GetAll": { "$ref": "./examples/StacCollections_GetAll.json" } } }, "post": { "operationId": "StacCollections_Create", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "summary": "Create Collection", "description": "Create a new collection in the GeoCatalog instance", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "body", "in": "body", "description": "Request collection body", "required": true, "schema": { "$ref": "#/definitions/StacCollection" } } ], "responses": { "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/Operation" }, "headers": { "location": { "type": "string", "format": "uri", "description": "Url used to monitor the background operation" }, "operation-location": { "type": "string", "format": "uri", "description": "Url used to monitor the background operation" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollections_Create": { "$ref": "./examples/StacCollections_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/stac/collections/{collectionId}": { "get": { "operationId": "StacCollections_Get", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "summary": "Get Collection", "description": "Get a collection in the GeoCatalog instance", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Catalog collection id", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "sign", "in": "query", "description": "Whether to sign asset URLs in the response.", "required": false, "type": "string", "enum": [ "true", "false" ], "x-ms-enum": { "name": "StacAssetUrlSigningMode", "modelAsString": true, "values": [ { "name": "True", "value": "true", "description": "Sign asset URLs in the response." }, { "name": "False", "value": "false", "description": "Do not sign asset URLs in the response." } ] } }, { "name": "duration", "in": "query", "description": "URL signature duration in minutes.", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "durationInMinutes" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacCollection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollections_Get": { "$ref": "./examples/StacCollections_Get.json" } } }, "put": { "operationId": "StacCollections_CreateOrReplace", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "summary": "Create or update Collection", "description": "Create or replace a collection in the GeoCatalog instance", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" }, { "name": "body", "in": "body", "description": "Request collection body", "required": true, "schema": { "$ref": "#/definitions/StacCollection" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacCollection" } } }, "x-ms-examples": { "StacCollections_CreateOrReplace": { "$ref": "./examples/StacCollections_CreateOrReplace.json" } } }, "delete": { "operationId": "StacCollections_Delete", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "summary": "Delete Collection", "description": "Delete a collection in the GeoCatalog instance", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" } ], "responses": { "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/Operation" }, "headers": { "location": { "type": "string", "format": "uri", "description": "Url used to monitor the background operation" }, "operation-location": { "type": "string", "format": "uri", "description": "Url used to monitor the background operation" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollections_Delete": { "$ref": "./examples/StacCollections_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/stac/collections/{collectionId}/assets": { "post": { "operationId": "StacCollectionAssets_Create", "tags": [ "STAC Collection Configuration" ], "summary": "Create Collection Asset", "description": "Create a new asset in the Collection metadata and write the associated\nfile to managed storage.", "consumes": [ "multipart/form-data" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "STAC Collection ID", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "data", "in": "formData", "description": "Asset metadata", "required": true, "type": "string" }, { "name": "file", "in": "formData", "description": "Binary file content to be uploaded.", "required": true, "type": "file" } ], "responses": { "201": { "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "$ref": "#/definitions/StacCollection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionAssets_Create": { "$ref": "./examples/StacCollectionAssets_Create.json" } } } }, "/stac/collections/{collectionId}/assets/{assetId}": { "put": { "operationId": "StacCollectionAssets_Replace", "tags": [ "STAC Collection Configuration" ], "summary": "Update Collection Asset", "description": "Update an existing asset in a given collection.", "consumes": [ "multipart/form-data" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "STAC Collection ID", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "assetId", "in": "path", "description": "STAC Asset ID", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "data", "in": "formData", "description": "Asset metadata", "required": true, "type": "string" }, { "name": "file", "in": "formData", "description": "Binary file content to be uploaded.", "required": true, "type": "file" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacCollection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionAssets_Replace": { "$ref": "./examples/StacCollectionAssets_Replace.json" } } }, "delete": { "operationId": "StacCollectionAssets_Delete", "tags": [ "STAC Collection Configuration" ], "summary": "Delete Collection Asset", "description": "Delete an asset from a given collection.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "STAC Collection ID", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "assetId", "in": "path", "description": "STAC Asset ID", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacCollection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionAssets_Delete": { "$ref": "./examples/StacCollectionAssets_Delete.json" } } } }, "/stac/collections/{collectionId}/configurations": { "get": { "operationId": "StacCollectionConfig_Get", "tags": [ "STAC Collection Configuration" ], "summary": "Get Config", "description": "Get the complete user configuration for a given collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/UserCollectionSettings" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionConfig_Get": { "$ref": "./examples/StacCollectionConfig_Get.json" } } } }, "/stac/collections/{collectionId}/configurations/mosaics": { "get": { "operationId": "StacCollectionMosaics_GetAll", "tags": [ "STAC Collection Configuration" ], "summary": "Get Collection Mosaics", "description": "Get the mosaic definitions for a given collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "type": "array", "items": { "$ref": "#/definitions/StacMosaic" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionMosaics_GetAll": { "$ref": "./examples/StacCollectionMosaics_GetAll.json" } } }, "post": { "operationId": "StacCollectionMosaics_Add", "tags": [ "STAC Collection Configuration" ], "summary": "Add Collection Mosaic", "description": "Add a mosaic definition to a given collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "body", "in": "body", "description": "Mosaic definition to be created or updated.", "required": true, "schema": { "$ref": "#/definitions/StacMosaic" } } ], "responses": { "201": { "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "$ref": "#/definitions/StacMosaic" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionMosaics_Add": { "$ref": "./examples/StacCollectionMosaics_Add.json" } } } }, "/stac/collections/{collectionId}/configurations/mosaics/{mosaicId}": { "get": { "operationId": "StacCollectionMosaics_Get", "tags": [ "STAC Collection Configuration" ], "summary": "Get Collection Mosaic", "description": "Get a mosaic definition from a given collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "mosaicId", "in": "path", "description": "Unique identifier for the mosaic configuration.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacMosaic" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionMosaics_Get": { "$ref": "./examples/StacCollectionMosaics_Get.json" } } }, "put": { "operationId": "StacCollectionMosaics_Replace", "tags": [ "STAC Collection Configuration" ], "summary": "Update Collection Mosaic", "description": "Update a mosaic definition from a given collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "mosaicId", "in": "path", "description": "Unique identifier for the mosaic configuration.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "body", "in": "body", "description": "Mosaic definition to be created or updated.", "required": true, "schema": { "$ref": "#/definitions/StacMosaic" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacMosaic" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionMosaics_Replace": { "$ref": "./examples/StacCollectionMosaics_Replace.json" } } }, "delete": { "operationId": "StacCollectionMosaics_Delete", "tags": [ "STAC Collection Configuration" ], "summary": "Delete Collection Mosaic", "description": "Delete a mosaic definition from a given collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "mosaicId", "in": "path", "description": "Unique identifier for the mosaic configuration.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionMosaics_Delete": { "$ref": "./examples/StacCollectionMosaics_Delete.json" } } } }, "/stac/collections/{collectionId}/configurations/partition-type": { "get": { "operationId": "StacCollectionPartitionTypes_Get", "tags": [ "STAC Collection Configuration" ], "summary": "Get Partitiontype", "description": "Get the partitiontype for a GeoCatalog Collection.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PartitionType" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionPartitionTypes_Get": { "$ref": "./examples/StacCollectionPartitionTypes_Get.json" } } }, "put": { "operationId": "StacCollectionPartitionTypes_Replace", "tags": [ "STAC Collection Configuration" ], "summary": "Create Partitiontype", "description": "Updates partition type for a GeoCatalog Collection. This will\ndetermine the partitioning scheme for items within the database,\nand can only be set before any items are loaded.\n\nIdeal partitioning schemes result in partitions of roughly 100k items each.\n\nThe default partitioning scheme is \"none\" which does not partition items.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "body", "in": "body", "description": "Partition type configuration determining how items are partitioned in storage.", "required": true, "schema": { "$ref": "#/definitions/PartitionType" } } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionPartitionTypes_Replace": { "$ref": "./examples/StacCollectionPartitionTypes_Replace.json" } } } }, "/stac/collections/{collectionId}/configurations/render-options": { "get": { "operationId": "StacCollectionRenderOptions_GetAll", "tags": [ "STAC Collection Configuration" ], "summary": "Get Collection Render Options", "description": "Get all render options for a given collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "type": "array", "items": { "$ref": "#/definitions/RenderOption" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionRenderOptions_GetAll": { "$ref": "./examples/StacCollectionRenderOptions_GetAll.json" } } }, "post": { "operationId": "StacCollectionRenderOptions_Create", "tags": [ "STAC Collection Configuration" ], "summary": "Add Collection Render Option", "description": "Add a render option for a given collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "body", "in": "body", "description": "Render option configuration to be created or updated.", "required": true, "schema": { "$ref": "#/definitions/RenderOption" } } ], "responses": { "201": { "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "$ref": "#/definitions/RenderOption" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionRenderOptions_Create": { "$ref": "./examples/StacCollectionRenderOptions_Create.json" } } } }, "/stac/collections/{collectionId}/configurations/render-options/{renderOptionId}": { "get": { "operationId": "StacCollectionRenderOptions_Get", "tags": [ "STAC Collection Configuration" ], "summary": "Get Collection Render Option", "description": "Get a render option for a given collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "renderOptionId", "in": "path", "description": "Unique identifier for the render option.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/RenderOption" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionRenderOptions_Get": { "$ref": "./examples/StacCollectionRenderOptions_Get.json" } } }, "put": { "operationId": "StacCollectionRenderOptions_Replace", "tags": [ "STAC Collection Configuration" ], "summary": "Update Collection Render Option", "description": "Update a render option for a given collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "renderOptionId", "in": "path", "description": "Unique identifier for the render option.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "body", "in": "body", "description": "Render option configuration to be created or updated.", "required": true, "schema": { "$ref": "#/definitions/RenderOption" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/RenderOption" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionRenderOptions_Replace": { "$ref": "./examples/StacCollectionRenderOptions_Replace.json" } } }, "delete": { "operationId": "StacCollectionRenderOptions_Delete", "tags": [ "STAC Collection Configuration" ], "summary": "Delete Collection Render Option", "description": "Delete a render option for a given collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "renderOptionId", "in": "path", "description": "Unique identifier for the render option.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionRenderOptions_Delete": { "$ref": "./examples/StacCollectionRenderOptions_Delete.json" } } } }, "/stac/collections/{collectionId}/configurations/tile-settings": { "get": { "operationId": "StacCollectionTileSettings_Get", "tags": [ "STAC Collection Configuration" ], "summary": "Get Collection Tile Settings", "description": "Get the tile settings for a given collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TileSettings" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionTileSettings_Get": { "$ref": "./examples/StacCollectionTileSettings_Get.json" } } }, "put": { "operationId": "StacCollectionTileSettings_Replace", "tags": [ "STAC Collection Configuration" ], "summary": "Update Collection Tile Settings", "description": "Update the tile settings for a given collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "body", "in": "body", "description": "Tile settings configuration to be updated.", "required": true, "schema": { "$ref": "#/definitions/TileSettings" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TileSettings" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionTileSettings_Replace": { "$ref": "./examples/StacCollectionTileSettings_Replace.json" } } } }, "/stac/collections/{collectionId}/items": { "get": { "operationId": "StacItems_GetFeatures", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "description": "Fetch features of the feature collection with id `collectionId`.\n\nEvery feature in a dataset belongs to a collection. A dataset may\nconsist of multiple feature collections. A feature collection is often a\ncollection of features of a similar type, based on a common schema.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" }, { "name": "limit", "in": "query", "description": "The optional limit parameter recommends the number of items that should be present in the response document.\n\nIf the limit parameter value is greater than advertised limit maximum, the server must return the\nmaximum possible number of items, rather than responding with an error.\n\nOnly items are counted that are on the first level of the collection in the response document.\nNested objects contained within the explicitly requested items must not be counted.\n\nMinimum = 1. Maximum = 10000. Default = 10.", "required": false, "type": "integer", "format": "int32" }, { "name": "bbox", "in": "query", "description": "Only features that have a geometry that intersects the bounding box are selected.\nThe bounding box is provided as four or six numbers, depending on whether the\ncoordinate reference system includes a vertical axis (height or depth):\n\n- Lower left corner, coordinate axis 1\n- Lower left corner, coordinate axis 2\n- Minimum value, coordinate axis 3 (optional)\n- Upper right corner, coordinate axis 1\n- Upper right corner, coordinate axis 2\n- Maximum value, coordinate axis 3 (optional)\n\nThe coordinate reference system of the values is WGS 84 longitude/latitude\n(http://www.opengis.net/def/crs/OGC/1.3/CRS84).\n\nFor WGS 84 longitude/latitude the values are in most cases the sequence of\nminimum longitude, minimum latitude, maximum longitude and maximum latitude.\nHowever, in cases where the box spans the antimeridian the first value\n(west-most box edge) is larger than the third value (east-most box edge).\n\nIf the vertical axis is included, the third and the sixth number are\nthe bottom and the top of the 3-dimensional bounding box.\n\nIf a feature has multiple spatial geometry properties, it is the decision of the\nserver whether only a single spatial geometry property is used to determine\nthe extent or all relevant geometries.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "x-ms-client-name": "boundingBox" }, { "name": "datetime", "in": "query", "description": "Either a date-time or an interval, open or closed. Date and time expressions\nadhere to RFC 3339. Open intervals are expressed using double-dots.\n\nExamples:\n\n- A date-time: \"2018-02-12T23:20:50Z\"\n- A closed interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n- Open intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n\nOnly features that have a temporal property that intersects the value of\n`datetime` are selected.\n\nIf a feature has multiple temporal properties, it is the decision of the\nserver whether only a single temporal property is used to determine\nthe extent or all relevant temporal properties.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacItemCollection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacItems_GetFeatures": { "$ref": "./examples/StacItems_GetFeatures.json" } } }, "post": { "operationId": "StacItems_Create", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "description": "Create a new STAC item or a set of items in a collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" }, { "name": "body", "in": "body", "description": "STAC Item or StacItemCollection\n\nRepresents a STAC Item or StacItemCollection as defined by the STAC 1.0.0 standard.\n\n**Item**: A GeoJSON Feature that represents a single spatiotemporal asset.\nIt includes metadata such as geometry, datetime, and links to related assets.\nExample: A satellite image with its metadata.\n\n**StacItemCollection**: A GeoJSON FeatureCollection that contains multiple Items.\nIt is used to group multiple related Items together, such as a collection of satellite images.\n\nThis union allows the request body to accept either a single Item or a collection of Items.", "required": true, "schema": { "$ref": "#/definitions/StacItemOrStacItemCollection" } } ], "responses": { "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/Operation" }, "headers": { "location": { "type": "string", "format": "uri", "description": "Url used to monitor the background operation" }, "operation-location": { "type": "string", "format": "uri", "description": "Url used to monitor the background operation" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacItems_Create": { "$ref": "./examples/StacItems_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/stac/collections/{collectionId}/items/{itemId}": { "get": { "operationId": "StacItems_Get", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "description": "Fetch a single STAC Item", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" }, { "name": "itemId", "in": "path", "description": "STAC Item id", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacItem" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacItems_Get": { "$ref": "./examples/StacItems_Get.json" } } }, "put": { "operationId": "StacItems_CreateOrReplace", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "description": "Create or replace a STAC item in a collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" }, { "name": "itemId", "in": "path", "description": "STAC Item id", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "body", "in": "body", "description": "STAC Item", "required": true, "schema": { "$ref": "#/definitions/StacItem" } } ], "responses": { "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/Operation" }, "headers": { "location": { "type": "string", "format": "uri", "description": "Url used to monitor the background operation" }, "operation-location": { "type": "string", "format": "uri", "description": "Url used to monitor the background operation" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacItems_CreateOrReplace": { "$ref": "./examples/StacItems_CreateOrReplace.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "StacItems_Update", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "description": "Update a STAC item in a collection", "consumes": [ "application/merge-patch+json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" }, { "name": "itemId", "in": "path", "description": "STAC Item id", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "body", "in": "body", "description": "STAC Item", "required": true, "schema": { "$ref": "#/definitions/StacItemUpdate" } } ], "responses": { "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/Operation" }, "headers": { "location": { "type": "string", "format": "uri", "description": "Url used to monitor the background operation" }, "operation-location": { "type": "string", "format": "uri", "description": "Url used to monitor the background operation" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacItems_Update": { "$ref": "./examples/StacItems_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "StacItems_Delete", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "description": "Delete a STAC item from a collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/CollectionParameters.collectionId" }, { "name": "itemId", "in": "path", "description": "STAC Item id", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/Operation" }, "headers": { "location": { "type": "string", "format": "uri", "description": "Url used to monitor the background operation" }, "operation-location": { "type": "string", "format": "uri", "description": "Url used to monitor the background operation" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacItems_Delete": { "$ref": "./examples/StacItems_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/stac/collections/{collectionId}/queryables": { "get": { "operationId": "StacQueryables_GetAllByCollection", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "summary": "Collection Queryables", "description": "List all queryables in a given collection", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Collection ID", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/QueryableDefinitionsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacQueryables_GetAllByCollection": { "$ref": "./examples/StacQueryables_GetAllByCollection.json" } } }, "post": { "operationId": "StacQueryables_Create", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "summary": "Set Collection Queryables", "description": "Set queryables for a collection given a list of queryable definitions", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "body", "in": "body", "description": "Request queryable definition body", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/StacQueryable" } } } ], "responses": { "201": { "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "type": "array", "items": { "$ref": "#/definitions/StacQueryable" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacQueryables_Create": { "$ref": "./examples/StacQueryables_Create.json" } } } }, "/stac/collections/{collectionId}/queryables/{queryableName}": { "put": { "operationId": "StacQueryables_Replace", "tags": [ "STAC Collection Configuration" ], "summary": "Update Collection Queryables", "description": "Updates a queryable given a queryable definition and\ncorresponding collection id.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "queryableName", "in": "path", "description": "Name of the queryable property to operate on.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "body", "in": "body", "description": "Request queryable definition body", "required": true, "schema": { "$ref": "#/definitions/StacQueryable" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacQueryable" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacQueryables_Replace": { "$ref": "./examples/StacQueryables_Replace.json" } } }, "delete": { "operationId": "StacQueryables_Delete", "tags": [ "STAC Collection Configuration" ], "summary": "Delete Queryables", "description": "Delete queryables by name for specified collection.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "Unique identifier for the STAC collection.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" }, { "name": "queryableName", "in": "path", "description": "Name of the queryable property to operate on.", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacQueryables_Delete": { "$ref": "./examples/StacQueryables_Delete.json" } } } }, "/stac/collections/{collectionId}/thumbnail": { "get": { "operationId": "StacCollectionThumbnails_Get", "tags": [ "STAC Collection Configuration" ], "summary": "Get Collection Thumbnail", "description": "Get thumbnail for given collection.", "produces": [ "image/png", "image/jpeg", "image/jpg", "image/webp", "image/jp2", "image/tiff; application=geotiff", "application/x-binary", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collectionId", "in": "path", "description": "STAC Collection ID", "required": true, "type": "string", "maxLength": 500, "pattern": ".*" } ], "responses": { "200": { "description": "Return an image.", "schema": { "type": "file" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacCollectionThumbnails_Get": { "$ref": "./examples/StacCollectionThumbnails_Get.json" } } } }, "/stac/conformance": { "get": { "operationId": "StacConformanceClass_Get", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "summary": "Conformance Classes", "description": "Returns the STAC conformance classes.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacConformanceClasses" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacConformanceClass_Get": { "$ref": "./examples/StacConformanceClass_Get.json" } } } }, "/stac/queryables": { "get": { "operationId": "StacQueryables_GetAll", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "summary": "Queryables", "description": "List all queryables in the GeoCatalog instance", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/QueryableDefinitionsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacQueryables_GetAll": { "$ref": "./examples/StacQueryables_GetAll.json" } } } }, "/stac/search": { "get": { "operationId": "StacSearch_Get", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "summary": "Search", "description": "STAC search operation with query parameters.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "collections", "in": "query", "description": "List of Collection IDs to include in the search. Only items in these collections will be searched.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "ids", "in": "query", "description": "Array of Item IDs to return specific items.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "bbox", "in": "query", "description": "Bounding box for spatial filtering in format [west, south, east, north].", "required": false, "type": "array", "items": { "type": "number", "format": "float" }, "collectionFormat": "csv", "x-ms-client-name": "boundingBox" }, { "name": "intersects", "in": "query", "description": "GeoJSON geometry for spatial filtering.", "required": false, "type": "string" }, { "name": "datetime", "in": "query", "description": "Temporal filter in RFC 3339 format, can be a single time or range.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Maximum number of results to return.", "required": false, "type": "integer", "format": "int32", "default": 250 }, { "name": "sign", "in": "query", "description": "Whether to sign asset URLs in the response.", "required": false, "type": "string", "enum": [ "true", "false" ], "x-ms-enum": { "name": "StacAssetUrlSigningMode", "modelAsString": true, "values": [ { "name": "True", "value": "true", "description": "Sign asset URLs in the response." }, { "name": "False", "value": "false", "description": "Do not sign asset URLs in the response." } ] } }, { "name": "duration", "in": "query", "description": "URL signature duration in minutes.", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "durationInMinutes" }, { "name": "query", "in": "query", "description": "Property-based filtering expressed as a JSON object.", "required": false, "type": "string" }, { "name": "sortby", "in": "query", "description": "Sort order for items. Format is property name prefixed with \"+\" for ascending or \"-\" for descending.", "required": false, "type": "string", "x-ms-client-name": "sortBy" }, { "name": "fields", "in": "query", "description": "Determines which fields to include in the response. Format is comma-separated field names with \"-\" prefix to exclude fields.", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "CQL filter expression for advanced filtering of items.", "required": false, "type": "string" }, { "name": "token", "in": "query", "description": "Pagination token for fetching the next set of results.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacItemCollection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacSearch_Get": { "$ref": "./examples/StacSearch_Get.json" } } }, "post": { "operationId": "StacSearch_Create", "tags": [ "SpatioTemporal Asset Catalog (STAC) API" ], "summary": "Search", "description": "STAC search operation.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "sign", "in": "query", "description": "Whether to sign asset URLs in the response.", "required": false, "type": "string", "enum": [ "true", "false" ], "x-ms-enum": { "name": "StacAssetUrlSigningMode", "modelAsString": true, "values": [ { "name": "True", "value": "true", "description": "Sign asset URLs in the response." }, { "name": "False", "value": "false", "description": "Do not sign asset URLs in the response." } ] } }, { "name": "duration", "in": "query", "description": "URL signature duration in minutes.", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "durationInMinutes" }, { "name": "body", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/StacSearchParameters" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StacItemCollection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "StacSearch_Create": { "$ref": "./examples/StacSearch_Create.json" } } } } }, "definitions": { "ApplicationJsonResponse": { "type": "object", "description": "Return list of assets", "properties": { "body": { "type": "array", "title": "Response Assets For Point Api Mosaic searchId Lon Lat Assets Get", "description": "body", "items": {} } }, "required": [ "body" ] }, "ApplicationXbinaryResponse": { "type": "object", "description": "Return an image.", "properties": { "body": { "type": "string", "format": "byte", "description": "The binary data." } }, "required": [ "body" ] }, "AssetMetadata": { "type": "object", "description": "Asset metadata model.", "properties": { "key": { "type": "string", "description": "The key of the asset." }, "type": { "type": "string", "description": "The type of the asset." }, "roles": { "type": "array", "description": "The roles of the asset.", "items": { "type": "string" } }, "title": { "type": "string", "description": "The title of the asset." }, "description": { "type": "string", "description": "The description of the asset." } }, "required": [ "key", "type", "roles", "title", "description" ] }, "AssetStatisticsResponse": { "type": "object", "description": "Return dataset's statistics.", "additionalProperties": { "$ref": "#/definitions/BandStatisticsMap" } }, "AvailableAssets": { "type": "object", "description": "Return a list of supported assets.", "properties": { "body": { "type": "array", "title": "Response Available Assets Api Collections Collection Id Items Item Id Assets Get", "description": "body for available assets response", "items": { "type": "string" } } }, "required": [ "body" ] }, "Azure.Core.Foundations.Error": { "type": "object", "description": "The error object.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." }, "details": { "type": "array", "description": "An array of details about specific errors that led to this reported error.", "items": { "$ref": "#/definitions/Azure.Core.Foundations.Error" } }, "innererror": { "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "An object containing more specific information than the current object about the error." } }, "required": [ "code", "message" ] }, "Azure.Core.Foundations.ErrorResponse": { "type": "object", "description": "A response containing error details.", "properties": { "error": { "$ref": "#/definitions/Azure.Core.Foundations.Error", "description": "The error object." } }, "required": [ "error" ] }, "Azure.Core.Foundations.InnerError": { "type": "object", "description": "An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "innererror": { "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "Inner error." } } }, "Azure.Core.uuid": { "type": "string", "format": "uuid", "description": "Universally Unique Identifier" }, "BandMetadataElement": {}, "BandStatistics": { "type": "object", "description": "Statistical information about a data band.", "properties": { "min": { "type": "number", "format": "float", "description": "Minimum value in the band.", "x-ms-client-name": "minimum" }, "max": { "type": "number", "format": "float", "description": "Maximum value in the band.", "x-ms-client-name": "maximum" }, "mean": { "type": "number", "format": "float", "description": "Mean value of the band." }, "count": { "type": "number", "format": "float", "description": "Count of pixels in the band." }, "sum": { "type": "number", "format": "float", "description": "Sum of all pixel values in the band." }, "std": { "type": "number", "format": "float", "description": "Standard deviation of pixel values in the band." }, "median": { "type": "number", "format": "float", "description": "Median value of the band." }, "majority": { "type": "number", "format": "float", "description": "Most common value in the band." }, "minority": { "type": "number", "format": "float", "description": "Least common value in the band." }, "unique": { "type": "number", "format": "float", "description": "Count of unique values in the band." }, "histogram": { "type": "array", "description": "Histogram of pixel values in the band.", "items": { "type": "array", "items": { "type": "number", "format": "float" } } }, "valid_percent": { "type": "number", "format": "float", "description": "Percentage of valid (non-masked) pixels.", "x-ms-client-name": "validPercent" }, "masked_pixels": { "type": "number", "format": "float", "description": "Count of masked pixels in the band.", "x-ms-client-name": "maskedPixels" }, "valid_pixels": { "type": "number", "format": "float", "description": "Count of valid (non-masked) pixels in the band.", "x-ms-client-name": "validPixels" }, "percentile_2": { "type": "number", "format": "float", "description": "Percentile 2\nThe 2nd percentile value.", "x-ms-client-name": "percentile2" }, "percentile_98": { "type": "number", "format": "float", "description": "Percentile 98\nThe 98th percentile value.", "x-ms-client-name": "percentile98" } }, "required": [ "min", "max", "mean", "count", "sum", "std", "median", "majority", "minority", "unique", "histogram", "valid_percent", "masked_pixels", "valid_pixels", "percentile_2", "percentile_98" ] }, "BandStatisticsMap": { "type": "object", "description": "Map of band names to their statistics.", "additionalProperties": { "$ref": "#/definitions/BandStatistics" } }, "ClassMapLegendResponse": { "type": "object", "description": "ClassMap legend response model.", "additionalProperties": {} }, "ColorMapNames": { "type": "string", "description": "Available color maps for data visualization", "enum": [ "accent", "accent_r", "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r", "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r", "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass", "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r", "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r", "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar", "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r", "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r", "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc", "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence", "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative", "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1", "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF", "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges", "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink", "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r", "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r", "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds", "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r", "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r", "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted", "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat", "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter", "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd", "ylorrd_r" ], "x-ms-enum": { "name": "ColorMapNames", "modelAsString": true, "values": [ { "name": "accent", "value": "accent", "description": "Accent colormap - qualitative colormap with distinct colors" }, { "name": "accent_r", "value": "accent_r", "description": "Reversed accent colormap" }, { "name": "afmhot", "value": "afmhot", "description": "Afmhot colormap - sequential black-red-yellow-white colormap" }, { "name": "afmhot_r", "value": "afmhot_r", "description": "Reversed afmhot colormap" }, { "name": "ai4g-lulc", "value": "ai4g-lulc", "description": "AI for Good land use/land cover colormap" }, { "name": "alos-fnf", "value": "alos-fnf", "description": "ALOS forest/non-forest colormap" }, { "name": "alos-palsar-mask", "value": "alos-palsar-mask", "description": "ALOS PALSAR mask colormap" }, { "name": "autumn", "value": "autumn", "description": "Autumn colormap - sequential red-orange-yellow colormap" }, { "name": "autumn_r", "value": "autumn_r", "description": "Reversed autumn colormap" }, { "name": "binary", "value": "binary", "description": "Binary colormap - simple black and white colormap" }, { "name": "binary_r", "value": "binary_r", "description": "Reversed binary colormap" }, { "name": "blues", "value": "blues", "description": "Blues colormap - sequential white to dark blue" }, { "name": "blues_r", "value": "blues_r", "description": "Reversed blues colormap" }, { "name": "bone", "value": "bone", "description": "Bone colormap - grayscale with slight blue tint" }, { "name": "bone_r", "value": "bone_r", "description": "Reversed bone colormap" }, { "name": "brbg", "value": "brbg", "description": "BrBG colormap - diverging brown to blue-green" }, { "name": "brbg_r", "value": "brbg_r", "description": "Reversed BrBG colormap" }, { "name": "brg", "value": "brg", "description": "BrG colormap - diverging brown to green" }, { "name": "brg_r", "value": "brg_r", "description": "Reversed BrG colormap" }, { "name": "bugn", "value": "bugn", "description": "BuGn colormap - sequential white to dark green" }, { "name": "bugn_r", "value": "bugn_r", "description": "Reversed BuGn colormap" }, { "name": "bupu", "value": "bupu", "description": "BuPu colormap - sequential white to dark purple" }, { "name": "bupu_r", "value": "bupu_r", "description": "Reversed BuPu colormap" }, { "name": "bwr", "value": "bwr", "description": "BWR colormap - diverging blue to red" }, { "name": "bwr_r", "value": "bwr_r", "description": "Reversed BWR colormap" }, { "name": "c-cap", "value": "c-cap", "description": "C-CAP colormap - land cover classification" }, { "name": "cfastie", "value": "cfastie", "description": "Cfastie colormap - high contrast colormap" }, { "name": "chesapeake-lc-13", "value": "chesapeake-lc-13", "description": "Chesapeake land cover 13-class colormap" }, { "name": "chesapeake-lc-7", "value": "chesapeake-lc-7", "description": "Chesapeake land cover 7-class colormap" }, { "name": "chesapeake-lu", "value": "chesapeake-lu", "description": "Chesapeake land use colormap" }, { "name": "chloris-biomass", "value": "chloris-biomass", "description": "Chloris biomass colormap" }, { "name": "cividis", "value": "cividis", "description": "Cividis colormap - sequential yellow to blue" }, { "name": "cividis_r", "value": "cividis_r", "description": "Reversed cividis colormap" }, { "name": "cmrmap", "value": "cmrmap", "description": "CMRmap colormap - perceptually uniform colormap" }, { "name": "cmrmap_r", "value": "cmrmap_r", "description": "Reversed CMRmap colormap" }, { "name": "cool", "value": "cool", "description": "Cool colormap - sequential cyan to magenta" }, { "name": "cool_r", "value": "cool_r", "description": "Reversed cool colormap" }, { "name": "coolwarm", "value": "coolwarm", "description": "Coolwarm colormap - diverging blue to red" }, { "name": "coolwarm_r", "value": "coolwarm_r", "description": "Reversed coolwarm colormap" }, { "name": "copper", "value": "copper", "description": "Copper colormap - sequential black to copper" }, { "name": "copper_r", "value": "copper_r", "description": "Reversed copper colormap" }, { "name": "cubehelix", "value": "cubehelix", "description": "Cubehelix colormap - sequential black to white with hue rotation" }, { "name": "cubehelix_r", "value": "cubehelix_r", "description": "Reversed cubehelix colormap" }, { "name": "dark2", "value": "dark2", "description": "Dark2 colormap - qualitative colormap with distinct colors" }, { "name": "dark2_r", "value": "dark2_r", "description": "Reversed dark2 colormap" }, { "name": "drcog-lulc", "value": "drcog-lulc", "description": "DRCog land use/land cover colormap" }, { "name": "esa-cci-lc", "value": "esa-cci-lc", "description": "ESA CCI land cover colormap" }, { "name": "esa-worldcover", "value": "esa-worldcover", "description": "ESA WorldCover colormap" }, { "name": "flag", "value": "flag", "description": "Flag colormap - qualitative colormap with distinct colors" }, { "name": "flag_r", "value": "flag_r", "description": "Reversed flag colormap" }, { "name": "gap-lulc", "value": "gap-lulc", "description": "GAP land use/land cover colormap" }, { "name": "gist_earth", "value": "gist_earth", "description": "Gist_earth colormap - perceptually uniform colormap" }, { "name": "gist_earth_r", "value": "gist_earth_r", "description": "Reversed gist_earth colormap" }, { "name": "gist_gray", "value": "gist_gray", "description": "Gist_gray colormap - grayscale colormap" }, { "name": "gist_gray_r", "value": "gist_gray_r", "description": "Reversed gist_gray colormap" }, { "name": "gist_heat", "value": "gist_heat", "description": "Gist_heat colormap - sequential black-red-yellow-white colormap" }, { "name": "gist_heat_r", "value": "gist_heat_r", "description": "Reversed gist_heat colormap" }, { "name": "gist_ncar", "value": "gist_ncar", "description": "Gist_ncar colormap - perceptually uniform colormap" }, { "name": "gist_ncar_r", "value": "gist_ncar_r", "description": "Reversed gist_ncar colormap" }, { "name": "gist_rainbow", "value": "gist_rainbow", "description": "Gist_rainbow colormap - perceptually uniform colormap" }, { "name": "gist_rainbow_r", "value": "gist_rainbow_r", "description": "Reversed gist_rainbow colormap" }, { "name": "gist_stern", "value": "gist_stern", "description": "Gist_stern colormap - perceptually uniform colormap" }, { "name": "gist_stern_r", "value": "gist_stern_r", "description": "Reversed gist_stern colormap" }, { "name": "gist_yarg", "value": "gist_yarg", "description": "Gist_yarg colormap - grayscale colormap" }, { "name": "gist_yarg_r", "value": "gist_yarg_r", "description": "Reversed gist_yarg colormap" }, { "name": "gnbu", "value": "gnbu", "description": "GnBu colormap - sequential white to dark blue-green" }, { "name": "gnbu_r", "value": "gnbu_r", "description": "Reversed GnBu colormap" }, { "name": "gnuplot", "value": "gnuplot", "description": "Gnuplot colormap - sequential black to white with hue rotation" }, { "name": "gnuplot2", "value": "gnuplot2", "description": "Gnuplot2 colormap - sequential black to white with hue rotation" }, { "name": "gnuplot2_r", "value": "gnuplot2_r", "description": "Reversed gnuplot2 colormap" }, { "name": "gnuplot_r", "value": "gnuplot_r", "description": "Reversed gnuplot colormap" }, { "name": "gray", "value": "gray", "description": "Gray colormap - grayscale colormap" }, { "name": "gray_r", "value": "gray_r", "description": "Reversed gray colormap" }, { "name": "greens", "value": "greens", "description": "Greens colormap - sequential white to dark green" }, { "name": "greens_r", "value": "greens_r", "description": "Reversed greens colormap" }, { "name": "greys", "value": "greys", "description": "Greys colormap - sequential white to dark gray" }, { "name": "greys_r", "value": "greys_r", "description": "Reversed greys colormap" }, { "name": "hot", "value": "hot", "description": "Hot colormap - sequential black-red-yellow-white colormap" }, { "name": "hot_r", "value": "hot_r", "description": "Reversed hot colormap" }, { "name": "hsv", "value": "hsv", "description": "HSV colormap - hue-saturation-value colormap" }, { "name": "hsv_r", "value": "hsv_r", "description": "Reversed HSV colormap" }, { "name": "inferno", "value": "inferno", "description": "Inferno colormap - sequential black to yellow colormap" }, { "name": "inferno_r", "value": "inferno_r", "description": "Reversed inferno colormap" }, { "name": "io-bii", "value": "io-bii", "description": "IO-BII colormap - biodiversity index colormap" }, { "name": "io-lulc", "value": "io-lulc", "description": "IO-LULC colormap - land use/land cover colormap" }, { "name": "io-lulc-9-class", "value": "io-lulc-9-class", "description": "IO-LULC 9-class colormap" }, { "name": "jet", "value": "jet", "description": "Jet colormap - sequential blue-green-yellow-red colormap" }, { "name": "jet_r", "value": "jet_r", "description": "Reversed jet colormap" }, { "name": "jrc-change", "value": "jrc-change", "description": "JRC change colormap" }, { "name": "jrc-extent", "value": "jrc-extent", "description": "JRC extent colormap" }, { "name": "jrc-occurrence", "value": "jrc-occurrence", "description": "JRC occurrence colormap" }, { "name": "jrc-recurrence", "value": "jrc-recurrence", "description": "JRC recurrence colormap" }, { "name": "jrc-seasonality", "value": "jrc-seasonality", "description": "JRC seasonality colormap" }, { "name": "jrc-transitions", "value": "jrc-transitions", "description": "JRC transitions colormap" }, { "name": "lidar-classification", "value": "lidar-classification", "description": "Lidar classification colormap" }, { "name": "lidar-hag", "value": "lidar-hag", "description": "Lidar height above ground colormap" }, { "name": "lidar-hag-alternative", "value": "lidar-hag-alternative", "description": "Alternative lidar height above ground colormap" }, { "name": "lidar-intensity", "value": "lidar-intensity", "description": "Lidar intensity colormap" }, { "name": "lidar-returns", "value": "lidar-returns", "description": "Lidar returns colormap" }, { "name": "magma", "value": "magma", "description": "Magma colormap - sequential black to yellow colormap" }, { "name": "magma_r", "value": "magma_r", "description": "Reversed magma colormap" }, { "name": "modis-10A1", "value": "modis-10A1", "description": "MODIS 10A1 colormap" }, { "name": "modis-10A2", "value": "modis-10A2", "description": "MODIS 10A2 colormap" }, { "name": "modis-13A1|Q1", "value": "modis-13A1|Q1", "description": "MODIS 13A1|Q1 colormap" }, { "name": "modis-14A1|A2", "value": "modis-14A1|A2", "description": "MODIS 14A1|A2 colormap" }, { "name": "modis-15A2H|A3H", "value": "modis-15A2H|A3H", "description": "MODIS 15A2H|A3H colormap" }, { "name": "modis-16A3GF-ET", "value": "modis-16A3GF-ET", "description": "MODIS 16A3GF-ET colormap" }, { "name": "modis-16A3GF-PET", "value": "modis-16A3GF-PET", "description": "MODIS 16A3GF-PET colormap" }, { "name": "modis-17A2H|A2HGF", "value": "modis-17A2H|A2HGF", "description": "MODIS 17A2H|A2HGF colormap" }, { "name": "modis-17A3HGF", "value": "modis-17A3HGF", "description": "MODIS 17A3HGF colormap" }, { "name": "modis-64A1", "value": "modis-64A1", "description": "MODIS 64A1 colormap" }, { "name": "mtbs-severity", "value": "mtbs-severity", "description": "MTBS severity colormap" }, { "name": "nipy_spectral", "value": "nipy_spectral", "description": "Nipy_spectral colormap - perceptually uniform colormap" }, { "name": "nipy_spectral_r", "value": "nipy_spectral_r", "description": "Reversed nipy_spectral colormap" }, { "name": "nrcan-lulc", "value": "nrcan-lulc", "description": "NRCAN land use/land cover colormap" }, { "name": "ocean", "value": "ocean", "description": "Ocean colormap - sequential blue to white colormap" }, { "name": "ocean_r", "value": "ocean_r", "description": "Reversed ocean colormap" }, { "name": "oranges", "value": "oranges", "description": "Oranges colormap - sequential white to dark orange" }, { "name": "oranges_r", "value": "oranges_r", "description": "Reversed oranges colormap" }, { "name": "orrd", "value": "orrd", "description": "OrRd colormap - sequential white to dark red-orange" }, { "name": "orrd_r", "value": "orrd_r", "description": "Reversed OrRd colormap" }, { "name": "paired", "value": "paired", "description": "Paired colormap - qualitative colormap with distinct colors" }, { "name": "paired_r", "value": "paired_r", "description": "Reversed paired colormap" }, { "name": "pastel1", "value": "pastel1", "description": "Pastel1 colormap - qualitative colormap with pastel colors" }, { "name": "pastel1_r", "value": "pastel1_r", "description": "Reversed pastel1 colormap" }, { "name": "pastel2", "value": "pastel2", "description": "Pastel2 colormap - qualitative colormap with pastel colors" }, { "name": "pastel2_r", "value": "pastel2_r", "description": "Reversed pastel2 colormap" }, { "name": "pink", "value": "pink", "description": "Pink colormap - sequential white to dark pink" }, { "name": "pink_r", "value": "pink_r", "description": "Reversed pink colormap" }, { "name": "piyg", "value": "piyg", "description": "PiYG colormap - diverging pink to green" }, { "name": "piyg_r", "value": "piyg_r", "description": "Reversed PiYG colormap" }, { "name": "plasma", "value": "plasma", "description": "Plasma colormap - sequential black to yellow colormap" }, { "name": "plasma_r", "value": "plasma_r", "description": "Reversed plasma colormap" }, { "name": "prgn", "value": "prgn", "description": "PRGn colormap - diverging purple to green" }, { "name": "prgn_r", "value": "prgn_r", "description": "Reversed PRGn colormap" }, { "name": "prism", "value": "prism", "description": "Prism colormap - qualitative colormap with distinct colors" }, { "name": "prism_r", "value": "prism_r", "description": "Reversed prism colormap" }, { "name": "pubu", "value": "pubu", "description": "PuBu colormap - sequential white to dark blue" }, { "name": "pubu_r", "value": "pubu_r", "description": "Reversed PuBu colormap" }, { "name": "pubugn", "value": "pubugn", "description": "PuBuGn colormap - sequential white to dark blue-green" }, { "name": "pubugn_r", "value": "pubugn_r", "description": "Reversed PuBuGn colormap" }, { "name": "puor", "value": "puor", "description": "PuOr colormap - diverging purple to orange" }, { "name": "puor_r", "value": "puor_r", "description": "Reversed PuOr colormap" }, { "name": "purd", "value": "purd", "description": "PuRd colormap - sequential white to dark purple-red" }, { "name": "purd_r", "value": "purd_r", "description": "Reversed PuRd colormap" }, { "name": "purples", "value": "purples", "description": "Purples colormap - sequential white to dark purple" }, { "name": "purples_r", "value": "purples_r", "description": "Reversed purples colormap" }, { "name": "qpe", "value": "qpe", "description": "QPE colormap - qualitative colormap with distinct colors" }, { "name": "rainbow", "value": "rainbow", "description": "Rainbow colormap - qualitative colormap with distinct colors" }, { "name": "rainbow_r", "value": "rainbow_r", "description": "Reversed rainbow colormap" }, { "name": "rdbu", "value": "rdbu", "description": "RdBu colormap - diverging red to blue" }, { "name": "rdbu_r", "value": "rdbu_r", "description": "Reversed RdBu colormap" }, { "name": "rdgy", "value": "rdgy", "description": "RdGy colormap - diverging red to gray" }, { "name": "rdgy_r", "value": "rdgy_r", "description": "Reversed RdGy colormap" }, { "name": "rdpu", "value": "rdpu", "description": "RdPu colormap - sequential white to dark red-purple" }, { "name": "rdpu_r", "value": "rdpu_r", "description": "Reversed RdPu colormap" }, { "name": "rdylbu", "value": "rdylbu", "description": "RdYlBu colormap - diverging red to yellow to blue" }, { "name": "rdylbu_r", "value": "rdylbu_r", "description": "Reversed RdYlBu colormap" }, { "name": "rdylgn", "value": "rdylgn", "description": "RdYlGn colormap - diverging red to yellow to green" }, { "name": "rdylgn_r", "value": "rdylgn_r", "description": "Reversed RdYlGn colormap" }, { "name": "reds", "value": "reds", "description": "Reds colormap - sequential white to dark red" }, { "name": "reds_r", "value": "reds_r", "description": "Reversed reds colormap" }, { "name": "rplumbo", "value": "rplumbo", "description": "Rplumbo colormap - qualitative colormap with distinct colors" }, { "name": "schwarzwald", "value": "schwarzwald", "description": "Schwarzwald colormap - qualitative colormap with distinct colors" }, { "name": "seismic", "value": "seismic", "description": "Seismic colormap - diverging blue to red" }, { "name": "seismic_r", "value": "seismic_r", "description": "Reversed seismic colormap" }, { "name": "set1", "value": "set1", "description": "Set1 colormap - qualitative colormap with distinct colors" }, { "name": "set1_r", "value": "set1_r", "description": "Reversed set1 colormap" }, { "name": "set2", "value": "set2", "description": "Set2 colormap - qualitative colormap with distinct colors" }, { "name": "set2_r", "value": "set2_r", "description": "Reversed set2 colormap" }, { "name": "set3", "value": "set3", "description": "Set3 colormap - qualitative colormap with distinct colors" }, { "name": "set3_r", "value": "set3_r", "description": "Reversed set3 colormap" }, { "name": "spectral", "value": "spectral", "description": "Spectral colormap - diverging red to yellow to blue" }, { "name": "spectral_r", "value": "spectral_r", "description": "Reversed spectral colormap" }, { "name": "spring", "value": "spring", "description": "Spring colormap - sequential magenta to yellow" }, { "name": "spring_r", "value": "spring_r", "description": "Reversed spring colormap" }, { "name": "summer", "value": "summer", "description": "Summer colormap - sequential green to yellow" }, { "name": "summer_r", "value": "summer_r", "description": "Reversed summer colormap" }, { "name": "tab10", "value": "tab10", "description": "Tab10 colormap - qualitative colormap with distinct colors" }, { "name": "tab10_r", "value": "tab10_r", "description": "Reversed tab10 colormap" }, { "name": "tab20", "value": "tab20", "description": "Tab20 colormap - qualitative colormap with distinct colors" }, { "name": "tab20_r", "value": "tab20_r", "description": "Reversed tab20 colormap" }, { "name": "tab20b", "value": "tab20b", "description": "Tab20b colormap - qualitative colormap with distinct colors" }, { "name": "tab20b_r", "value": "tab20b_r", "description": "Reversed tab20b colormap" }, { "name": "tab20c", "value": "tab20c", "description": "Tab20c colormap - qualitative colormap with distinct colors" }, { "name": "tab20c_r", "value": "tab20c_r", "description": "Reversed tab20c colormap" }, { "name": "terrain", "value": "terrain", "description": "Terrain colormap - sequential black to white with hue rotation" }, { "name": "terrain_r", "value": "terrain_r", "description": "Reversed terrain colormap" }, { "name": "twilight", "value": "twilight", "description": "Twilight colormap - diverging blue to red" }, { "name": "twilight_r", "value": "twilight_r", "description": "Reversed twilight colormap" }, { "name": "twilight_shifted", "value": "twilight_shifted", "description": "Twilight shifted colormap - diverging blue to red" }, { "name": "twilight_shifted_r", "value": "twilight_shifted_r", "description": "Reversed twilight shifted colormap" }, { "name": "usda-cdl", "value": "usda-cdl", "description": "USDA CDL colormap - land cover classification" }, { "name": "usda-cdl-corn", "value": "usda-cdl-corn", "description": "USDA CDL corn colormap" }, { "name": "usda-cdl-cotton", "value": "usda-cdl-cotton", "description": "USDA CDL cotton colormap" }, { "name": "usda-cdl-soybeans", "value": "usda-cdl-soybeans", "description": "USDA CDL soybeans colormap" }, { "name": "usda-cdl-wheat", "value": "usda-cdl-wheat", "description": "USDA CDL wheat colormap" }, { "name": "usgs-lcmap", "value": "usgs-lcmap", "description": "USGS LCMAP colormap" }, { "name": "viirs-10a1", "value": "viirs-10a1", "description": "VIIRS 10A1 colormap" }, { "name": "viirs-13a1", "value": "viirs-13a1", "description": "VIIRS 13A1 colormap" }, { "name": "viirs-14a1", "value": "viirs-14a1", "description": "VIIRS 14A1 colormap" }, { "name": "viirs-15a2H", "value": "viirs-15a2H", "description": "VIIRS 15A2H colormap" }, { "name": "viridis", "value": "viridis", "description": "Viridis colormap - sequential black to yellow colormap" }, { "name": "viridis_r", "value": "viridis_r", "description": "Reversed viridis colormap" }, { "name": "winter", "value": "winter", "description": "Winter colormap - sequential blue to green" }, { "name": "winter_r", "value": "winter_r", "description": "Reversed winter colormap" }, { "name": "wistia", "value": "wistia", "description": "Wistia colormap - sequential white to yellow" }, { "name": "wistia_r", "value": "wistia_r", "description": "Reversed wistia colormap" }, { "name": "ylgn", "value": "ylgn", "description": "YlGn colormap - sequential white to dark green" }, { "name": "ylgn_r", "value": "ylgn_r", "description": "Reversed YlGn colormap" }, { "name": "ylgnbu", "value": "ylgnbu", "description": "YlGnBu colormap - sequential white to dark blue-green" }, { "name": "ylgnbu_r", "value": "ylgnbu_r", "description": "Reversed YlGnBu colormap" }, { "name": "ylorbr", "value": "ylorbr", "description": "YlOrBr colormap - sequential white to dark orange-brown" }, { "name": "ylorbr_r", "value": "ylorbr_r", "description": "Reversed YlOrBr colormap" }, { "name": "ylorrd", "value": "ylorrd", "description": "YlOrRd colormap - sequential white to dark red-orange" }, { "name": "ylorrd_r", "value": "ylorrd_r", "description": "Reversed YlOrRd colormap" } ] } }, "DefaultLocation": { "type": "object", "description": "Defines a default geographic location for map visualization.", "properties": { "zoom": { "type": "integer", "format": "int32", "description": "Default zoom level for the map." }, "coordinates": { "type": "array", "description": "Default center coordinates [latitude, longitude] for the map.", "items": { "type": "number", "format": "float" } } }, "required": [ "zoom", "coordinates" ] }, "ErrorInfo": { "type": "object", "description": "Error information wrapper", "properties": { "error": { "$ref": "#/definitions/Azure.Core.Foundations.Error", "description": "Error details" } }, "required": [ "error" ] }, "Feature": { "type": "object", "description": "GeoJSON Feature object representing a geographic entity", "properties": { "geometry": { "$ref": "#/definitions/Geometry", "description": "Geometry object defining the feature's shape" }, "type": { "$ref": "#/definitions/FeatureType", "description": "GeoJSON type identifier for Feature" }, "properties": { "type": "object", "description": "Feature properties", "additionalProperties": {} } }, "required": [ "geometry", "type" ] }, "FeatureType": { "type": "string", "description": "Type identifier for GeoJSON Feature objects", "enum": [ "Feature" ], "x-ms-enum": { "name": "FeatureType", "modelAsString": true, "values": [ { "name": "Feature", "value": "Feature", "description": "Standard GeoJSON Feature type identifier" } ] } }, "FilterLanguage": { "type": "string", "description": "Choices for filter-lang value in a POST request.\n\nBased on\nhttps://github.com/stac-api-extensions/filter#queryables\n\nNote the addition of cql2-json, which is used by the pgstac backend,\nbut is not included in the spec above.\n\nDefines the supported filter languages for STAC API queries.", "enum": [ "cql-json", "cql2-json", "cql2-text" ], "x-ms-enum": { "name": "FilterLanguage", "modelAsString": true, "values": [ { "name": "cql-json", "value": "cql-json", "description": "Common Query Language in JSON format." }, { "name": "cql2-json", "value": "cql2-json", "description": "Common Query Language 2 in JSON format" }, { "name": "cql2-text", "value": "cql2-text", "description": "Common Query Language 2 in text format." } ] } }, "Geometry": { "type": "object", "description": "Represents a GeoJSON geometry object as defined by RFC 7946.\n\nSupported geometry types include:\n- **Point**: A single geographic coordinate.\n- **LineString**: A sequence of geographic coordinates forming a line.\n- **Polygon**: A closed shape defined by linear rings.\n- **MultiPoint**: A collection of Points.\n- **MultiLineString**: A collection of LineStrings.\n- **MultiPolygon**: A collection of Polygons.\n\nUsed for spatial filtering in STAC.", "properties": { "type": { "type": "string", "description": "Discriminator property for Geometry." }, "bbox": { "type": "array", "description": "Optional bounding box of the geometry.", "items": { "type": "number", "format": "float" }, "x-ms-client-name": "boundingBox" } }, "discriminator": "type", "required": [ "type" ] }, "ImageJp2Response": { "type": "object", "description": "Return an image.", "properties": { "body": { "type": "string", "format": "byte", "description": "The image data in JP2 format." } }, "required": [ "body" ] }, "ImageJpegResponse": { "type": "object", "description": "Return an image.", "properties": { "body": { "type": "string", "format": "byte", "description": "The image data in JPEG format." } }, "required": [ "body" ] }, "ImageJpgResponse": { "type": "object", "description": "Return an image.", "properties": { "body": { "type": "string", "format": "byte", "description": "The image data in JPG format." } }, "required": [ "body" ] }, "ImageParameters": { "type": "object", "description": "Parameters for requesting a rendered image from a collection", "properties": { "cql": { "type": "object", "description": "Cql", "additionalProperties": {} }, "zoom": { "type": "number", "format": "float", "description": "Zoom" }, "geometry": { "$ref": "#/definitions/Geometry", "description": "Geometry" }, "render_params": { "type": "string", "description": "JSON-encoded visualization parameters", "x-ms-client-name": "renderParameters" }, "cols": { "type": "integer", "format": "int32", "description": "Width of the output image in pixels", "x-ms-client-name": "columns" }, "rows": { "type": "integer", "format": "int32", "description": "Height of the output image in pixels" }, "showBranding": { "type": "boolean", "description": "Whether to include branding on the output image", "default": true }, "imageSize": { "type": "string", "description": "Image size", "pattern": "^[1-9][0-9]*x[1-9][0-9]*$" } }, "required": [ "cql", "render_params", "cols", "rows" ] }, "ImagePngResponse": { "type": "object", "description": "Return an image.", "properties": { "body": { "type": "string", "format": "byte", "description": "The image data in PNG format." } }, "required": [ "body" ] }, "ImageResponse": { "type": "object", "description": "Response model for image exports", "properties": { "url": { "type": "string", "format": "uri", "description": "URL of the exported image" } }, "required": [ "url" ] }, "ImageTiffResponse": { "type": "object", "description": "Return an image.", "properties": { "body": { "type": "string", "format": "byte", "description": "The image data in TIFF format." } }, "required": [ "body" ] }, "ImageWebpResponse": { "type": "object", "description": "Return an image.", "properties": { "body": { "type": "string", "format": "byte", "description": "The image data in WebP format." } }, "required": [ "body" ] }, "IngestionDefinition": { "type": "object", "description": "Microsoft Planetary Computer Pro geo-catalog ingestion creation model", "properties": { "id": { "$ref": "#/definitions/Azure.Core.uuid", "description": "Ingestion id", "readOnly": true }, "importType": { "$ref": "#/definitions/IngestionType", "description": "Ingestion type", "x-ms-mutability": [ "read", "update", "create" ] }, "displayName": { "type": "string", "description": "Ingestion name" }, "sourceCatalogUrl": { "type": "string", "format": "uri", "description": "Source catalog URL. Required for StaticCatalog ingestion type" }, "skipExistingItems": { "type": "boolean", "description": "Skip processing existing items in the catalog" }, "keepOriginalAssets": { "type": "boolean", "description": "Keep original source assets" }, "creationTime": { "type": "string", "format": "date-time", "description": "Ingestion creation time", "readOnly": true }, "status": { "$ref": "#/definitions/IngestionStatus", "description": "Ingestion status", "readOnly": true } }, "required": [ "id", "importType", "creationTime", "status" ] }, "IngestionDefinitionPagedResponse": { "type": "object", "description": "Generic paged response model", "properties": { "value": { "type": "array", "description": "The items on the page", "items": { "$ref": "#/definitions/IngestionDefinition" } }, "nextLink": { "type": "string", "format": "uri", "description": "Link to the next page of results" } }, "required": [ "value" ] }, "IngestionDefinitionUpdate": { "type": "object", "description": "Microsoft Planetary Computer Pro geo-catalog ingestion creation model", "properties": { "importType": { "$ref": "#/definitions/IngestionType", "description": "Ingestion type", "x-ms-mutability": [ "read", "update", "create" ] }, "displayName": { "type": "string", "description": "Ingestion name" }, "sourceCatalogUrl": { "type": "string", "format": "uri", "description": "Source catalog URL. Required for StaticCatalog ingestion type" }, "skipExistingItems": { "type": "boolean", "description": "Skip processing existing items in the catalog" }, "keepOriginalAssets": { "type": "boolean", "description": "Keep original source assets" } } }, "IngestionRun": { "type": "object", "description": "Microsoft Planetary Computer Pro geo-catalog ingestion run", "properties": { "id": { "$ref": "#/definitions/Azure.Core.uuid", "description": "Run id", "x-ms-mutability": [ "read", "update", "create" ] }, "parentRunId": { "$ref": "#/definitions/Azure.Core.uuid", "description": "Run id which this run is associated to because it has been retried or rerun" }, "operation": { "$ref": "#/definitions/IngestionRunOperation", "description": "Operation" }, "creationTime": { "type": "string", "format": "date-time", "description": "Creation time" }, "sourceCatalogUrl": { "type": "string", "format": "uri", "description": "URL of the source catalog" }, "skipExistingItems": { "type": "boolean", "description": "Skip any item that already exist in the GeoCatalog" }, "keepOriginalAssets": { "type": "boolean", "description": "Keep original source assets" } }, "required": [ "id", "operation", "creationTime" ] }, "IngestionRunOperation": { "type": "object", "description": "Microsoft Planetary Computer Pro geo-catalog ingestion run operation", "properties": { "id": { "$ref": "#/definitions/Azure.Core.uuid", "description": "Operation id" }, "status": { "$ref": "#/definitions/OperationStatus", "description": "Operation status" }, "creationTime": { "type": "string", "format": "date-time", "description": "The UTC time at which the operation was created" }, "statusHistory": { "type": "array", "description": "The history of the operation status in time", "items": { "$ref": "#/definitions/OperationStatusHistoryItem" } }, "startTime": { "type": "string", "format": "date-time", "description": "The UTC time at which the operation was started" }, "finishTime": { "type": "string", "format": "date-time", "description": "The UTC time at which the operation finished its execution" }, "totalItems": { "type": "integer", "format": "int32", "description": "The number of total items to be processed" }, "totalPendingItems": { "type": "integer", "format": "int32", "description": "The number of items pending to be processed" }, "totalSuccessfulItems": { "type": "integer", "format": "int32", "description": "The number of items successfully processed" }, "totalFailedItems": { "type": "integer", "format": "int32", "description": "The number of items that have failed to be processed" } }, "required": [ "id", "status", "creationTime", "statusHistory", "totalItems", "totalPendingItems", "totalSuccessfulItems", "totalFailedItems" ] }, "IngestionRunPagedResponse": { "type": "object", "description": "Generic paged response model", "properties": { "value": { "type": "array", "description": "The items on the page", "items": { "$ref": "#/definitions/IngestionRun" } }, "nextLink": { "type": "string", "format": "uri", "description": "Link to the next page of results" } }, "required": [ "value" ] }, "IngestionSource": { "type": "object", "description": "Ingestion Source", "properties": { "id": { "$ref": "#/definitions/Azure.Core.uuid", "description": "Ingestion source id", "x-ms-mutability": [ "read", "update" ] }, "created": { "type": "string", "format": "date-time", "description": "Created time in UTC format", "readOnly": true }, "kind": { "$ref": "#/definitions/IngestionSourceType", "description": "Discriminator for the ingestion source" } }, "discriminator": "kind", "required": [ "id", "kind" ] }, "IngestionSourceSummary": { "type": "object", "description": "Ingestion source summary", "properties": { "id": { "$ref": "#/definitions/Azure.Core.uuid", "description": "Ingestion source id" }, "kind": { "$ref": "#/definitions/IngestionSourceType", "description": "Ingestion source type" }, "created": { "type": "string", "format": "date-time", "description": "Created time in UTC format" } }, "required": [ "id", "kind" ] }, "IngestionSourceSummaryPagedResponse": { "type": "object", "description": "Generic paged response model", "properties": { "value": { "type": "array", "description": "The items on the page", "items": { "$ref": "#/definitions/IngestionSourceSummary" } }, "nextLink": { "type": "string", "format": "uri", "description": "Link to the next page of results" } }, "required": [ "value" ] }, "IngestionSourceType": { "type": "string", "description": "Ingestion source type", "enum": [ "SasToken", "BlobManagedIdentity" ], "x-ms-enum": { "name": "IngestionSourceType", "modelAsString": true, "values": [ { "name": "SharedAccessSignatureToken", "value": "SasToken", "description": "Azure Blob Storage SAS token" }, { "name": "BlobManagedIdentity", "value": "BlobManagedIdentity", "description": "Azure Blob Managed Identity" } ] } }, "IngestionStatus": { "type": "string", "description": "Ingestion status", "enum": [ "Ready", "Deleting" ], "x-ms-enum": { "name": "IngestionStatus", "modelAsString": true, "values": [ { "name": "Ready", "value": "Ready", "description": "Ingestion accepted and ready to be run" }, { "name": "Deleting", "value": "Deleting", "description": "Ingestion is being deleting in the background" } ] } }, "IngestionType": { "type": "string", "description": "Ingestion type", "enum": [ "StaticCatalog" ], "x-ms-enum": { "name": "IngestionType", "modelAsString": true, "values": [ { "name": "StaticCatalog", "value": "StaticCatalog", "description": "Static STAC Catalog" } ] } }, "LegendConfigType": { "type": "string", "description": "Legend type to make, one of: `continuous`, `classmap`, `interval` or `none`\n(note, `none` is a string literal).", "enum": [ "continuous", "classmap", "interval", "none" ], "x-ms-enum": { "name": "LegendConfigType", "modelAsString": true, "values": [ { "name": "continuous", "value": "continuous", "description": "Continuous color ramp legend." }, { "name": "classmap", "value": "classmap", "description": "Classified map with discrete colors for classes." }, { "name": "interval", "value": "interval", "description": "Interval-based legend with discrete ranges." }, { "name": "none", "value": "none", "description": "No legend." } ] } }, "LineString": { "type": "object", "description": "Represents a LineString.", "properties": { "coordinates": { "type": "array", "description": "The coordinates of the linestring.", "items": { "type": "array", "items": { "type": "number", "format": "float" } } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/Geometry" } ], "x-ms-discriminator-value": "LineString" }, "ManagedIdentityConnection": { "type": "object", "description": "Managed Identity connection information", "properties": { "containerUrl": { "type": "string", "format": "uri", "description": "Azure Blob Storage container URL", "x-ms-client-name": "containerUri" }, "objectId": { "$ref": "#/definitions/Azure.Core.uuid", "description": "Azure Managed Identity configured in the Geo-Catalog with access to the container" } }, "required": [ "containerUrl", "objectId" ] }, "ManagedIdentityIngestionSource": { "type": "object", "description": "Managed Identity ingestion source", "properties": { "connectionInfo": { "$ref": "#/definitions/ManagedIdentityConnection", "description": "Managed identity connection information" } }, "required": [ "connectionInfo" ], "allOf": [ { "$ref": "#/definitions/IngestionSource" } ], "x-ms-discriminator-value": "BlobManagedIdentity" }, "ManagedIdentityMetadata": { "type": "object", "description": "Managed Identity metadata", "properties": { "objectId": { "$ref": "#/definitions/Azure.Core.uuid", "description": "Object id of the managed identity" }, "resourceId": { "type": "string", "format": "arm-id", "description": "ARM path or resource id of the managed identity", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ManagedIdentity/userAssignedIdentities" } ] } } }, "required": [ "objectId", "resourceId" ] }, "ManagedIdentityMetadataPagedResponse": { "type": "object", "description": "Generic paged response model", "properties": { "value": { "type": "array", "description": "The items on the page", "items": { "$ref": "#/definitions/ManagedIdentityMetadata" } }, "nextLink": { "type": "string", "format": "uri", "description": "Link to the next page of results" } }, "required": [ "value" ] }, "MosaicMetadata": { "type": "object", "description": "Metadata information for mosaic or search results", "properties": { "type": { "type": "string", "description": "Type of metadata resource", "default": "mosaic", "enum": [ "mosaic", "search" ], "x-ms-enum": { "name": "MosaicMetadataType", "modelAsString": true, "values": [ { "name": "mosaic", "value": "mosaic", "description": "Metadata for a mosaic of multiple raster assets" }, { "name": "search", "value": "search", "description": "Metadata for a search query result" } ] } }, "bounds": { "type": "string", "description": "Geographic bounding box in [west, south, east, north] format" }, "minzoom": { "type": "integer", "format": "int32", "description": "Minimum zoom level supported", "x-ms-client-name": "minZoom" }, "maxzoom": { "type": "integer", "format": "int32", "description": "Maximum zoom level supported", "x-ms-client-name": "maxZoom" }, "name": { "type": "string", "description": "Human-readable name for the resource" }, "assets": { "type": "array", "description": "List of asset identifiers included in the resource", "items": { "type": "string" } }, "defaults": { "type": "object", "description": "Defaults", "additionalProperties": { "type": "string" } } } }, "MosaicMetadataType": { "type": "string", "description": "Type of metadata resource in the system", "enum": [ "mosaic", "search" ], "x-ms-enum": { "name": "MosaicMetadataType", "modelAsString": true, "values": [ { "name": "mosaic", "value": "mosaic", "description": "Metadata for a mosaic of multiple raster assets" }, { "name": "search", "value": "search", "description": "Metadata for a search query result" } ] } }, "MultiLineString": { "type": "object", "description": "Represents a MultiLineString.", "properties": { "coordinates": { "type": "array", "description": "The coordinates of the multilinestring.", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "float" } } } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/Geometry" } ], "x-ms-discriminator-value": "MultiLineString" }, "MultiPoint": { "type": "object", "description": "Represents a MultiPoint.", "properties": { "coordinates": { "type": "array", "description": "The coordinates of the multipoint.", "items": { "type": "array", "items": { "type": "number", "format": "float" } } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/Geometry" } ], "x-ms-discriminator-value": "MultiPoint" }, "MultiPolygon": { "type": "object", "description": "Represents a MultiPolygon.", "properties": { "coordinates": { "type": "array", "description": "The coordinates of the multipolygon.", "items": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "float" } } } } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/Geometry" } ], "x-ms-discriminator-value": "MultiPolygon" }, "NoDataType": { "type": "string", "description": "NoDataType", "enum": [ "Alpha", "Mask", "Internal", "Nodata", "None" ], "x-ms-enum": { "name": "NoDataType", "modelAsString": true, "values": [ { "name": "Alpha", "value": "Alpha", "description": "Nodata represented by alpha channel" }, { "name": "Mask", "value": "Mask", "description": "Nodata represented by a mask" }, { "name": "Internal", "value": "Internal", "description": "Nodata represented internally in the dataset" }, { "name": "Nodata", "value": "Nodata", "description": "Explicit nodata value defined in the dataset" }, { "name": "None", "value": "None", "description": "No nodata value defined" } ] } }, "Operation": { "type": "object", "description": "Microsoft Planetary Computer Pro geo-catalog operation", "properties": { "id": { "$ref": "#/definitions/Azure.Core.uuid", "description": "Operation id" }, "status": { "$ref": "#/definitions/OperationStatus", "description": "Operation status" }, "type": { "type": "string", "description": "Operation type" }, "creationTime": { "type": "string", "format": "date-time", "description": "The UTC time at which the operation was created" }, "collectionId": { "type": "string", "description": "Collection ID" }, "statusHistory": { "type": "array", "description": "The history of the operation status in time", "items": { "$ref": "#/definitions/OperationStatusHistoryItem" } }, "startTime": { "type": "string", "format": "date-time", "description": "The UTC time at which the operation was started" }, "finishTime": { "type": "string", "format": "date-time", "description": "The UTC time at which the operation finished its execution" }, "additionalInformation": { "type": "object", "description": "Additional information elements about the particular operation type", "additionalProperties": { "type": "string" } }, "error": { "$ref": "#/definitions/ErrorInfo", "description": "Error information" } }, "required": [ "id", "status", "type", "creationTime", "statusHistory" ] }, "OperationPagedResponse": { "type": "object", "description": "Generic paged response model", "properties": { "value": { "type": "array", "description": "The items on the page", "items": { "$ref": "#/definitions/Operation" } }, "nextLink": { "type": "string", "format": "uri", "description": "Link to the next page of results" } }, "required": [ "value" ] }, "OperationStatus": { "type": "string", "description": "Operation status", "enum": [ "Pending", "Running", "Succeeded", "Canceled", "Canceling", "Failed" ], "x-ms-enum": { "name": "OperationStatus", "modelAsString": true, "values": [ { "name": "Pending", "value": "Pending", "description": "Operation accepted and ready to be run" }, { "name": "Running", "value": "Running", "description": "Operation is running" }, { "name": "Succeeded", "value": "Succeeded", "description": "Operation has already finished its execution" }, { "name": "Canceled", "value": "Canceled", "description": "Operation canceled by the user" }, { "name": "Canceling", "value": "Canceling", "description": "Operation is being canceling" }, { "name": "Failed", "value": "Failed", "description": "Operation failed" } ] } }, "OperationStatusHistoryItem": { "type": "object", "description": "Operation status history item", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The UTC time at which the status was set" }, "status": { "$ref": "#/definitions/OperationStatus", "description": "The status of the operation" }, "errorCode": { "type": "string", "description": "If the status is failed, the error code" }, "errorMessage": { "type": "string", "description": "If the status is failed, the error message" } }, "required": [ "timestamp", "status" ] }, "PartitionType": { "type": "object", "description": "Defines how data is partitioned for efficient storage and retrieval.", "properties": { "scheme": { "type": "string", "description": "Partitioning scheme to use for data organization.", "default": "none", "enum": [ "year", "month", "none" ], "x-ms-enum": { "name": "PartitionTypeScheme", "modelAsString": true, "values": [ { "name": "year", "value": "year", "description": "Partition data by year." }, { "name": "month", "value": "month", "description": "Partition data by month." }, { "name": "none", "value": "none", "description": "No partitioning." } ] } } } }, "PartitionTypeScheme": { "type": "string", "description": "Defines partitioning schemes for temporal data organization.", "enum": [ "year", "month", "none" ], "x-ms-enum": { "name": "PartitionTypeScheme", "modelAsString": true, "values": [ { "name": "year", "value": "year", "description": "Partition data by year." }, { "name": "month", "value": "month", "description": "Partition data by month." }, { "name": "none", "value": "none", "description": "No partitioning." } ] } }, "PixelSelection": { "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported (default:\n'WebMercatorQuad')\n\nRepresents the method used to select or compute pixels when creating\ncomposites from multiple sources", "enum": [ "first", "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh" ], "x-ms-enum": { "name": "PixelSelection", "modelAsString": true, "values": [ { "name": "first", "value": "first", "description": "Select pixel from the first available image" }, { "name": "highest", "value": "highest", "description": "Select pixel with the highest value" }, { "name": "lowest", "value": "lowest", "description": "Select pixel with the lowest value" }, { "name": "mean", "value": "mean", "description": "Calculate mean of available pixels" }, { "name": "median", "value": "median", "description": "Calculate median of available pixels" }, { "name": "standardDeviation", "value": "stdev", "description": "Calculate standard deviation of available pixels" }, { "name": "lastBandLow", "value": "lastbandlow", "description": "Select image with lowest value in the last band" }, { "name": "lastBandHigh", "value": "lastbandhigh", "description": "Select image with highest value in the last band" } ] } }, "Point": { "type": "object", "description": "Represents a GeoJSON Point geometry.", "properties": { "coordinates": { "type": "array", "description": "The coordinates of the point as [longitude, latitude].", "items": { "type": "number", "format": "float" } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/Geometry" } ], "x-ms-discriminator-value": "Point" }, "Polygon": { "type": "object", "description": "Represents a Polygon.", "properties": { "coordinates": { "type": "array", "description": "The coordinates of the polygon.", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "float" } } } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/Geometry" } ], "x-ms-discriminator-value": "Polygon" }, "QueryableDefinitionsResponse": { "type": "object", "description": "Queryable definitions response.", "additionalProperties": {} }, "RegisterMosaic": { "type": "object", "description": "Input parameters for registering a new mosaic of STAC items", "properties": { "collections": { "type": "array", "description": "List of STAC collection IDs to include in the mosaic", "items": { "type": "string" } }, "ids": { "type": "array", "description": "List of specific STAC item IDs to include in the mosaic", "items": { "type": "string" } }, "bbox": { "type": "array", "description": "Geographic bounding box to filter items [west, south, east, north]", "items": { "type": "number", "format": "float" }, "x-ms-client-name": "boundingBox" }, "intersects": { "$ref": "#/definitions/Geometry", "description": "GeoJSON geometry to spatially filter items by intersection" }, "query": { "type": "object", "description": "Query", "additionalProperties": {} }, "filter": { "type": "object", "description": "Filter", "additionalProperties": {} }, "datetime": { "type": "string", "description": "Temporal filter in RFC 3339 format or interval" }, "sortby": { "type": "array", "description": "Criteria for ordering items in the mosaic", "items": { "$ref": "#/definitions/StacSortExtension" }, "x-ms-client-name": "sortBy" }, "filter-lang": { "$ref": "#/definitions/FilterLanguage", "description": "Query language format used in the filter parameter", "x-ms-client-name": "filterLanguage" }, "metadata": { "$ref": "#/definitions/MosaicMetadata", "description": "Additional metadata to associate with the mosaic" } } }, "RenderOption": { "type": "object", "description": "Defines visualization parameters for rendering data on a map.", "properties": { "id": { "type": "string", "description": "Unique identifier for the render option.", "minLength": 1, "maxLength": 30, "pattern": "^(?!\\-|_)[a-zA-Z0-9_-]*(?