Microsoft.PlanetaryComputer (preview:2025-04-30)

2025/05/15 • 101 new methods

TilerStaticImages_Create (new)
Description :  Create a new image export.
Reference :  Link ¶

⚼ Request

POST:  /data/collections/{collectionId}/image/static
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: STAC Collection ID ,
Required: True ,
}
string ,
body:
{
Description: Image request body ,
Required: True ,
}
{
cql:
{
Description: Cql ,
Required: True ,
}
{
filter-lang:
{
Description: Filter language ,
Required: True ,
}
string ,
filter:
{
Description: Filter ,
Required: True ,
}
{
op:
{
Description: Logical operator ,
Required: True ,
}
string ,
args:
{
Description: Arguments for the logical operator ,
Required: True ,
}
[
string ,
]
,
}
,
sortby:
{
Description: Sort by ,
Required: False ,
}
[
{
field:
{
Description: Field to sort by ,
Required: True ,
}
string ,
direction:
{
Description: Sort direction ,
Required: True ,
}
string ,
}
,
]
,
}
,
geometry:
{
Description: Geometry ,
Required: False ,
}
string ,
render_params:
{
Description: JSON-encoded visualization parameters ,
Required: True ,
}
string ,
cols:
{
Description: Width of the output image in pixels ,
Format: int32 ,
Required: True ,
}
integer ,
rows:
{
Description: Height of the output image in pixels ,
Format: int32 ,
Required: True ,
}
integer ,
format:
{
Description: Output format for the generated image ,
Enum:
{
png: Portable Network Graphics format ,
cog: Cloud Optimized GeoTIFF format ,
}
,
Required: False ,
}
enum ,
showBranding:
{
Description: Whether to include branding on the output image ,
Required: False ,
}
boolean ,
mask:
{
Description: Whether to apply masking to invalid or no-data areas ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerStaticImages_Get (new)
Description :  Fetch an existing image export by ID
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/image/static/{id}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: STAC Collection ID ,
Required: True ,
}
string ,
id:
{
Description: Image export ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerWmtsTileMatrixSets_GetCapabilitiesXml (new)
Description :  OGC WMTS endpoint.
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/{tileMatrixSetId}/WMTSCapabilities.xml
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
tileMatrixSetId:
{
Description: Identifier selecting one of the TileMatrixSetId supported ,
Required: True ,
}
string ,
tile_format:
{
Description: Output image type. Default is png. ,
Required: False ,
}
string ,
tile_scale:
{
Description: Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512). ,
Format: int32 ,
Required: False ,
}
integer ,
minzoom:
{
Description: Overwrite default minzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
maxzoom:
{
Description: Overwrite default maxzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
buffer:
{
Description: Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258). ,
Required: False ,
}
string ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerTileJsonTileMatrixSets_Get (new)
Description :  Return the Tilejson Tilematrixsetid As a path
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/{tileMatrixSetId}/tilejson.json
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
tileMatrixSetId:
{
Description: Identifier selecting one of the TileMatrixSetId supported ,
Required: True ,
}
string ,
tile_format:
{
Description: Default will be automatically defined if the output image needs a mask (png) or not (jpeg). ,
Required: False ,
}
string ,
tile_scale:
{
Description: Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512). ,
Format: int32 ,
Required: False ,
}
integer ,
minzoom:
{
Description: Overwrite default minzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
maxzoom:
{
Description: Overwrite default maxzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
buffer:
{
Description: Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258). ,
Required: False ,
}
string ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
tilejson:
{
Description: Tilejson ,
Required: False ,
}
string ,
name:
{
Description: Human-readable name of the tile set ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the tile set ,
Required: False ,
}
string ,
version:
{
Description: Version ,
Required: False ,
}
string ,
attribution:
{
Description: Attribution text for the data sources ,
Required: False ,
}
string ,
template:
{
Description: URL template for feature info queries ,
Required: False ,
}
string ,
legend:
{
Description: URL to legend content for the tile set ,
Required: False ,
}
string ,
scheme:
{
Description: Tile addressing scheme (xyz or tms) ,
Enum:
{
xyz: XYZ tile addressing scheme with origin at top-left ,
tms: TMS tile addressing scheme with origin at bottom-left ,
}
,
Required: False ,
}
enum ,
tiles:
{
Description: Array of tile URL templates ,
Required: True ,
}
[
string ,
]
,
grids:
{
Description: Array of UTFGrid URL templates ,
Required: False ,
}
[
string ,
]
,
data:
{
Description: Array of data file URL templates ,
Required: False ,
}
[
string ,
]
,
minzoom:
{
Description: Minimum zoom level available in the tile set ,
Format: int32 ,
Required: False ,
}
integer ,
maxzoom:
{
Description: Maximum zoom level available in the tile set ,
Format: int32 ,
Required: False ,
}
integer ,
bounds:
{
Description: Bounds ,
Required: False ,
}
[
number ,
]
,
center:
{
Description: Default center point [longitude, latitude, zoom] for the tile set ,
Required: False ,
}
[
number ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerWmts_GetCapabilitiesXml (new)
Description :  OGC WMTS endpoint.
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/WMTSCapabilities.xml
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
tileMatrixSetId:
{
Description: Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad') ,
Required: False ,
}
string ,
tile_format:
{
Description: Output image type. Default is png. ,
Required: False ,
}
string ,
tile_scale:
{
Description: Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512). ,
Format: int32 ,
Required: False ,
}
integer ,
minzoom:
{
Description: Overwrite default minzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
maxzoom:
{
Description: Overwrite default maxzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
buffer:
{
Description: Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258). ,
Required: False ,
}
string ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerAssetStatistics_GetAll (new)
Description :  Per Asset statistics
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/asset_statistics
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
max_size:
{
Description: Maximum dimension in pixels for the source data used to calculate statistics ,
Format: int32 ,
Required: False ,
}
integer ,
categorical:
{
Description: Return statistics for categorical dataset. ,
Required: False ,
}
boolean ,
c:
{
Description: List of values for which to report counts. ,
Required: False ,
}
array ,
p:
{
Description: List of percentile values (default to [2, 98]). ,
Required: False ,
}
array ,
histogram_bins:
{
Description: Defines the number of equal-width bins in the given range (10, by default). If bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths. link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html ,
Required: False ,
}
string ,
histogram_range:
{
Description: Comma `,` delimited range of the bins. The lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()). Values outside the range are ignored. The first element of the range must be less than or equal to the second. range affects the automatic bin computation as well. link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
data:
{
Description: Response Asset Statistics Api Collections Collection Id Items Item Id Asset Statistics Get ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerAvailableAssets_GetAll (new)
Description :  Return a list of supported assets.
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/assets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerBound_GetAll (new)
Description :  Return all Bounds
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/bounds
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
bounds:
{
Description: Array of coordinates defining the bounding box [west, south, east, north] ,
Required: True ,
}
[
number ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerParts_GetMinxMinyMaxxMaxyFormat (new)
Description :  Create image from part of a dataset.
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/crop/{minx},{miny},{maxx},{maxy}.{format}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
minx:
{
Description: Bounding box min X ,
Format: float ,
Required: True ,
}
number ,
miny:
{
Description: Bounding box min Y ,
Format: float ,
Required: True ,
}
number ,
maxx:
{
Description: Bounding box max X ,
Format: float ,
Required: True ,
}
number ,
maxy:
{
Description: Bounding box max Y ,
Format: float ,
Required: True ,
}
number ,
format:
{
Description: Output format for the tile or image (e.g., png, jpeg, webp). ,
Required: True ,
}
string ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
dst-crs:
{
Description: Output Coordinate Reference System. ,
Required: False ,
}
string ,
coord-crs:
{
Description: Coordinate Reference System of the input coords. Default to `epsg:4326`. ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
max_size:
{
Description: Image output size limit if width and height limits are not set. ,
Format: int32 ,
Required: False ,
}
integer ,
height:
{
Description: Height in pixels for the output image ,
Format: int32 ,
Required: False ,
}
integer ,
width:
{
Description: Width in pixels for the output image ,
Format: int32 ,
Required: False ,
}
integer ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerGeoJsons_CropWidthxHeightFormat (new)
Description :  Create image from a geojson feature.
Reference :  Link ¶

⚼ Request

POST:  /data/collections/{collectionId}/items/{itemId}/crop/{width}x{height}.{format}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
width:
{
Description: Width in pixels for the output image. ,
Format: float ,
Required: True ,
}
number ,
height:
{
Description: Height in pixels for the output image. ,
Format: float ,
Required: True ,
}
number ,
format:
{
Description: Output format for the tile or image (e.g., png, jpeg, webp). ,
Required: True ,
}
string ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
coord-crs:
{
Description: Coordinate Reference System of the input coords. Default to `epsg:4326`. ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
max_size:
{
Description: Image output size limit if width and height limits are not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
body:
{
Description: Request GeoJson body. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerParts_GetMinxMinyMaxxMaxyWidthxHeightFormat (new)
Description :  Create image from part of a dataset.
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/crop/{minx},{miny},{maxx},{maxy}/{width}x{height}.{format}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
minx:
{
Description: Bounding box min X ,
Format: float ,
Required: True ,
}
number ,
miny:
{
Description: Bounding box min Y ,
Format: float ,
Required: True ,
}
number ,
maxx:
{
Description: Bounding box max X ,
Format: float ,
Required: True ,
}
number ,
maxy:
{
Description: Bounding box max Y ,
Format: float ,
Required: True ,
}
number ,
width:
{
Description: Width in pixels for the output image. ,
Format: float ,
Required: True ,
}
number ,
height:
{
Description: Height in pixels for the output image. ,
Format: float ,
Required: True ,
}
number ,
format:
{
Description: Output format for the tile or image (e.g., png, jpeg, webp). ,
Required: True ,
}
string ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
dst-crs:
{
Description: Output Coordinate Reference System. ,
Required: False ,
}
string ,
coord-crs:
{
Description: Coordinate Reference System of the input coords. Default to `epsg:4326`. ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
max_size:
{
Description: Image output size limit if width and height limits are not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerGeoJsons_CropFormat (new)
Description :  Create image from a geojson feature.
Reference :  Link ¶

⚼ Request

POST:  /data/collections/{collectionId}/items/{itemId}/crop.{format}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
format:
{
Description: Output format for the tile or image (e.g., png, jpeg, webp) (default: "png"). ,
Required: True ,
}
string ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
coord-crs:
{
Description: Coordinate Reference System of the input coords. Default to `epsg:4326`. ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
max_size:
{
Description: Image output size limit if width and height limits are not set. ,
Format: int32 ,
Required: False ,
}
integer ,
height:
{
Description: Height in pixels for the output image ,
Format: int32 ,
Required: False ,
}
integer ,
width:
{
Description: Width in pixels for the output image ,
Format: int32 ,
Required: False ,
}
integer ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
body:
{
Description: Request GeoJson body. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerInfoOperations_Get (new)
Description :  Return dataset's basic info.
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/info
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
data:
{
Description: body for info operation response ,
Required: True ,
}
{
bounds:
{
Description: Bounds ,
Required: True ,
}
[
number ,
]
,
band_metadata:
{
Description: Band Metadata ,
Required: False ,
}
[
string ,
]
,
band_descriptions:
{
Description: Band Descriptions ,
Required: False ,
}
[
string ,
]
,
dtype:
{
Description: Data type ,
Required: True ,
}
string ,
nodata_type:
{
Description: NoData Type ,
Enum:
{
Alpha: Nodata represented by alpha channel ,
Mask: Nodata represented by a mask ,
Internal: Nodata represented internally in the dataset ,
Nodata: Explicit nodata value defined in the dataset ,
None: No nodata value defined ,
}
,
Required: False ,
}
enum ,
colorinterp:
{
Description: Color interpretation ,
Required: False ,
}
[
string ,
]
,
driver:
{
Description: Driver ,
Required: False ,
}
string ,
count:
{
Description: Count ,
Format: int32 ,
Required: False ,
}
integer ,
width:
{
Description: Width ,
Format: int32 ,
Required: False ,
}
integer ,
height:
{
Description: Height ,
Format: int32 ,
Required: False ,
}
integer ,
overviews:
{
Description: Overviews ,
Required: False ,
}
[
string ,
]
,
scales:
{
Description: Scales ,
Required: False ,
}
[
integer ,
]
,
offsets:
{
Description: Offsets ,
Required: False ,
}
[
integer ,
]
,
colormap:
{
Description: Colormap ,
Required: False ,
}
object ,
minzoom:
{
Description: Minzoom ,
Format: int64 ,
Required: False ,
}
integer ,
maxzoom:
{
Description: Maxzoom ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerInfoGeoJsonOperations_Get (new)
Description :  Return Info Geojson
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/info.geojson
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
type:
{
Description: GeoJSON type identifier ,
Enum:
{
Feature: Standard GeoJSON Feature type identifier ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: Geometry object defining the feature's shape ,
Required: True ,
}
string ,
properties:
{
Description: Properties ,
Required: True ,
}
object ,
id:
{
Description: Unique identifier for the feature ,
Required: False ,
}
string ,
bbox:
{
Description: Bounding box coordinates for the feature ,
Format: double ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerPoints_GetLonLat (new)
Description :  Get Point value for a dataset.
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/point/{lon},{lat}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
lon:
{
Description: Longitude ,
Format: double ,
Required: True ,
}
number ,
lat:
{
Description: Latitude ,
Format: float ,
Required: True ,
}
number ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
coord-crs:
{
Description: Coordinate Reference System of the input coords. Default to `epsg:4326`. ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
coordinates:
{
Description: Geographic coordinates [longitude, latitude] of the queried point ,
Required: True ,
}
[
number ,
]
,
values:
{
Description: Array of pixel values at the queried point for each band ,
Required: True ,
}
[
number ,
]
,
band_names:
{
Description: Names of each band in the raster data ,
Required: True ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerPreviews_Get (new)
Description :  Create preview of a dataset.
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/preview
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
format:
{
Description: Output format for the tile or image (e.g., png, jpeg, webp). ,
Required: False ,
}
string ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
dst-crs:
{
Description: Output Coordinate Reference System. ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
max_size:
{
Description: Image output size limit if width and height limits are not set. ,
Format: int32 ,
Required: False ,
}
integer ,
height:
{
Description: Height in pixels for the output image ,
Format: int32 ,
Required: False ,
}
integer ,
width:
{
Description: Width in pixels for the output image ,
Format: int32 ,
Required: False ,
}
integer ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerPreviews_GetFormat (new)
Description :  Create preview of a dataset.
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/preview.{format}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
format:
{
Description: Output format for the tile or image (e.g., png, jpeg, webp). ,
Required: True ,
}
string ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
dst-crs:
{
Description: Output Coordinate Reference System. ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
max_size:
{
Description: Image output size limit if width and height limits are not set. ,
Format: int32 ,
Required: False ,
}
integer ,
height:
{
Description: Height in pixels for the output image ,
Format: int32 ,
Required: False ,
}
integer ,
width:
{
Description: Width in pixels for the output image ,
Format: int32 ,
Required: False ,
}
integer ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerStatistics_GetAll (new)
Description :  Merged assets statistics.
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/statistics
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
max_size:
{
Description: Maximum dimension in pixels for the source data used to calculate statistics ,
Format: int32 ,
Required: False ,
}
integer ,
categorical:
{
Description: Return statistics for categorical dataset. ,
Required: False ,
}
boolean ,
c:
{
Description: List of values for which to report counts. ,
Required: False ,
}
array ,
p:
{
Description: List of percentile values (default to [2, 98]). ,
Required: False ,
}
array ,
histogram_bins:
{
Description: Defines the number of equal-width bins in the given range (10, by default). If bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths. link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html ,
Required: False ,
}
string ,
histogram_range:
{
Description: Comma `,` delimited range of the bins. The lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()). Values outside the range are ignored. The first element of the range must be less than or equal to the second. range affects the automatic bin computation as well. link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Return dataset's statistics. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerGeoJsonStatistics_GetAll (new)
Description :  Get Statistics from a geojson feature or featureCollection.
Reference :  Link ¶

⚼ Request

POST:  /data/collections/{collectionId}/items/{itemId}/statistics
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
coord-crs:
{
Description: Coordinate Reference System of the input coords. Default to `epsg:4326`. ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
max_size:
{
Description: Maximum dimension in pixels for the source data used to calculate statistics ,
Format: int32 ,
Required: False ,
}
integer ,
categorical:
{
Description: Return statistics for categorical dataset. ,
Required: False ,
}
boolean ,
c:
{
Description: List of values for which to report counts. ,
Required: False ,
}
array ,
p:
{
Description: List of percentile values (default to [2, 98]). ,
Required: False ,
}
array ,
histogram_bins:
{
Description: Defines the number of equal-width bins in the given range (10, by default). If bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths. link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html ,
Required: False ,
}
string ,
histogram_range:
{
Description: Comma `,` delimited range of the bins. The lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()). Values outside the range are ignored. The first element of the range must be less than or equal to the second. range affects the automatic bin computation as well. link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html ,
Required: False ,
}
string ,
body:
{
Description: Request GeoJson body ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: GeoJSON type identifier for ItemCollection ,
Enum:
{
FeatureCollection: Standard GeoJSON FeatureCollection type. ,
}
,
Required: True ,
}
enum ,
features:
{
Description: Array of STAC items with statistics ,
Required: True ,
}
[
{
type:
{
Description: GeoJSON type identifier for Feature ,
Enum:
{
Feature: Standard GeoJSON Feature type identifier ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: Geometry object defining the feature's shape ,
Required: True ,
}
string ,
bbox:
{
Description: Bounding box coordinates for the feature ,
Required: True ,
}
[
number ,
]
,
id:
{
Description: Unique identifier for the feature ,
Required: True ,
}
string ,
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
collection:
{
Description: ID of the STAC collection this item belongs to ,
Required: False ,
}
string ,
properties:
{
Description: Properties ,
Required: True ,
}
{
platform:
{
Description: Platform that acquired the data. ,
Required: False ,
}
string ,
instruments:
{
Description: Instruments that acquired the data. ,
Required: False ,
}
[
string ,
]
,
constellation:
{
Description: Constellation of satellites that acquired the data. ,
Required: False ,
}
string ,
mission:
{
Description: Mission associated with the data. ,
Required: False ,
}
string ,
providers:
{
Description: Organizations or individuals who provide the data. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provider organization or individual. ,
Required: True ,
}
string ,
description:
{
Description: Description of the provider. ,
Required: False ,
}
string ,
roles:
{
Description: Roles played by the provider (e.g., producer, processor, host). ,
Required: False ,
}
[
string ,
]
,
url:
{
Description: URL to the provider's website. ,
Required: False ,
}
string ,
}
,
]
,
gsd:
{
Description: Ground sample distance in meters. ,
Format: float ,
Required: False ,
}
number ,
created:
{
Description: Creation timestamp of the data. ,
Format: date-time ,
Required: False ,
}
string ,
updated:
{
Description: Last update timestamp of the data. ,
Format: date-time ,
Required: False ,
}
string ,
title:
{
Description: Human-readable title for the item. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the item. ,
Required: False ,
}
string ,
datetime:
{
Description: Datetime the asset represents in RFC 3339 format. ,
Required: True ,
}
string ,
start_datetime:
{
Description: Start time of the item observation period. ,
Format: date-time ,
Required: False ,
}
string ,
end_datetime:
{
Description: End time of the item observation period. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
_msft:ts:
{
Description: MSFT Timestamp ,
Required: False ,
}
string ,
_msft:etag:
{
Description: MSFT ETag ,
Required: False ,
}
string ,
stac_extensions:
{
Description: List of STAC extension URLs used by this item ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
bbox:
{
Description: Bounding box coordinates [west, south, east, north] ,
Required: False ,
}
[
number ,
]
,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: List of STAC extension URLs used by this item collection ,
Required: False ,
}
[
string ,
]
,
links:
{
Description: Related links for the item collection ,
Required: False ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
context:
{
Description: https://github.com/radiantearth/stac-api-spec/tree/master/extensions/context#context-extension-specification Pagination context for the response ,
Required: False ,
}
{
returned:
{
Description: Number of items returned in the response. ,
Format: int32 ,
Required: True ,
}
integer ,
limit:
{
Description: Maximum number of items requested. ,
Format: int32 ,
Required: False ,
}
integer ,
matched:
{
Description: Total number of items matching the query. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerTileJsonOperations_Get (new)
Description :  Return Tilejson
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/tilejson.json
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
tileMatrixSetId:
{
Description: Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad') ,
Required: False ,
}
string ,
tile_format:
{
Description: Default will be automatically defined if the output image needs a mask (png) or not (jpeg). ,
Required: False ,
}
string ,
tile_scale:
{
Description: Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512). ,
Format: int32 ,
Required: False ,
}
integer ,
minzoom:
{
Description: Overwrite default minzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
maxzoom:
{
Description: Overwrite default maxzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
buffer:
{
Description: Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258). ,
Required: False ,
}
string ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
tilejson:
{
Description: Tilejson ,
Required: False ,
}
string ,
name:
{
Description: Human-readable name of the tile set ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the tile set ,
Required: False ,
}
string ,
version:
{
Description: Version ,
Required: False ,
}
string ,
attribution:
{
Description: Attribution text for the data sources ,
Required: False ,
}
string ,
template:
{
Description: URL template for feature info queries ,
Required: False ,
}
string ,
legend:
{
Description: URL to legend content for the tile set ,
Required: False ,
}
string ,
scheme:
{
Description: Tile addressing scheme (xyz or tms) ,
Enum:
{
xyz: XYZ tile addressing scheme with origin at top-left ,
tms: TMS tile addressing scheme with origin at bottom-left ,
}
,
Required: False ,
}
enum ,
tiles:
{
Description: Array of tile URL templates ,
Required: True ,
}
[
string ,
]
,
grids:
{
Description: Array of UTFGrid URL templates ,
Required: False ,
}
[
string ,
]
,
data:
{
Description: Array of data file URL templates ,
Required: False ,
}
[
string ,
]
,
minzoom:
{
Description: Minimum zoom level available in the tile set ,
Format: int32 ,
Required: False ,
}
integer ,
maxzoom:
{
Description: Maximum zoom level available in the tile set ,
Format: int32 ,
Required: False ,
}
integer ,
bounds:
{
Description: Bounds ,
Required: False ,
}
[
number ,
]
,
center:
{
Description: Default center point [longitude, latitude, zoom] for the tile set ,
Required: False ,
}
[
number ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerTiles_GetZxyScalexFormat (new)
Description :  Create map tile from a dataset.
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/tiles/{z}/{x}/{y}@{scale}x.{format}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
z:
{
Description: Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile. ,
Format: float ,
Required: True ,
}
number ,
x:
{
Description: Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix. ,
Format: float ,
Required: True ,
}
number ,
y:
{
Description: Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix. ,
Format: float ,
Required: True ,
}
number ,
scale:
{
Description: Numeric scale factor for the tile. Higher values produce larger tiles (default: "1") ,
Format: float ,
Required: True ,
}
number ,
format:
{
Description: Output format for the tile or image (e.g., png, jpeg, webp) (default: "png"). ,
Required: True ,
}
string ,
tileMatrixSetId:
{
Description: Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad') ,
Required: False ,
}
string ,
buffer:
{
Description: Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258). ,
Required: False ,
}
string ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
subdataset_name:
{
Description: The name of a subdataset within the asset. ,
Required: False ,
}
string ,
subdataset_bands:
{
Description: The index of a subdataset band within the asset. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TilerTileMatrixSets_GetZxyScalexFormat (new)
Description :  Create map tile from a dataset.
Reference :  Link ¶

⚼ Request

GET:  /data/collections/{collectionId}/items/{itemId}/tiles/{tileMatrixSetId}/{z}/{x}/{y}@{scale}x.{format}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
collectionId:
{
Description: STAC Collection Identifier ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item Identifier ,
Required: True ,
}
string ,
tileMatrixSetId:
{
Description: Identifier selecting one of the TileMatrixSetId supported ,
Required: True ,
}
string ,
z:
{
Description: Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile. ,
Format: float ,
Required: True ,
}
number ,
x:
{
Description: Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix. ,
Format: float ,
Required: True ,
}
number ,
y:
{
Description: Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix. ,
Format: float ,
Required: True ,
}
number ,
scale:
{
Description: Numeric scale factor for the tile. Higher values produce larger tiles (default: "1") ,
Format: float ,
Required: True ,
}
number ,
format:
{
Description: Output format for the tile or image (e.g., png, jpeg, webp) (default: "png"). ,
Required: True ,
}
string ,
buffer:
{
Description: Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258). ,
Required: False ,
}
string ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
subdataset_name:
{
Description: The name of a subdataset within the asset. ,
Required: False ,
}
string ,
subdataset_bands:
{
Description: The index of a subdataset band within the asset. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
MapsClassmapLegends_Get (new)
Description :  Generate values and color swatches mapping for a given classmap. Args: trim_start (int, optional): Number of items to trim from the start of the cmap trim_end (int, optional): Number of items to trim from the end of the cmap
Reference :  Link ¶

⚼ Request

GET:  /data/legend/classmap/{classmapName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
classmapName:
{
Description: classmap name ,
Required: True ,
}
string ,
trim_start:
{
Description: Number of items to trim from the start of the cmap ,
Format: int32 ,
Required: False ,
}
integer ,
trim_end:
{
Description: Number of items to trim from the end of the cmap ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
$schema:
{
Description: Classmap legend response model. ,
}
object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
MapsLegends_Get (new)
Description :  Generate a legend image for a given colormap. If the colormap has non-contiguous values at the beginning or end, which aren't desired in the output image, they can be trimmed by specifying the number of values to trim. Args: cmap_name (string): The name of the registered colormap to generate a legend for height (float, optional): The output height of the legend image width (float, optional): The output width of the legend image trim_start (int, optional): Number of items to trim from the start of the cmap trim_end (int, optional): Number of items to trim from the end of the cmap Returns: HTTP response with jpeg encoded image data
Reference :  Link ¶

⚼ Request

GET:  /data/legend/colormap/{cmapName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
cmapName:
{
Description: The name of the registered colormap to generate a legend for ,
Required: True ,
}
string ,
height:
{
Description: The output height of the legend image ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: The output width of the legend image ,
Format: double ,
Required: False ,
}
number ,
trim_start:
{
Description: Number of items to trim from the start of the cmap ,
Format: int32 ,
Required: False ,
}
integer ,
trim_end:
{
Description: Number of items to trim from the end of the cmap ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
MapsIntervalLegends_GetByClassmapName (new)
Description :  Generate values and color swatches mapping for a given interval classmap. Args: trim_start (int, optional): Number of items to trim from the start of the cmap trim_end (int, optional): Number of items to trim from the end of the cmap
Reference :  Link ¶

⚼ Request

GET:  /data/legend/interval/{classmapName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
classmapName:
{
Description: classmap name ,
Required: True ,
}
string ,
trim_start:
{
Description: Number of items to trim from the start of the cmap ,
Format: int32 ,
Required: False ,
}
integer ,
trim_end:
{
Description: Number of items to trim from the end of the cmap ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
MosaicsWmtsMosaicsTileMatrixSets_GetCapabilitiesXml (new)
Description :  OGC WMTS endpoint.
Reference :  Link ¶

⚼ Request

GET:  /data/mosaic/{searchId}/{tileMatrixSetId}/WMTSCapabilities.xml
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
searchId:
{
Description: Search Id (pgSTAC Search Hash) ,
Required: True ,
}
string ,
tileMatrixSetId:
{
Description: Identifier selecting one of the TileMatrixSetId supported ,
Required: True ,
}
string ,
tile_format:
{
Description: Output image type. Default is png. ,
Required: False ,
}
string ,
tile_scale:
{
Description: Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512). ,
Format: int32 ,
Required: False ,
}
integer ,
minzoom:
{
Description: Overwrite default minzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
maxzoom:
{
Description: Overwrite default maxzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
MosaicsAssetsForPoints_GetLonLatAssets (new)
Description :  Return a list of assets for a given point.
Reference :  Link ¶

⚼ Request

GET:  /data/mosaic/{searchId}/{lon},{lat}/assets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
searchId:
{
Description: Search Id (pgSTAC Search Hash) ,
Required: True ,
}
string ,
scan_limit:
{
Description: Return as soon as we scan N items (defaults to 10000 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
items_limit:
{
Description: Return as soon as we have N items per geometry (defaults to 100 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
time_limit:
{
Description: Return after N seconds to avoid long requests (defaults to 5 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
exitwhenfull:
{
Description: Return as soon as the geometry is fully covered (defaults to True in PgSTAC). ,
Required: False ,
}
boolean ,
skipcovered:
{
Description: Skip any items that would show up completely under the previous items (defaults to True in PgSTAC). ,
Required: False ,
}
boolean ,
lon:
{
Description: Longitude ,
Format: float ,
Required: True ,
}
number ,
lat:
{
Description: Latitude ,
Format: float ,
Required: True ,
}
number ,
coord-crs:
{
Description: Coordinate Reference System of the input coords. Default to `epsg:4326`. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
MosaicsTileMatrixSetsTileJson_Get (new)
Description :  Return TileJSON document for a searchId.
Reference :  Link ¶

⚼ Request

GET:  /data/mosaic/{searchId}/{tileMatrixSetId}/tilejson.json
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
searchId:
{
Description: Search Id (pgSTAC Search Hash) ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
scan_limit:
{
Description: Return as soon as we scan N items (defaults to 10000 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
items_limit:
{
Description: Return as soon as we have N items per geometry (defaults to 100 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
time_limit:
{
Description: Return after N seconds to avoid long requests (defaults to 5 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
exitwhenfull:
{
Description: Return as soon as the geometry is fully covered (defaults to True in PgSTAC). ,
Required: False ,
}
boolean ,
skipcovered:
{
Description: Skip any items that would show up completely under the previous items (defaults to True in PgSTAC). ,
Required: False ,
}
boolean ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
tileMatrixSetId:
{
Description: Identifier selecting one of the TileMatrixSetId supported ,
Required: True ,
}
string ,
minzoom:
{
Description: Overwrite default minzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
maxzoom:
{
Description: Overwrite default maxzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
tile_format:
{
Description: Default will be automatically defined if the output image needs a mask (png) or not (jpeg). ,
Required: False ,
}
string ,
tile_scale:
{
Description: Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512). ,
Format: int32 ,
Required: False ,
}
integer ,
buffer:
{
Description: Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258). ,
Required: False ,
}
string ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
collection:
{
Description: STAC Collection ID ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
pixel_selection:
{
Description: Pixel selection method. ,
Required: False ,
}
string ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
tilejson:
{
Description: Tilejson ,
Required: False ,
}
string ,
name:
{
Description: Human-readable name of the tile set ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the tile set ,
Required: False ,
}
string ,
version:
{
Description: Version ,
Required: False ,
}
string ,
attribution:
{
Description: Attribution text for the data sources ,
Required: False ,
}
string ,
template:
{
Description: URL template for feature info queries ,
Required: False ,
}
string ,
legend:
{
Description: URL to legend content for the tile set ,
Required: False ,
}
string ,
scheme:
{
Description: Tile addressing scheme (xyz or tms) ,
Enum:
{
xyz: XYZ tile addressing scheme with origin at top-left ,
tms: TMS tile addressing scheme with origin at bottom-left ,
}
,
Required: False ,
}
enum ,
tiles:
{
Description: Array of tile URL templates ,
Required: True ,
}
[
string ,
]
,
grids:
{
Description: Array of UTFGrid URL templates ,
Required: False ,
}
[
string ,
]
,
data:
{
Description: Array of data file URL templates ,
Required: False ,
}
[
string ,
]
,
minzoom:
{
Description: Minimum zoom level available in the tile set ,
Format: int32 ,
Required: False ,
}
integer ,
maxzoom:
{
Description: Maximum zoom level available in the tile set ,
Format: int32 ,
Required: False ,
}
integer ,
bounds:
{
Description: Bounds ,
Required: False ,
}
[
number ,
]
,
center:
{
Description: Default center point [longitude, latitude, zoom] for the tile set ,
Required: False ,
}
[
number ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
MosaicsWmtsMosaics_GetCapabilitiesXml (new)
Description :  OGC WMTS endpoint.
Reference :  Link ¶

⚼ Request

GET:  /data/mosaic/{searchId}/WMTSCapabilities.xml
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
searchId:
{
Description: Search Id (pgSTAC Search Hash) ,
Required: True ,
}
string ,
tileMatrixSetId:
{
Description: Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad') ,
Required: False ,
}
string ,
tile_format:
{
Description: Output image type. Default is png. ,
Required: False ,
}
string ,
tile_scale:
{
Description: Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512). ,
Format: int32 ,
Required: False ,
}
integer ,
minzoom:
{
Description: Overwrite default minzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
maxzoom:
{
Description: Overwrite default maxzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
MosaicsInfoSearch_Get (new)
Description :  Get Search query metadata.
Reference :  Link ¶

⚼ Request

GET:  /data/mosaic/{searchId}/info
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
searchId:
{
Description: Search Id (pgSTAC Search Hash) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
search:
{
Description: PgSTAC Search entry. ref: https://github.com/stac-utils/pgstac/blob/3499daa2bfa700ae7bb07503795c169bf2ebafc7/sql/004_search.sql#L907-L915 Details of the saved search query ,
Required: True ,
}
{
hash:
{
Description: Unique hash identifier for the search query ,
Required: True ,
}
string ,
search:
{
Description: Search ,
Required: True ,
}
{
filter-lang:
{
Description: Filter language ,
Required: True ,
}
string ,
filter:
{
Description: Filter ,
Required: True ,
}
{
op:
{
Description: Logical operator ,
Required: True ,
}
string ,
args:
{
Description: Arguments for the logical operator ,
Required: True ,
}
[
string ,
]
,
}
,
sortby:
{
Description: Sort by ,
Required: False ,
}
[
{
field:
{
Description: Field to sort by ,
Required: True ,
}
string ,
direction:
{
Description: Sort direction ,
Required: True ,
}
string ,
}
,
]
,
}
,
_where:
{
Description: SQL WHERE clause representing the search filters ,
Required: True ,
}
string ,
orderby:
{
Description: SQL ORDER BY clause for sorting results ,
Required: True ,
}
string ,
lastused:
{
Description: Timestamp when the search was last accessed ,
Format: date-time ,
Required: True ,
}
string ,
usecount:
{
Description: Number of times the search has been accessed ,
Format: int32 ,
Required: True ,
}
integer ,
metadata:
{
Description: Additional metadata associated with the search ,
Required: True ,
}
{
type:
{
Description: Type of metadata resource ,
Enum:
{
mosaic: Metadata for a mosaic of multiple raster assets ,
search: Metadata for a search query result ,
}
,
Required: False ,
}
enum ,
bounds:
{
Description: Geographic bounding box in [west, south, east, north] format ,
Required: False ,
}
string ,
minzoom:
{
Description: Minimum zoom level supported ,
Format: int32 ,
Required: False ,
}
integer ,
maxzoom:
{
Description: Maximum zoom level supported ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Human-readable name for the resource ,
Required: False ,
}
string ,
assets:
{
Description: List of asset identifiers included in the resource ,
Required: False ,
}
[
string ,
]
,
defaults:
{
Description: Defaults ,
Required: False ,
}
object ,
}
,
}
,
links:
{
Description: Related links for the search query ,
Required: False ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
MosaicsTileJsonOperations_Get (new)
Description :  Return TileJSON document for a searchId.
Reference :  Link ¶

⚼ Request

GET:  /data/mosaic/{searchId}/tilejson.json
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
searchId:
{
Description: Search Id (pgSTAC Search Hash) ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
scan_limit:
{
Description: Return as soon as we scan N items (defaults to 10000 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
items_limit:
{
Description: Return as soon as we have N items per geometry (defaults to 100 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
time_limit:
{
Description: Return after N seconds to avoid long requests (defaults to 5 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
exitwhenfull:
{
Description: Return as soon as the geometry is fully covered (defaults to True in PgSTAC). ,
Required: False ,
}
boolean ,
skipcovered:
{
Description: Skip any items that would show up completely under the previous items (defaults to True in PgSTAC). ,
Required: False ,
}
boolean ,
tileMatrixSetId:
{
Description: Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad'). ,
Required: False ,
}
string ,
tile_format:
{
Description: Default will be automatically defined if the output image needs a mask (png) or not (jpeg). ,
Required: False ,
}
string ,
tile_scale:
{
Description: Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512). ,
Format: int32 ,
Required: False ,
}
integer ,
minzoom:
{
Description: Overwrite default minzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
maxzoom:
{
Description: Overwrite default maxzoom. ,
Format: int32 ,
Required: False ,
}
integer ,
buffer:
{
Description: Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258). ,
Format: double ,
Required: False ,
}
number ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
collection:
{
Description: STAC Collection ID ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method ,
Required: False ,
}
string ,
pixel_selection:
{
Description: Pixel selection method. ,
Required: False ,
}
string ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
tilejson:
{
Description: Tilejson ,
Required: False ,
}
string ,
name:
{
Description: Human-readable name of the tile set ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the tile set ,
Required: False ,
}
string ,
version:
{
Description: Version ,
Required: False ,
}
string ,
attribution:
{
Description: Attribution text for the data sources ,
Required: False ,
}
string ,
template:
{
Description: URL template for feature info queries ,
Required: False ,
}
string ,
legend:
{
Description: URL to legend content for the tile set ,
Required: False ,
}
string ,
scheme:
{
Description: Tile addressing scheme (xyz or tms) ,
Enum:
{
xyz: XYZ tile addressing scheme with origin at top-left ,
tms: TMS tile addressing scheme with origin at bottom-left ,
}
,
Required: False ,
}
enum ,
tiles:
{
Description: Array of tile URL templates ,
Required: True ,
}
[
string ,
]
,
grids:
{
Description: Array of UTFGrid URL templates ,
Required: False ,
}
[
string ,
]
,
data:
{
Description: Array of data file URL templates ,
Required: False ,
}
[
string ,
]
,
minzoom:
{
Description: Minimum zoom level available in the tile set ,
Format: int32 ,
Required: False ,
}
integer ,
maxzoom:
{
Description: Maximum zoom level available in the tile set ,
Format: int32 ,
Required: False ,
}
integer ,
bounds:
{
Description: Bounds ,
Required: False ,
}
[
number ,
]
,
center:
{
Description: Default center point [longitude, latitude, zoom] for the tile set ,
Required: False ,
}
[
number ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
MosaicsTiles_GetZxyScalexFormat (new)
Description :  Create map tile.
Reference :  Link ¶

⚼ Request

GET:  /data/mosaic/{searchId}/tiles/{z}/{x}/{y}@{scale}x.{format}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
searchId:
{
Description: Search Id (pgSTAC Search Hash) ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
scan_limit:
{
Description: Return as soon as we scan N items (defaults to 10000 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
items_limit:
{
Description: Return as soon as we have N items per geometry (defaults to 100 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
time_limit:
{
Description: Return after N seconds to avoid long requests (defaults to 5 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
exitwhenfull:
{
Description: Return as soon as the geometry is fully covered (defaults to True in PgSTAC). ,
Required: False ,
}
boolean ,
skipcovered:
{
Description: Skip any items that would show up completely under the previous items (defaults to True in PgSTAC). ,
Required: False ,
}
boolean ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
z:
{
Description: Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile. ,
Format: float ,
Required: True ,
}
number ,
x:
{
Description: Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix. ,
Format: float ,
Required: True ,
}
number ,
y:
{
Description: Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix. ,
Format: float ,
Required: True ,
}
number ,
tileMatrixSetId:
{
Description: Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad') ,
Required: False ,
}
string ,
scale:
{
Description: Numeric scale factor for the tile. Higher values produce larger tiles (default: "1") ,
Format: float ,
Required: True ,
}
number ,
format:
{
Description: Output format for the tile or image (e.g., png, jpeg, webp) (default: "png"). ,
Required: True ,
}
string ,
buffer:
{
Description: Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258). ,
Required: False ,
}
string ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
collection:
{
Description: STAC Collection ID ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
pixel_selection:
{
Description: Pixel selection method. ,
Required: False ,
}
string ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
MosaicsTileMatrixSets_GetZxyScalexFormat (new)
Description :  Create map tile.
Reference :  Link ¶

⚼ Request

GET:  /data/mosaic/{searchId}/tiles/{tileMatrixSetId}/{z}/{x}/{y}@{scale}x.{format}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
searchId:
{
Description: Search Id (pgSTAC Search Hash) ,
Required: True ,
}
string ,
assets:
{
Description: Asset's names. ,
Required: False ,
}
array ,
expression:
{
Description: Band math expression between assets ,
Required: False ,
}
string ,
assetBidx:
{
Description: Per asset band indexes (coma separated indexes) ,
Required: False ,
}
array ,
asset_as_band:
{
Description: Asset as Band ,
Required: False ,
}
boolean ,
nodata:
{
Description: Overwrite internal Nodata value ,
Format: float ,
Required: False ,
}
number ,
unscale:
{
Description: Apply internal Scale or Offset ,
Required: False ,
}
boolean ,
scan_limit:
{
Description: Return as soon as we scan N items (defaults to 10000 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
items_limit:
{
Description: Return as soon as we have N items per geometry (defaults to 100 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
time_limit:
{
Description: Return after N seconds to avoid long requests (defaults to 5 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
exitwhenfull:
{
Description: Return as soon as the geometry is fully covered (defaults to True in PgSTAC). ,
Required: False ,
}
boolean ,
skipcovered:
{
Description: Skip any items that would show up completely under the previous items (defaults to True in PgSTAC). ,
Required: False ,
}
boolean ,
algorithm:
{
Description: Algorithm name ,
Required: False ,
}
string ,
algorithm_params:
{
Description: Algorithm parameter ,
Required: False ,
}
string ,
tileMatrixSetId:
{
Description: Identifier selecting one of the TileMatrixSetId supported ,
Required: True ,
}
string ,
z:
{
Description: Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile. ,
Format: float ,
Required: True ,
}
number ,
x:
{
Description: Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix. ,
Format: float ,
Required: True ,
}
number ,
y:
{
Description: Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix. ,
Format: float ,
Required: True ,
}
number ,
scale:
{
Description: Numeric scale factor for the tile. Higher values produce larger tiles (default: "1") ,
Format: float ,
Required: True ,
}
number ,
format:
{
Description: Output format for the tile or image (e.g., png, jpeg, webp) (default: "png"). ,
Required: True ,
}
string ,
buffer:
{
Description: Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258). ,
Required: False ,
}
string ,
color_formula:
{
Description: rio-color formula (info: https://github.com/mapbox/rio-color) ,
Required: False ,
}
string ,
collection:
{
Description: STAC Collection ID ,
Required: False ,
}
string ,
resampling:
{
Description: Resampling method. ,
Required: False ,
}
string ,
pixel_selection:
{
Description: Pixel selection method. ,
Required: False ,
}
string ,
rescale:
{
Description: comma (',') delimited Min,Max range. Can set multiple time for multiple bands. ,
Required: False ,
}
array ,
colormap_name:
{
Description: Colormap name ,
Required: False ,
}
string ,
colormap:
{
Description: JSON encoded custom Colormap ,
Required: False ,
}
string ,
return_mask:
{
Description: Add mask to the output data. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
MosaicsAssetsForTileMatrixSets_GetZxyAssets (new)
Description :  Return a list of assets which overlap a given tile
Reference :  Link ¶

⚼ Request

GET:  /data/mosaic/{searchId}/tiles/{tileMatrixSetId}/{z}/{x}/{y}/assets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
searchId:
{
Description: Search Id (pgSTAC Search Hash) ,
Required: True ,
}
string ,
scan_limit:
{
Description: Return as soon as we scan N items (defaults to 10000 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
items_limit:
{
Description: Return as soon as we have N items per geometry (defaults to 100 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
time_limit:
{
Description: Return after N seconds to avoid long requests (defaults to 5 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
exitwhenfull:
{
Description: Return as soon as the geometry is fully covered (defaults to True in PgSTAC). ,
Required: False ,
}
boolean ,
skipcovered:
{
Description: Skip any items that would show up completely under the previous items (defaults to True in PgSTAC). ,
Required: False ,
}
boolean ,
tileMatrixSetId:
{
Description: Identifier selecting one of the TileMatrixSetId supported ,
Required: True ,
}
string ,
z:
{
Description: Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile. ,
Format: float ,
Required: True ,
}
number ,
x:
{
Description: Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix. ,
Format: float ,
Required: True ,
}
number ,
y:
{
Description: Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix. ,
Format: float ,
Required: True ,
}
number ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
MosaicsAssetsForTiles_GetZxyAssets (new)
Description :  Return a list of assets which overlap a given tile
Reference :  Link ¶

⚼ Request

GET:  /data/mosaic/{searchId}/tiles/{z}/{x}/{y}/assets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
searchId:
{
Description: Search Id (pgSTAC Search Hash) ,
Required: True ,
}
string ,
scan_limit:
{
Description: Return as soon as we scan N items (defaults to 10000 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
items_limit:
{
Description: Return as soon as we have N items per geometry (defaults to 100 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
time_limit:
{
Description: Return after N seconds to avoid long requests (defaults to 5 in PgSTAC). ,
Format: int32 ,
Required: False ,
}
integer ,
exitwhenfull:
{
Description: Return as soon as the geometry is fully covered (defaults to True in PgSTAC). ,
Required: False ,
}
boolean ,
skipcovered:
{
Description: Skip any items that would show up completely under the previous items (defaults to True in PgSTAC). ,
Required: False ,
}
boolean ,
z:
{
Description: Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile. ,
Format: float ,
Required: True ,
}
number ,
x:
{
Description: Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix. ,
Format: float ,
Required: True ,
}
number ,
y:
{
Description: Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix. ,
Format: float ,
Required: True ,
}
number ,
tileMatrixSetId:
{
Description: Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad') ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
MosaicsRegisterSearch_Register (new)
Description :  Register a Search query
Reference :  Link ¶

⚼ Request

POST:  /data/mosaic/register
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
collections:
{
Description: List of STAC collection IDs to include in the mosaic ,
Required: False ,
}
[
string ,
]
,
ids:
{
Description: List of specific STAC item IDs to include in the mosaic ,
Required: False ,
}
[
string ,
]
,
bbox:
{
Description: Geographic bounding box to filter items [west, south, east, north] ,
Format: double ,
Required: False ,
}
number ,
intersects:
{
Description: GeoJSON geometry to spatially filter items by intersection ,
Required: False ,
}
string ,
query:
{
Description: Query ,
Required: False ,
}
object ,
filter:
{
Description: Filter ,
Required: False ,
}
{
op:
{
Description: Logical operator ,
Required: True ,
}
string ,
args:
{
Description: Arguments for the logical operator ,
Required: True ,
}
[
string ,
]
,
}
,
datetime:
{
Description: Temporal filter in RFC 3339 format or interval ,
Required: False ,
}
string ,
sortby:
{
Description: Criteria for ordering items in the mosaic ,
Required: False ,
}
[
{
field:
{
Description: The field name to sort by. ,
Required: True ,
}
string ,
direction:
{
Description: The sort direction (ascending or descending). ,
Enum:
{
asc: Sort results in ascending order. ,
desc: Sort results in descending order. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
filter-lang:
{
Description: Query language format used in the filter parameter ,
Enum:
{
cql-json: Common Query Language in JSON format. ,
cql2-json: Common Query Language 2 in JSON format ,
cql2-text: Common Query Language 2 in text format. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: Additional metadata to associate with the mosaic ,
Required: False ,
}
{
type:
{
Description: Type of metadata resource ,
Enum:
{
mosaic: Metadata for a mosaic of multiple raster assets ,
search: Metadata for a search query result ,
}
,
Required: False ,
}
enum ,
bounds:
{
Description: Geographic bounding box in [west, south, east, north] format ,
Required: False ,
}
string ,
minzoom:
{
Description: Minimum zoom level supported ,
Format: int32 ,
Required: False ,
}
integer ,
maxzoom:
{
Description: Maximum zoom level supported ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Human-readable name for the resource ,
Required: False ,
}
string ,
assets:
{
Description: List of asset identifiers included in the resource ,
Required: False ,
}
[
string ,
]
,
defaults:
{
Description: Defaults ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
searchId:
{
Description: Unique identifier for the registered search ,
Required: True ,
}
string ,
links:
{
Description: Related links for the registered mosaic ,
Required: False ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TileMatrixList_Get (new)
Description :  Return Matrix List
Reference :  Link ¶

⚼ Request

GET:  /data/tile-matrix-sets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TileMatrixDefinitions_Get (new)
Description :  Return Matrix Definition
Reference :  Link ¶

⚼ Request

GET:  /data/tile-matrix-sets/{tileMatrixSetId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
tileMatrixSetId:
{
Description: Identifier selecting one of the TileMatrixSetId supported ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
title:
{
Description: Human-readable title of the tile matrix set ,
Required: False ,
}
string ,
description:
{
Description: Brief narrative description of this tile matrix set, normally available for display to a human ,
Required: False ,
}
string ,
keywords:
{
Description: Unordered list of one or more commonly used or formalized word(s) or phrase(s) used to describe this tile matrix set ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the tile matrix set ,
Required: False ,
}
string ,
uri:
{
Description: URI reference to the official definition ,
Required: False ,
}
string ,
orderedAxes:
{
Description: Names of the coordinate axes in order ,
Required: False ,
}
[
string ,
]
,
crs:
{
Description: Coordinate reference system identifier ,
Required: True ,
}
string ,
wellKnownScaleSet:
{
Description: URL reference to a standardized scale set ,
Format: uri ,
Required: False ,
}
string ,
boundingBox:
{
Description: Geographic extent of the tile matrix set ,
Required: False ,
}
{
lowerLeft:
{
Description: Lower-left corner coordinates [x, y] of bounding box ,
Required: True ,
}
[
string ,
]
,
upperRight:
{
Description: Upper-right corner coordinates [x, y] of bounding box ,
Required: True ,
}
[
string ,
]
,
crs:
{
Description: Coordinate reference system identifier (e.g., 'http://www.opengis.net/def/crs/EPSG/0/3857') ,
Required: False ,
}
string ,
orderedAxes:
{
Description: Explicit axis order for the CRS coordinates (e.g., ['x', 'y']) ,
Required: False ,
}
[
string ,
]
,
}
,
tileMatrices:
{
Description: Array of tile matrices at different zoom levels ,
Required: True ,
}
[
{
title:
{
Description: Human-readable title of the tile matrix level ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of this tile matrix level ,
Required: False ,
}
string ,
keywords:
{
Description: Unordered list of one or more commonly used or formalized word(s) or phrase(s) used to describe this dataset ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for this tile matrix level, often the zoom level ,
Required: True ,
}
string ,
scaleDenominator:
{
Description: Scale denominator representing the scale of this tile matrix level ,
Format: float ,
Required: True ,
}
number ,
cellSize:
{
Description: Size of a pixel in map units at this tile matrix level ,
Format: float ,
Required: True ,
}
number ,
cornerOfOrigin:
{
Description: The corner of the tile matrix (_topLeft_ or _bottomLeft_) used as the origin for numbering tile rows and columns. This corner is also a corner of the (0, 0) tile. ,
Enum:
{
topLeft: Origin at the top-left corner (Y increases downward) ,
bottomLeft: Origin at the bottom-left corner (Y increases upward) ,
}
,
Required: False ,
}
enum ,
pointOfOrigin:
{
Description: Precise position in CRS coordinates of the corner of origin (e.g. the top-left corner) for this tile matrix. This position is also a corner of the (0, 0) tile. In previous version, this was 'topLeftCorner' and 'cornerOfOrigin' did not exist. ,
Required: True ,
}
[
number ,
]
,
tileWidth:
{
Description: Pixel width of each tile at this level ,
Format: int32 ,
Required: True ,
}
integer ,
tileHeight:
{
Description: Pixel height of each tile at this level ,
Format: int32 ,
Required: True ,
}
integer ,
matrixWidth:
{
Description: Number of tiles horizontally at this matrix level ,
Format: int32 ,
Required: True ,
}
integer ,
matrixHeight:
{
Description: Number of tiles vertically at this matrix level ,
Format: int32 ,
Required: True ,
}
integer ,
variableMatrixWidths:
{
Description: Describes the rows that has variable matrix width ref: https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/variableMatrixWidth.json ,
Required: False ,
}
[
{
coalesce:
{
Description: Number of tiles in width that coalesce in a single tile for these rows ,
Format: int32 ,
Required: True ,
}
integer ,
minTileRow:
{
Description: First tile row where the coalescence factor applies for this tilematrix ,
Format: int32 ,
Required: True ,
}
integer ,
maxTileRow:
{
Description: Last tile row where the coalescence factor applies for this tilematrix ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GeoCatalogAuthConfigOperations_Get (new)
Description :  Get the app id and tenant id information to make a MSAL request for this GeoCatalog instance.
Reference :  Link ¶

⚼ Request

GET:  /geocatalog/auth
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
authn_app_id:
{
Description: Application ID for authentication. ,
Required: True ,
}
string ,
tenant_id:
{
Description: Azure Active Directory tenant ID. ,
Required: True ,
}
string ,
instance:
{
Description: Azure AD instance URL. ,
Format: uri ,
Required: True ,
}
string ,
redirect_uri:
{
Description: Redirect URI after authentication. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GeoCatalogAzmapsClient_GetId (new)
Description :  Fetch the client id for the Azure Maps API service based on the current on the current identity. This client id is used for the Explorer to authenticate with the Azure Maps API service.
Reference :  Link ¶

⚼ Request

GET:  /geocatalog/map/id
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
client_id:
{
Description: The client ID for Azure Maps authentication. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GeoCatalogAzmapsToken_Get (new)
Description :  Fetch a token for the Azure Maps API service based on the current service identity. This token is used for the Explorer to authenticate with the Azure Maps API service.
Reference :  Link ¶

⚼ Request

GET:  /geocatalog/map/token
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
token:
{
Description: The authentication token for Azure Maps. ,
Required: True ,
}
string ,
expires_on:
{
Description: Expiration timestamp of the token in Unix time. ,
Format: int32 ,
Required: True ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Ingestions_ListAll (new)
Description :  Get ingestions of a catalog
Reference :  Link ¶

⚼ Request

GET:  /inma/collections/{collectionId}/ingestions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to return ,
Format: int64 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of items to skip ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Ingestion Definitions ,
Required: True ,
}
[
{
importType:
{
Description: Ingestion type ,
Enum:
{
StaticCatalog: Static STAC Catalog ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Ingestion name ,
Required: False ,
}
string ,
sourceCatalogUrl:
{
Description: Source catalog URL. *Required for StaticCatalog ingestion type ,
Format: uri ,
Required: False ,
}
string ,
skipExistingItems:
{
Description: Skip processing existing items in the catalog ,
Required: False ,
}
boolean ,
keepOriginalAssets:
{
Description: Keep original source assets ,
Required: False ,
}
boolean ,
id:
{
Description: Ingestion id ,
Format: uuid ,
Required: True ,
}
string ,
creationTime:
{
Description: Ingestion creation time ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Ingestion status ,
Enum:
{
Ready: Ingestion accepted and ready to be run ,
Deleting: Ingestion is being deleting in the background ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: Next page ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Ingestions_Create (new)
Description :  Create a new ingestion
Reference :  Link ¶

⚼ Request

POST:  /inma/collections/{collectionId}/ingestions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
definition:
{
Description: Definition of the ingestion ,
Required: True ,
}
{
importType:
{
Description: Ingestion type ,
Enum:
{
StaticCatalog: Static STAC Catalog ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Ingestion name ,
Required: False ,
}
string ,
sourceCatalogUrl:
{
Description: Source catalog URL. *Required for StaticCatalog ingestion type ,
Format: uri ,
Required: False ,
}
string ,
skipExistingItems:
{
Description: Skip processing existing items in the catalog ,
Required: False ,
}
boolean ,
keepOriginalAssets:
{
Description: Keep original source assets ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: Url of the created ingestion ,
}
string ,
}
,
$schema:
{
Description: Spatio geo-catalog ingestion definition ,
}
{
importType:
{
Description: Ingestion type ,
Enum:
{
StaticCatalog: Static STAC Catalog ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Ingestion name ,
Required: False ,
}
string ,
sourceCatalogUrl:
{
Description: Source catalog URL. *Required for StaticCatalog ingestion type ,
Format: uri ,
Required: False ,
}
string ,
skipExistingItems:
{
Description: Skip processing existing items in the catalog ,
Required: False ,
}
boolean ,
keepOriginalAssets:
{
Description: Keep original source assets ,
Required: False ,
}
boolean ,
id:
{
Description: Ingestion id ,
Format: uuid ,
Required: True ,
}
string ,
creationTime:
{
Description: Ingestion creation time ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Ingestion status ,
Enum:
{
Ready: Ingestion accepted and ready to be run ,
Deleting: Ingestion is being deleting in the background ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Ingestions_Get (new)
Description :  Get the definition of an ingestion
Reference :  Link ¶

⚼ Request

GET:  /inma/collections/{collectionId}/ingestions/{ingestionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
ingestionId:
{
Description: Ingestion id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
importType:
{
Description: Ingestion type ,
Enum:
{
StaticCatalog: Static STAC Catalog ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Ingestion name ,
Required: False ,
}
string ,
sourceCatalogUrl:
{
Description: Source catalog URL. *Required for StaticCatalog ingestion type ,
Format: uri ,
Required: False ,
}
string ,
skipExistingItems:
{
Description: Skip processing existing items in the catalog ,
Required: False ,
}
boolean ,
keepOriginalAssets:
{
Description: Keep original source assets ,
Required: False ,
}
boolean ,
id:
{
Description: Ingestion id ,
Format: uuid ,
Required: True ,
}
string ,
creationTime:
{
Description: Ingestion creation time ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Ingestion status ,
Enum:
{
Ready: Ingestion accepted and ready to be run ,
Deleting: Ingestion is being deleting in the background ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Ingestions_Update (new)
Description :  Update an existing ingestion
Reference :  Link ¶

⚼ Request

PATCH:  /inma/collections/{collectionId}/ingestions/{ingestionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
ingestionId:
{
Description: Ingestion id ,
Required: True ,
}
string ,
definition:
{
Description: Ingestion properties to update ,
Required: True ,
}
{
displayName:
{
Description: Ingestion name ,
Required: False ,
}
string ,
sourceCatalogUrl:
{
Description: Source catalog URL ,
Format: uri ,
Required: False ,
}
string ,
skipExistingItems:
{
Description: Skip processing existing items in the catalog ,
Required: False ,
}
boolean ,
keepOriginalAssets:
{
Description: Keep original source assets ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
importType:
{
Description: Ingestion type ,
Enum:
{
StaticCatalog: Static STAC Catalog ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Ingestion name ,
Required: False ,
}
string ,
sourceCatalogUrl:
{
Description: Source catalog URL. *Required for StaticCatalog ingestion type ,
Format: uri ,
Required: False ,
}
string ,
skipExistingItems:
{
Description: Skip processing existing items in the catalog ,
Required: False ,
}
boolean ,
keepOriginalAssets:
{
Description: Keep original source assets ,
Required: False ,
}
boolean ,
id:
{
Description: Ingestion id ,
Format: uuid ,
Required: True ,
}
string ,
creationTime:
{
Description: Ingestion creation time ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Ingestion status ,
Enum:
{
Ready: Ingestion accepted and ready to be run ,
Deleting: Ingestion is being deleting in the background ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Ingestions_Delete (new)
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.
Reference :  Link ¶

⚼ Request

DELETE:  /inma/collections/{collectionId}/ingestions/{ingestionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
ingestionId:
{
Description: Ingestion id ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: Url used to monitor the background operation ,
}
string ,
operation-location:
{
Description: Url used to monitor the background operation ,
}
string ,
}
,
$schema:
{
Description: Spatio geo-catalog operation ,
}
{
id:
{
Description: Operation id ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Operation status ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Operation type ,
Required: True ,
}
string ,
creationTime:
{
Description: The UTC time at which the operation was created ,
Format: date-time ,
Required: True ,
}
string ,
collectionId:
{
Description: Collection ID ,
Required: False ,
}
string ,
statusHistory:
{
Description: The history of the operation status in time ,
Required: True ,
}
[
{
timestamp:
{
Description: The UTC time at which the status was set ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
errorCode:
{
Description: If the status is failed, the error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: If the status is failed, the error message ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The UTC time at which the operation was started ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The UTC time at which the operation finished its execution ,
Format: date-time ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information elements about the particular operation type ,
Required: False ,
}
object ,
error:
{
Description: Error information ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IngestionRuns_ListAll (new)
Description :  Get the runs of an ingestion
Reference :  Link ¶

⚼ Request

GET:  /inma/collections/{collectionId}/ingestions/{ingestionId}/runs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
ingestionId:
{
Description: Ingestion id ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to return ,
Format: int64 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of items to skip ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Ingestion Runs ,
Required: True ,
}
[
{
id:
{
Description: Run id ,
Format: uuid ,
Required: True ,
}
string ,
parentRunId:
{
Description: Run id which this run is associated to becase has been retried or rerun ,
Format: uuid ,
Required: False ,
}
string ,
operation:
{
Description: Operation ,
Required: True ,
}
{
id:
{
Description: Operation id ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Operation status ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: The UTC time at which the operation was created ,
Format: date-time ,
Required: True ,
}
string ,
statusHistory:
{
Description: The history of the operation status in time ,
Required: True ,
}
[
{
timestamp:
{
Description: The UTC time at which the status was set ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
errorCode:
{
Description: If the status is failed, the error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: If the status is failed, the error message ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The UTC time at which the operation was started ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The UTC time at which the operation finished its execution ,
Format: date-time ,
Required: False ,
}
string ,
totalItems:
{
Description: The number of total items to be processed ,
Format: int32 ,
Required: True ,
}
integer ,
totalPendingItems:
{
Description: The number of items pending to be processed ,
Format: int32 ,
Required: True ,
}
integer ,
totalSuccessfulItems:
{
Description: The number of items successfully processed ,
Format: int32 ,
Required: True ,
}
integer ,
totalFailedItems:
{
Description: The number of items that have failed to be processed ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
creationTime:
{
Description: Creation time ,
Format: date-time ,
Required: True ,
}
string ,
sourceCatalogUrl:
{
Description: URL of the source catalog ,
Format: uri ,
Required: False ,
}
string ,
skipExistingItems:
{
Description: Skip any item that already exist in the GeoCatalog ,
Required: False ,
}
boolean ,
keepOriginalAssets:
{
Description: Keep original source assets ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: Next page ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IngestionRuns_Create (new)
Description :  Create a new run of an ingestion
Reference :  Link ¶

⚼ Request

POST:  /inma/collections/{collectionId}/ingestions/{ingestionId}/runs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
ingestionId:
{
Description: Ingestion id ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: Url of the created ingestion run ,
}
string ,
}
,
$schema:
{
Description: Spatio geo-catalog ingestion run ,
}
{
id:
{
Description: Run id ,
Format: uuid ,
Required: True ,
}
string ,
parentRunId:
{
Description: Run id which this run is associated to becase has been retried or rerun ,
Format: uuid ,
Required: False ,
}
string ,
operation:
{
Description: Operation ,
Required: True ,
}
{
id:
{
Description: Operation id ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Operation status ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: The UTC time at which the operation was created ,
Format: date-time ,
Required: True ,
}
string ,
statusHistory:
{
Description: The history of the operation status in time ,
Required: True ,
}
[
{
timestamp:
{
Description: The UTC time at which the status was set ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
errorCode:
{
Description: If the status is failed, the error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: If the status is failed, the error message ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The UTC time at which the operation was started ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The UTC time at which the operation finished its execution ,
Format: date-time ,
Required: False ,
}
string ,
totalItems:
{
Description: The number of total items to be processed ,
Format: int32 ,
Required: True ,
}
integer ,
totalPendingItems:
{
Description: The number of items pending to be processed ,
Format: int32 ,
Required: True ,
}
integer ,
totalSuccessfulItems:
{
Description: The number of items successfully processed ,
Format: int32 ,
Required: True ,
}
integer ,
totalFailedItems:
{
Description: The number of items that have failed to be processed ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
creationTime:
{
Description: Creation time ,
Format: date-time ,
Required: True ,
}
string ,
sourceCatalogUrl:
{
Description: URL of the source catalog ,
Format: uri ,
Required: False ,
}
string ,
skipExistingItems:
{
Description: Skip any item that already exist in the GeoCatalog ,
Required: False ,
}
boolean ,
keepOriginalAssets:
{
Description: Keep original source assets ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IngestionRuns_Get (new)
Description :  Get a run of an ingestion
Reference :  Link ¶

⚼ Request

GET:  /inma/collections/{collectionId}/ingestions/{ingestionId}/runs/{runId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
ingestionId:
{
Description: Ingestion id ,
Required: True ,
}
string ,
runId:
{
Description: Run id ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Run id ,
Format: uuid ,
Required: True ,
}
string ,
parentRunId:
{
Description: Run id which this run is associated to becase has been retried or rerun ,
Format: uuid ,
Required: False ,
}
string ,
operation:
{
Description: Operation ,
Required: True ,
}
{
id:
{
Description: Operation id ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Operation status ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: The UTC time at which the operation was created ,
Format: date-time ,
Required: True ,
}
string ,
statusHistory:
{
Description: The history of the operation status in time ,
Required: True ,
}
[
{
timestamp:
{
Description: The UTC time at which the status was set ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
errorCode:
{
Description: If the status is failed, the error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: If the status is failed, the error message ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The UTC time at which the operation was started ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The UTC time at which the operation finished its execution ,
Format: date-time ,
Required: False ,
}
string ,
totalItems:
{
Description: The number of total items to be processed ,
Format: int32 ,
Required: True ,
}
integer ,
totalPendingItems:
{
Description: The number of items pending to be processed ,
Format: int32 ,
Required: True ,
}
integer ,
totalSuccessfulItems:
{
Description: The number of items successfully processed ,
Format: int32 ,
Required: True ,
}
integer ,
totalFailedItems:
{
Description: The number of items that have failed to be processed ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
creationTime:
{
Description: Creation time ,
Format: date-time ,
Required: True ,
}
string ,
sourceCatalogUrl:
{
Description: URL of the source catalog ,
Format: uri ,
Required: False ,
}
string ,
skipExistingItems:
{
Description: Skip any item that already exist in the GeoCatalog ,
Required: False ,
}
boolean ,
keepOriginalAssets:
{
Description: Keep original source assets ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IngestionSources_ListAll (new)
Description :  Get ingestion sources in a geo-catalog
Reference :  Link ¶

⚼ Request

GET:  /inma/ingestion-sources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to return ,
Format: int64 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of items to skip ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Ingestion sources ,
Required: True ,
}
[
{
id:
{
Description: Ingestion source id ,
Format: uuid ,
Required: True ,
}
string ,
kind:
{
Description: Ingestion source type ,
Enum:
{
SasToken: Azure Blob Storage SAS token ,
BlobManagedIdentity: Azure Blob Managed Identity ,
}
,
Required: True ,
}
enum ,
created:
{
Description: Created time in UTC format ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: Next page ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IngestionSources_Create (new)
Description :  Create a new ingestion source in a geo-catalog
Reference :  Link ¶

⚼ Request

POST:  /inma/ingestion-sources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
ingestionSource:
{
Description: Definition of the ingestion source ,
Required: True ,
}
{
id:
{
Description: Ingestion source id ,
Format: uuid ,
Required: True ,
}
string ,
kind:
{
Description: Discriminator for the ingestion source ,
Enum:
{
SasToken: Azure Blob Storage SAS token ,
BlobManagedIdentity: Azure Blob Managed Identity ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: Url of the created ingestion source ,
}
string ,
}
,
$schema:
{
Description: Ingestion Source ,
}
{
id:
{
Description: Ingestion source id ,
Format: uuid ,
Required: True ,
}
string ,
created:
{
Description: Created time in UTC format ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: Discriminator for the ingestion source ,
Enum:
{
SasToken: Azure Blob Storage SAS token ,
BlobManagedIdentity: Azure Blob Managed Identity ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IngestionSources_Get (new)
Description :  Get an ingestion source in a geo-catalog
Reference :  Link ¶

⚼ Request

GET:  /inma/ingestion-sources/{id}
{
id:
{
Description: Ingestion source id ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Ingestion source id ,
Format: uuid ,
Required: True ,
}
string ,
created:
{
Description: Created time in UTC format ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: Discriminator for the ingestion source ,
Enum:
{
SasToken: Azure Blob Storage SAS token ,
BlobManagedIdentity: Azure Blob Managed Identity ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IngestionSources_CreateOrReplace (new)
Description :  Update an existing ingestion source in a geo-catalog
Reference :  Link ¶

⚼ Request

PUT:  /inma/ingestion-sources/{id}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
Description: Ingestion source id ,
Required: True ,
}
string ,
ingestionSource:
{
Description: Definition of the ingestion source ,
Required: True ,
}
{
id:
{
Description: Ingestion source id ,
Format: uuid ,
Required: True ,
}
string ,
kind:
{
Description: Discriminator for the ingestion source ,
Enum:
{
SasToken: Azure Blob Storage SAS token ,
BlobManagedIdentity: Azure Blob Managed Identity ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
$headers:
{
location:
{
Description: Url of the created ingestion source ,
}
string ,
}
,
$schema:
{
Description: Ingestion Source ,
}
{
id:
{
Description: Ingestion source id ,
Format: uuid ,
Required: True ,
}
string ,
created:
{
Description: Created time in UTC format ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: Discriminator for the ingestion source ,
Enum:
{
SasToken: Azure Blob Storage SAS token ,
BlobManagedIdentity: Azure Blob Managed Identity ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: Url of the created ingestion source ,
}
string ,
}
,
$schema:
{
Description: Ingestion Source ,
}
{
id:
{
Description: Ingestion source id ,
Format: uuid ,
Required: True ,
}
string ,
created:
{
Description: Created time in UTC format ,
Format: date-time ,
Required: True ,
}
string ,
kind:
{
Description: Discriminator for the ingestion source ,
Enum:
{
SasToken: Azure Blob Storage SAS token ,
BlobManagedIdentity: Azure Blob Managed Identity ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IngestionSources_Delete (new)
Description :  Delete an ingestion source from a geo-catalog
Reference :  Link ¶

⚼ Request

DELETE:  /inma/ingestion-sources/{id}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
Description: Ingestion source id ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IngestionSources_ListManagedIdentities (new)
Description :  Get all managed identities with access to storage accounts configured for a geo-catalog
Reference :  Link ¶

⚼ Request

GET:  /inma/ingestion-sources/managed-identities
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Managed Identities ,
Required: True ,
}
[
{
objectId:
{
Description: Object id of the managed identity ,
Format: uuid ,
Required: True ,
}
string ,
resourceId:
{
Description: ARM path or resource id of the managed identity ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: Next page ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IngestionOperations_ListAll (new)
Description :  Get operations of a geo-catalog collection
Reference :  Link ¶

⚼ Request

GET:  /inma/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to return ,
Format: int64 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of items to skip ,
Format: int64 ,
Required: False ,
}
integer ,
collectionId:
{
Description: Operation id used to filter the results ,
Required: False ,
}
string ,
status:
{
Description: Operation status used to filter the results ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Operations ,
Required: True ,
}
[
{
id:
{
Description: Operation id ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Operation status ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Operation type ,
Required: True ,
}
string ,
creationTime:
{
Description: The UTC time at which the operation was created ,
Format: date-time ,
Required: True ,
}
string ,
collectionId:
{
Description: Collection ID ,
Required: False ,
}
string ,
statusHistory:
{
Description: The history of the operation status in time ,
Required: True ,
}
[
{
timestamp:
{
Description: The UTC time at which the status was set ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
errorCode:
{
Description: If the status is failed, the error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: If the status is failed, the error message ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The UTC time at which the operation was started ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The UTC time at which the operation finished its execution ,
Format: date-time ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information elements about the particular operation type ,
Required: False ,
}
object ,
error:
{
Description: Error information ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Next page ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IngestionOperations_DeleteAll (new)
Description :  Cancel all running operations of a geo-catalog collection
Reference :  Link ¶

⚼ Request

DELETE:  /inma/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IngestionOperations_Get (new)
Description :  Get an operation of a geo-catalog collection
Reference :  Link ¶

⚼ Request

GET:  /inma/operations/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation id ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Operation id ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Operation status ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Operation type ,
Required: True ,
}
string ,
creationTime:
{
Description: The UTC time at which the operation was created ,
Format: date-time ,
Required: True ,
}
string ,
collectionId:
{
Description: Collection ID ,
Required: False ,
}
string ,
statusHistory:
{
Description: The history of the operation status in time ,
Required: True ,
}
[
{
timestamp:
{
Description: The UTC time at which the status was set ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
errorCode:
{
Description: If the status is failed, the error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: If the status is failed, the error message ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The UTC time at which the operation was started ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The UTC time at which the operation finished its execution ,
Format: date-time ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information elements about the particular operation type ,
Required: False ,
}
object ,
error:
{
Description: Error information ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IngestionOperations_Delete (new)
Description :  Cancel a running operation of a geo-catalog collection
Reference :  Link ¶

⚼ Request

DELETE:  /inma/operations/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation id ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Sas_GetSign (new)
Description :  Signs a HREF (a link URL) by appending a [SAS Token](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview#how-a-shared-access-signature-works). If the HREF is not a Azure Blob Storage HREF, then pass back the HREF unsigned.
Reference :  Link ¶

⚼ Request

GET:  /sas/sign
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
href:
{
Description: HREF (URL) to sign ,
Required: True ,
}
string ,
duration:
{
Description: The duration, in minutes, that the SAS token will be valid. Only valid for approved users. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
msft:expiry:
{
Description: The expiry date of the signed link. This indicates when the link will no longer be valid. ,
Format: date-time ,
Required: False ,
}
string ,
href:
{
Description: The URL of the unsigned link. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Sas_GetToken (new)
Description :  Generate a [SAS Token](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview#how-a-shared-access-signature-works) for the given storage account and container. The storage account and container must be associated with a Planetary Computer dataset indexed by the STAC API.
Reference :  Link ¶

⚼ Request

GET:  /sas/token/{collectionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: The name of the Collection that the SAS token will be issued for. ,
Required: True ,
}
string ,
duration:
{
Description: The duration, in minutes, that the SAS token will be valid. Only valid for approved users. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
msft:expiry:
{
Description: The expiration date and time of the SAS token in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
token:
{
Description: The SAS token string used for authentication. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Sas_RevokeToken (new)
Description :  Revoke a [SAS Token](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview#how-a-shared-access-signature-works) for managed storage account of this GeoCatalog.
Reference :  Link ¶

⚼ Request

POST:  /sas/token/revoke
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
duration:
{
Description: The duration, in minutes, that the SAS token will be valid. Only valid for approved users. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacLandingPages_Get (new)
Description :  Endpoint.
Reference :  Link ¶

⚼ Request

GET:  /stac
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the STAC catalog. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the STAC catalog. ,
Required: True ,
}
string ,
title:
{
Description: Human-readable title for the STAC catalog. ,
Required: False ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
conformsTo:
{
Description: List of OGC API conformance classes implemented by this API. ,
Required: True ,
}
[
string ,
]
,
links:
{
Description: Links to related resources and endpoints. ,
Required: True ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
type:
{
Description: Type ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionOperations_GetAll (new)
Description :  Endpoint.
Reference :  Link ¶

⚼ Request

GET:  /stac/collections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
sign:
{
Description: Whether to sign asset URLs in the response. ,
Required: False ,
}
string ,
duration:
{
Description: URL signature duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
links:
{
Description: Links to related resources and endpoints. ,
Required: True ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
collections:
{
Description: Array of STAC collections available in the catalog. ,
Required: True ,
}
[
{
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the collection. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the collection. ,
Required: True ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
links:
{
Description: Links to related resources and endpoints. ,
Required: True ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
title:
{
Description: Human-readable title for the collection. ,
Required: False ,
}
string ,
type:
{
Description: Type ,
Required: False ,
}
string ,
assets:
{
Description: Assets ,
Required: False ,
}
object ,
license:
{
Description: License identifier for the collection data. ,
Required: True ,
}
string ,
extent:
{
Description: Spatial and temporal extent of the collection. ,
Required: True ,
}
{
spatial:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#spatial-extent-object Spatial extent defined by bounding boxes. ,
Required: True ,
}
{
bbox:
{
Description: Array of bounding boxes defining the spatial extent, in format [[west, south, east, north]]. ,
Required: False ,
}
[
number ,
]
,
}
,
temporal:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#temporal-extent-object Temporal extent defined by time intervals. ,
Required: True ,
}
{
interval:
{
Description: Array of time intervals in format [[start_datetime, end_datetime]]. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
keywords:
{
Description: Keywords describing the collection. ,
Required: False ,
}
[
string ,
]
,
providers:
{
Description: Organizations or individuals who provide the collection data. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provider organization or individual. ,
Required: True ,
}
string ,
description:
{
Description: Description of the provider. ,
Required: False ,
}
string ,
roles:
{
Description: Roles played by the provider (e.g., producer, processor, host). ,
Required: False ,
}
[
string ,
]
,
url:
{
Description: URL to the provider's website. ,
Required: False ,
}
string ,
}
,
]
,
summaries:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#summaries Summaries ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionOperations_Create (new)
Description :  Create a new collection in the GeoCatalog instance
Reference :  Link ¶

⚼ Request

POST:  /stac/collections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request collection body ,
Required: True ,
}
{
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the collection. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the collection. ,
Required: True ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
links:
{
Description: Links to related resources and endpoints. ,
Required: True ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
title:
{
Description: Human-readable title for the collection. ,
Required: False ,
}
string ,
type:
{
Description: Type ,
Required: False ,
}
string ,
assets:
{
Description: Assets ,
Required: False ,
}
object ,
license:
{
Description: License identifier for the collection data. ,
Required: True ,
}
string ,
extent:
{
Description: Spatial and temporal extent of the collection. ,
Required: True ,
}
{
spatial:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#spatial-extent-object Spatial extent defined by bounding boxes. ,
Required: True ,
}
{
bbox:
{
Description: Array of bounding boxes defining the spatial extent, in format [[west, south, east, north]]. ,
Required: False ,
}
[
number ,
]
,
}
,
temporal:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#temporal-extent-object Temporal extent defined by time intervals. ,
Required: True ,
}
{
interval:
{
Description: Array of time intervals in format [[start_datetime, end_datetime]]. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
keywords:
{
Description: Keywords describing the collection. ,
Required: False ,
}
[
string ,
]
,
providers:
{
Description: Organizations or individuals who provide the collection data. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provider organization or individual. ,
Required: True ,
}
string ,
description:
{
Description: Description of the provider. ,
Required: False ,
}
string ,
roles:
{
Description: Roles played by the provider (e.g., producer, processor, host). ,
Required: False ,
}
[
string ,
]
,
url:
{
Description: URL to the provider's website. ,
Required: False ,
}
string ,
}
,
]
,
summaries:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#summaries Summaries ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: Url used to monitor the background operation ,
}
string ,
operation-location:
{
Description: Url used to monitor the background operation ,
}
string ,
}
,
$schema:
{
Description: Spatio geo-catalog operation ,
}
{
id:
{
Description: Operation id ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Operation status ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Operation type ,
Required: True ,
}
string ,
creationTime:
{
Description: The UTC time at which the operation was created ,
Format: date-time ,
Required: True ,
}
string ,
collectionId:
{
Description: Collection ID ,
Required: False ,
}
string ,
statusHistory:
{
Description: The history of the operation status in time ,
Required: True ,
}
[
{
timestamp:
{
Description: The UTC time at which the status was set ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
errorCode:
{
Description: If the status is failed, the error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: If the status is failed, the error message ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The UTC time at which the operation was started ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The UTC time at which the operation finished its execution ,
Format: date-time ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information elements about the particular operation type ,
Required: False ,
}
object ,
error:
{
Description: Error information ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionOperations_Get (new)
Description :  Get a collection in the GeoCatalog instance
Reference :  Link ¶

⚼ Request

GET:  /stac/collections/{collectionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the collection. ,
Required: True ,
}
string ,
sign:
{
Description: Whether to sign asset URLs in the response. ,
Required: False ,
}
string ,
duration:
{
Description: URL signature duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the collection. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the collection. ,
Required: True ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
links:
{
Description: Links to related resources and endpoints. ,
Required: True ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
title:
{
Description: Human-readable title for the collection. ,
Required: False ,
}
string ,
type:
{
Description: Type ,
Required: False ,
}
string ,
assets:
{
Description: Assets ,
Required: False ,
}
object ,
license:
{
Description: License identifier for the collection data. ,
Required: True ,
}
string ,
extent:
{
Description: Spatial and temporal extent of the collection. ,
Required: True ,
}
{
spatial:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#spatial-extent-object Spatial extent defined by bounding boxes. ,
Required: True ,
}
{
bbox:
{
Description: Array of bounding boxes defining the spatial extent, in format [[west, south, east, north]]. ,
Required: False ,
}
[
number ,
]
,
}
,
temporal:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#temporal-extent-object Temporal extent defined by time intervals. ,
Required: True ,
}
{
interval:
{
Description: Array of time intervals in format [[start_datetime, end_datetime]]. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
keywords:
{
Description: Keywords describing the collection. ,
Required: False ,
}
[
string ,
]
,
providers:
{
Description: Organizations or individuals who provide the collection data. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provider organization or individual. ,
Required: True ,
}
string ,
description:
{
Description: Description of the provider. ,
Required: False ,
}
string ,
roles:
{
Description: Roles played by the provider (e.g., producer, processor, host). ,
Required: False ,
}
[
string ,
]
,
url:
{
Description: URL to the provider's website. ,
Required: False ,
}
string ,
}
,
]
,
summaries:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#summaries Summaries ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionOperations_CreateOrReplace (new)
Description :  Create or replace a collection in the GeoCatalog instance
Reference :  Link ¶

⚼ Request

PUT:  /stac/collections/{collectionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
body:
{
Description: Request collection body ,
Required: True ,
}
{
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the collection. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the collection. ,
Required: True ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
links:
{
Description: Links to related resources and endpoints. ,
Required: True ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
title:
{
Description: Human-readable title for the collection. ,
Required: False ,
}
string ,
type:
{
Description: Type ,
Required: False ,
}
string ,
assets:
{
Description: Assets ,
Required: False ,
}
object ,
license:
{
Description: License identifier for the collection data. ,
Required: True ,
}
string ,
extent:
{
Description: Spatial and temporal extent of the collection. ,
Required: True ,
}
{
spatial:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#spatial-extent-object Spatial extent defined by bounding boxes. ,
Required: True ,
}
{
bbox:
{
Description: Array of bounding boxes defining the spatial extent, in format [[west, south, east, north]]. ,
Required: False ,
}
[
number ,
]
,
}
,
temporal:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#temporal-extent-object Temporal extent defined by time intervals. ,
Required: True ,
}
{
interval:
{
Description: Array of time intervals in format [[start_datetime, end_datetime]]. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
keywords:
{
Description: Keywords describing the collection. ,
Required: False ,
}
[
string ,
]
,
providers:
{
Description: Organizations or individuals who provide the collection data. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provider organization or individual. ,
Required: True ,
}
string ,
description:
{
Description: Description of the provider. ,
Required: False ,
}
string ,
roles:
{
Description: Roles played by the provider (e.g., producer, processor, host). ,
Required: False ,
}
[
string ,
]
,
url:
{
Description: URL to the provider's website. ,
Required: False ,
}
string ,
}
,
]
,
summaries:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#summaries Summaries ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: Url used to monitor the background operation ,
}
string ,
operation-location:
{
Description: Url used to monitor the background operation ,
}
string ,
}
,
$schema:
{
Description: Spatio geo-catalog operation ,
}
{
id:
{
Description: Operation id ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Operation status ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Operation type ,
Required: True ,
}
string ,
creationTime:
{
Description: The UTC time at which the operation was created ,
Format: date-time ,
Required: True ,
}
string ,
collectionId:
{
Description: Collection ID ,
Required: False ,
}
string ,
statusHistory:
{
Description: The history of the operation status in time ,
Required: True ,
}
[
{
timestamp:
{
Description: The UTC time at which the status was set ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
errorCode:
{
Description: If the status is failed, the error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: If the status is failed, the error message ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The UTC time at which the operation was started ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The UTC time at which the operation finished its execution ,
Format: date-time ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information elements about the particular operation type ,
Required: False ,
}
object ,
error:
{
Description: Error information ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionOperations_Delete (new)
Description :  Delete a collection in the GeoCatalog instance
Reference :  Link ¶

⚼ Request

DELETE:  /stac/collections/{collectionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: Url used to monitor the background operation ,
}
string ,
operation-location:
{
Description: Url used to monitor the background operation ,
}
string ,
}
,
$schema:
{
Description: Spatio geo-catalog operation ,
}
{
id:
{
Description: Operation id ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Operation status ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Operation type ,
Required: True ,
}
string ,
creationTime:
{
Description: The UTC time at which the operation was created ,
Format: date-time ,
Required: True ,
}
string ,
collectionId:
{
Description: Collection ID ,
Required: False ,
}
string ,
statusHistory:
{
Description: The history of the operation status in time ,
Required: True ,
}
[
{
timestamp:
{
Description: The UTC time at which the status was set ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
errorCode:
{
Description: If the status is failed, the error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: If the status is failed, the error message ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The UTC time at which the operation was started ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The UTC time at which the operation finished its execution ,
Format: date-time ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information elements about the particular operation type ,
Required: False ,
}
object ,
error:
{
Description: Error information ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionAssets_Create (new)
Description :  Create a new asset in the Collection metadata and write the associated file to managed storage. Args: request: The incoming request. asset: The Asset object to write, without a valid href to the asset. file: The file to write. collection_id: The ID of the collection to write the asset to. content_type: The content type of the request. Returns: A Response object containing the newly created asset.
Reference :  Link ¶

⚼ Request

POST:  /stac/collections/{collectionId}/assets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: STAC Collection ID ,
Required: True ,
}
string ,
data:
{
Description: Asset metadata ,
Required: True ,
}
string ,
file:
{
Description: Binary file content to be uploaded. ,
Required: True ,
}
file ,
}

⚐ Response (200)

{
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the collection. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the collection. ,
Required: True ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
links:
{
Description: Links to related resources and endpoints. ,
Required: True ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
title:
{
Description: Human-readable title for the collection. ,
Required: False ,
}
string ,
type:
{
Description: Type ,
Required: False ,
}
string ,
assets:
{
Description: Assets ,
Required: False ,
}
object ,
license:
{
Description: License identifier for the collection data. ,
Required: True ,
}
string ,
extent:
{
Description: Spatial and temporal extent of the collection. ,
Required: True ,
}
{
spatial:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#spatial-extent-object Spatial extent defined by bounding boxes. ,
Required: True ,
}
{
bbox:
{
Description: Array of bounding boxes defining the spatial extent, in format [[west, south, east, north]]. ,
Required: False ,
}
[
number ,
]
,
}
,
temporal:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#temporal-extent-object Temporal extent defined by time intervals. ,
Required: True ,
}
{
interval:
{
Description: Array of time intervals in format [[start_datetime, end_datetime]]. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
keywords:
{
Description: Keywords describing the collection. ,
Required: False ,
}
[
string ,
]
,
providers:
{
Description: Organizations or individuals who provide the collection data. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provider organization or individual. ,
Required: True ,
}
string ,
description:
{
Description: Description of the provider. ,
Required: False ,
}
string ,
roles:
{
Description: Roles played by the provider (e.g., producer, processor, host). ,
Required: False ,
}
[
string ,
]
,
url:
{
Description: URL to the provider's website. ,
Required: False ,
}
string ,
}
,
]
,
summaries:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#summaries Summaries ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the collection. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the collection. ,
Required: True ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
links:
{
Description: Links to related resources and endpoints. ,
Required: True ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
title:
{
Description: Human-readable title for the collection. ,
Required: False ,
}
string ,
type:
{
Description: Type ,
Required: False ,
}
string ,
assets:
{
Description: Assets ,
Required: False ,
}
object ,
license:
{
Description: License identifier for the collection data. ,
Required: True ,
}
string ,
extent:
{
Description: Spatial and temporal extent of the collection. ,
Required: True ,
}
{
spatial:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#spatial-extent-object Spatial extent defined by bounding boxes. ,
Required: True ,
}
{
bbox:
{
Description: Array of bounding boxes defining the spatial extent, in format [[west, south, east, north]]. ,
Required: False ,
}
[
number ,
]
,
}
,
temporal:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#temporal-extent-object Temporal extent defined by time intervals. ,
Required: True ,
}
{
interval:
{
Description: Array of time intervals in format [[start_datetime, end_datetime]]. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
keywords:
{
Description: Keywords describing the collection. ,
Required: False ,
}
[
string ,
]
,
providers:
{
Description: Organizations or individuals who provide the collection data. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provider organization or individual. ,
Required: True ,
}
string ,
description:
{
Description: Description of the provider. ,
Required: False ,
}
string ,
roles:
{
Description: Roles played by the provider (e.g., producer, processor, host). ,
Required: False ,
}
[
string ,
]
,
url:
{
Description: URL to the provider's website. ,
Required: False ,
}
string ,
}
,
]
,
summaries:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#summaries Summaries ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionAssets_CreateOrReplace (new)
Description :  Update an existing asset in a given collection. Args: request: The incoming request. asset: The Asset object to update. file: The file to update (optional). collection_id: The ID of the collection to update the asset in. asset_id: The ID of the asset to update. content_type: The content type of the request. Returns: A Response object containing the updated asset.
Reference :  Link ¶

⚼ Request

PUT:  /stac/collections/{collectionId}/assets/{assetId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: STAC Collection ID ,
Required: True ,
}
string ,
assetId:
{
Description: STAC Asset ID ,
Required: True ,
}
string ,
data:
{
Description: Asset metadata ,
Required: True ,
}
string ,
file:
{
Description: Binary file content to be uploaded. ,
Required: True ,
}
file ,
}

⚐ Response (200)

{
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the collection. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the collection. ,
Required: True ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
links:
{
Description: Links to related resources and endpoints. ,
Required: True ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
title:
{
Description: Human-readable title for the collection. ,
Required: False ,
}
string ,
type:
{
Description: Type ,
Required: False ,
}
string ,
assets:
{
Description: Assets ,
Required: False ,
}
object ,
license:
{
Description: License identifier for the collection data. ,
Required: True ,
}
string ,
extent:
{
Description: Spatial and temporal extent of the collection. ,
Required: True ,
}
{
spatial:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#spatial-extent-object Spatial extent defined by bounding boxes. ,
Required: True ,
}
{
bbox:
{
Description: Array of bounding boxes defining the spatial extent, in format [[west, south, east, north]]. ,
Required: False ,
}
[
number ,
]
,
}
,
temporal:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#temporal-extent-object Temporal extent defined by time intervals. ,
Required: True ,
}
{
interval:
{
Description: Array of time intervals in format [[start_datetime, end_datetime]]. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
keywords:
{
Description: Keywords describing the collection. ,
Required: False ,
}
[
string ,
]
,
providers:
{
Description: Organizations or individuals who provide the collection data. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provider organization or individual. ,
Required: True ,
}
string ,
description:
{
Description: Description of the provider. ,
Required: False ,
}
string ,
roles:
{
Description: Roles played by the provider (e.g., producer, processor, host). ,
Required: False ,
}
[
string ,
]
,
url:
{
Description: URL to the provider's website. ,
Required: False ,
}
string ,
}
,
]
,
summaries:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#summaries Summaries ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the collection. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the collection. ,
Required: True ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
links:
{
Description: Links to related resources and endpoints. ,
Required: True ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
title:
{
Description: Human-readable title for the collection. ,
Required: False ,
}
string ,
type:
{
Description: Type ,
Required: False ,
}
string ,
assets:
{
Description: Assets ,
Required: False ,
}
object ,
license:
{
Description: License identifier for the collection data. ,
Required: True ,
}
string ,
extent:
{
Description: Spatial and temporal extent of the collection. ,
Required: True ,
}
{
spatial:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#spatial-extent-object Spatial extent defined by bounding boxes. ,
Required: True ,
}
{
bbox:
{
Description: Array of bounding boxes defining the spatial extent, in format [[west, south, east, north]]. ,
Required: False ,
}
[
number ,
]
,
}
,
temporal:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#temporal-extent-object Temporal extent defined by time intervals. ,
Required: True ,
}
{
interval:
{
Description: Array of time intervals in format [[start_datetime, end_datetime]]. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
keywords:
{
Description: Keywords describing the collection. ,
Required: False ,
}
[
string ,
]
,
providers:
{
Description: Organizations or individuals who provide the collection data. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provider organization or individual. ,
Required: True ,
}
string ,
description:
{
Description: Description of the provider. ,
Required: False ,
}
string ,
roles:
{
Description: Roles played by the provider (e.g., producer, processor, host). ,
Required: False ,
}
[
string ,
]
,
url:
{
Description: URL to the provider's website. ,
Required: False ,
}
string ,
}
,
]
,
summaries:
{
Description: https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#summaries Summaries ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionAssets_Delete (new)
Description :  Delete an asset from a given collection. Args: request: The incoming request. collection_id: The ID of the collection to delete the asset from. asset_id: The ID of the asset to delete. Returns: A Response object indicating the success of the deletion.
Reference :  Link ¶

⚼ Request

DELETE:  /stac/collections/{collectionId}/assets/{assetId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: STAC Collection ID ,
Required: True ,
}
string ,
assetId:
{
Description: STAC Asset ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionConfig_Get (new)
Description :  Get the complete user configuration for a given collection
Reference :  Link ¶

⚼ Request

GET:  /stac/collections/{collectionId}/configurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tileSettings:
{
Description: Settings for map tile visualization. ,
Required: True ,
}
{
minZoom:
{
Description: The minimum zoom level that can be requested for this collection. Provides a hard limit for the tile servers to ensure they don't get requests for low zoom levels, which would cause many files to be fetched and the tile servers to hang. ,
Format: int32 ,
Required: True ,
}
integer ,
maxItemsPerTile:
{
Description: Maximum number of items to include in a single tile. ,
Format: int32 ,
Required: True ,
}
integer ,
defaultLocation:
{
Description: Default map location when displaying this collection. ,
Required: False ,
}
{
zoom:
{
Description: Default zoom level for the map. ,
Format: int32 ,
Required: True ,
}
integer ,
coordinates:
{
Description: Default center coordinates [latitude, longitude] for the map. ,
Required: True ,
}
[
number ,
]
,
}
,
}
,
mosaicInfo:
{
Description: Settings for data mosaic visualization. ,
Required: True ,
}
{
mosaics:
{
Description: Predefined data mosaics available for this collection. ,
Required: True ,
}
[
{
id:
{
Description: Unique identifier for the mosaic. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the mosaic. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the mosaic. ,
Required: False ,
}
string ,
cql:
{
Description: A list of valid CQL2-JSON expressions used to filter the collection to moasic. ,
Required: True ,
}
[
{
filter-lang:
{
Description: Filter language ,
Required: True ,
}
string ,
filter:
{
Description: Filter ,
Required: True ,
}
{
op:
{
Description: Logical operator ,
Required: True ,
}
string ,
args:
{
Description: Arguments for the logical operator ,
Required: True ,
}
[
string ,
]
,
}
,
sortby:
{
Description: Sort by ,
Required: False ,
}
[
{
field:
{
Description: Field to sort by ,
Required: True ,
}
string ,
direction:
{
Description: Sort direction ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
renderOptions:
{
Description: Available render options for visualizing the data. ,
Required: True ,
}
[
{
id:
{
Description: Unique identifier for the render option. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the render option. ,
Required: True ,
}
string ,
description:
{
Description: A longer description of the render option that can be used to explain its content. ,
Required: False ,
}
string ,
type:
{
Description: The type of rendering to apply (raster or vector). ,
Enum:
{
raster-tile: Raster tile rendering type. ,
vt-polygon: Vector tile polygon rendering type. ,
vt-line: Vector tile line rendering type. ,
}
,
Required: False ,
}
enum ,
options:
{
Description: A URL query-string encoded string of TiTiler rendering options. Valid only for `raster-tile` types. See 'Query Parameters': https://developmentseed.org/titiler/endpoints/cog/#description ,
Required: False ,
}
string ,
vectorOptions:
{
Description: Options for rendering vector tiles. Valid only for `vt-polygon` and `vt-line` types. ,
Required: False ,
}
{
tilejsonKey:
{
Description: Asset key containing the TileJSON URL. ,
Required: True ,
}
string ,
sourceLayer:
{
Description: Name of the source layer in the vector tiles. ,
Required: True ,
}
string ,
fillColor:
{
Description: Fill color for polygon features. ,
Required: False ,
}
string ,
strokeColor:
{
Description: Stroke color for line features. ,
Required: False ,
}
string ,
strokeWidth:
{
Description: Width of line strokes in pixels. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: MapBox GL filter expression to filter features. ,
Required: False ,
}
[
string ,
]
,
}
,
minZoom:
{
Description: Minimum zoom level at which to display this layer. ,
Format: int32 ,
Required: False ,
}
integer ,
legend:
{
Description: Legend configuration for this render option. ,
Required: False ,
}
{
type:
{
Description: Legend type to make, one of: `continuous`, `classmap`, `interval` or `none` (note, `none` is a string literal). ,
Enum:
{
continuous: Continuous color ramp legend. ,
classmap: Classified map with discrete colors for classes. ,
interval: Interval-based legend with discrete ranges. ,
none: No legend. ,
}
,
Required: False ,
}
enum ,
labels:
{
Description: Text labels to display on the legend. ,
Required: False ,
}
[
string ,
]
,
trimStart:
{
Description: The number of items to trim from the start of the legend definition. Used if there are values important for rendering (e.g. nodata) that aren't desirable in the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
trimEnd:
{
Description: Number of items to trim from the end of the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleFactor:
{
Description: A factor to multiply interval legend labels by. Useful for scaled rasters whose colormap definitions map to unscaled values, effectively showing legend labels as scaled values. ,
Format: float ,
Required: False ,
}
number ,
}
,
conditions:
{
Description: A list of property/value conditions that must be in the active mosaic CQL for this render option to be enabled ,
Required: False ,
}
[
{
property:
{
Description: Property name to check in the active CQL filter. ,
Required: True ,
}
string ,
value:
{
Description: Value that the property must equal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
defaultLocation:
{
Description: Default map location when displaying this collection. ,
Required: False ,
}
{
zoom:
{
Description: Default zoom level for the map. ,
Format: int32 ,
Required: True ,
}
integer ,
coordinates:
{
Description: Default center coordinates [latitude, longitude] for the map. ,
Required: True ,
}
[
number ,
]
,
}
,
defaultCustomQuery:
{
Description: A list of CQL-JSON expressions to use as the default for this collection. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionMosaics_GetAll (new)
Description :  Get the mosaic definitions for a given collection
Reference :  Link ¶

⚼ Request

GET:  /stac/collections/{collectionId}/configurations/mosaics
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique identifier for the mosaic. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the mosaic. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the mosaic. ,
Required: False ,
}
string ,
cql:
{
Description: A list of valid CQL2-JSON expressions used to filter the collection to moasic. ,
Required: True ,
}
[
{
filter-lang:
{
Description: Filter language ,
Required: True ,
}
string ,
filter:
{
Description: Filter ,
Required: True ,
}
{
op:
{
Description: Logical operator ,
Required: True ,
}
string ,
args:
{
Description: Arguments for the logical operator ,
Required: True ,
}
[
string ,
]
,
}
,
sortby:
{
Description: Sort by ,
Required: False ,
}
[
{
field:
{
Description: Field to sort by ,
Required: True ,
}
string ,
direction:
{
Description: Sort direction ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionMosaics_Add (new)
Description :  Add a mosaic definition to a given collection
Reference :  Link ¶

⚼ Request

POST:  /stac/collections/{collectionId}/configurations/mosaics
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
body:
{
Description: Mosaic definition to be created or updated. ,
Required: True ,
}
{
id:
{
Description: Unique identifier for the mosaic. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the mosaic. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the mosaic. ,
Required: False ,
}
string ,
cql:
{
Description: A list of valid CQL2-JSON expressions used to filter the collection to moasic. ,
Required: True ,
}
[
{
filter-lang:
{
Description: Filter language ,
Required: True ,
}
string ,
filter:
{
Description: Filter ,
Required: True ,
}
{
op:
{
Description: Logical operator ,
Required: True ,
}
string ,
args:
{
Description: Arguments for the logical operator ,
Required: True ,
}
[
string ,
]
,
}
,
sortby:
{
Description: Sort by ,
Required: False ,
}
[
{
field:
{
Description: Field to sort by ,
Required: True ,
}
string ,
direction:
{
Description: Sort direction ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique identifier for the mosaic. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the mosaic. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the mosaic. ,
Required: False ,
}
string ,
cql:
{
Description: A list of valid CQL2-JSON expressions used to filter the collection to moasic. ,
Required: True ,
}
[
{
filter-lang:
{
Description: Filter language ,
Required: True ,
}
string ,
filter:
{
Description: Filter ,
Required: True ,
}
{
op:
{
Description: Logical operator ,
Required: True ,
}
string ,
args:
{
Description: Arguments for the logical operator ,
Required: True ,
}
[
string ,
]
,
}
,
sortby:
{
Description: Sort by ,
Required: False ,
}
[
{
field:
{
Description: Field to sort by ,
Required: True ,
}
string ,
direction:
{
Description: Sort direction ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (201)

{
id:
{
Description: Unique identifier for the mosaic. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the mosaic. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the mosaic. ,
Required: False ,
}
string ,
cql:
{
Description: A list of valid CQL2-JSON expressions used to filter the collection to moasic. ,
Required: True ,
}
[
{
filter-lang:
{
Description: Filter language ,
Required: True ,
}
string ,
filter:
{
Description: Filter ,
Required: True ,
}
{
op:
{
Description: Logical operator ,
Required: True ,
}
string ,
args:
{
Description: Arguments for the logical operator ,
Required: True ,
}
[
string ,
]
,
}
,
sortby:
{
Description: Sort by ,
Required: False ,
}
[
{
field:
{
Description: Field to sort by ,
Required: True ,
}
string ,
direction:
{
Description: Sort direction ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionMosaics_Get (new)
Description :  Get a mosaic definition from a given collection
Reference :  Link ¶

⚼ Request

GET:  /stac/collections/{collectionId}/configurations/mosaics/{mosaicId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
mosaicId:
{
Description: Unique identifier for the mosaic configuration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique identifier for the mosaic. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the mosaic. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the mosaic. ,
Required: False ,
}
string ,
cql:
{
Description: A list of valid CQL2-JSON expressions used to filter the collection to moasic. ,
Required: True ,
}
[
{
filter-lang:
{
Description: Filter language ,
Required: True ,
}
string ,
filter:
{
Description: Filter ,
Required: True ,
}
{
op:
{
Description: Logical operator ,
Required: True ,
}
string ,
args:
{
Description: Arguments for the logical operator ,
Required: True ,
}
[
string ,
]
,
}
,
sortby:
{
Description: Sort by ,
Required: False ,
}
[
{
field:
{
Description: Field to sort by ,
Required: True ,
}
string ,
direction:
{
Description: Sort direction ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionMosaics_CreateOrReplace (new)
Description :  Update a mosaic definition from a given collection
Reference :  Link ¶

⚼ Request

PUT:  /stac/collections/{collectionId}/configurations/mosaics/{mosaicId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
mosaicId:
{
Description: Unique identifier for the mosaic configuration. ,
Required: True ,
}
string ,
body:
{
Description: Mosaic definition to be created or updated. ,
Required: True ,
}
{
id:
{
Description: Unique identifier for the mosaic. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the mosaic. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the mosaic. ,
Required: False ,
}
string ,
cql:
{
Description: A list of valid CQL2-JSON expressions used to filter the collection to moasic. ,
Required: True ,
}
[
{
filter-lang:
{
Description: Filter language ,
Required: True ,
}
string ,
filter:
{
Description: Filter ,
Required: True ,
}
{
op:
{
Description: Logical operator ,
Required: True ,
}
string ,
args:
{
Description: Arguments for the logical operator ,
Required: True ,
}
[
string ,
]
,
}
,
sortby:
{
Description: Sort by ,
Required: False ,
}
[
{
field:
{
Description: Field to sort by ,
Required: True ,
}
string ,
direction:
{
Description: Sort direction ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique identifier for the mosaic. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the mosaic. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the mosaic. ,
Required: False ,
}
string ,
cql:
{
Description: A list of valid CQL2-JSON expressions used to filter the collection to moasic. ,
Required: True ,
}
[
{
filter-lang:
{
Description: Filter language ,
Required: True ,
}
string ,
filter:
{
Description: Filter ,
Required: True ,
}
{
op:
{
Description: Logical operator ,
Required: True ,
}
string ,
args:
{
Description: Arguments for the logical operator ,
Required: True ,
}
[
string ,
]
,
}
,
sortby:
{
Description: Sort by ,
Required: False ,
}
[
{
field:
{
Description: Field to sort by ,
Required: True ,
}
string ,
direction:
{
Description: Sort direction ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (201)

{
id:
{
Description: Unique identifier for the mosaic. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the mosaic. ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of the mosaic. ,
Required: False ,
}
string ,
cql:
{
Description: A list of valid CQL2-JSON expressions used to filter the collection to moasic. ,
Required: True ,
}
[
{
filter-lang:
{
Description: Filter language ,
Required: True ,
}
string ,
filter:
{
Description: Filter ,
Required: True ,
}
{
op:
{
Description: Logical operator ,
Required: True ,
}
string ,
args:
{
Description: Arguments for the logical operator ,
Required: True ,
}
[
string ,
]
,
}
,
sortby:
{
Description: Sort by ,
Required: False ,
}
[
{
field:
{
Description: Field to sort by ,
Required: True ,
}
string ,
direction:
{
Description: Sort direction ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionMosaics_Delete (new)
Description :  Delete a mosaic definition from a given collection
Reference :  Link ¶

⚼ Request

DELETE:  /stac/collections/{collectionId}/configurations/mosaics/{mosaicId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
mosaicId:
{
Description: Unique identifier for the mosaic configuration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionPartitionTypes_Get (new)
Description :  Get the partitiontype for a GeoCatalog Collection. Args: collection_id: the collection id to get the partitiontype for. Returns: The partitiontype for the collection.
Reference :  Link ¶

⚼ Request

GET:  /stac/collections/{collectionId}/configurations/partition-type
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
scheme:
{
Description: Partitioning scheme to use for data organization. ,
Enum:
{
year: Partition data by year. ,
month: Partition data by month. ,
none: No partitioning. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionPartitionTypes_Replace (new)
Description :  Updates partition type for a GeoCatalog Collection. This will determine the partitioning scheme for items within the database, and can only be set before any items are loaded. Ideal partitioning schemes result in partitions of roughly 100k items each. The default partitioning scheme is "none" which does not partition items. Args: collection_id: the collection id to add the partitiontype to. partitiontype: the partitiontype to add. Returns: None
Reference :  Link ¶

⚼ Request

PUT:  /stac/collections/{collectionId}/configurations/partition-type
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
body:
{
Description: Partition type configuration determining how items are partitioned in storage. ,
Required: True ,
}
{
scheme:
{
Description: Partitioning scheme to use for data organization. ,
Enum:
{
year: Partition data by year. ,
month: Partition data by month. ,
none: No partitioning. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
scheme:
{
Description: Partitioning scheme to use for data organization. ,
Enum:
{
year: Partition data by year. ,
month: Partition data by month. ,
none: No partitioning. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionRenderOptions_GetAll (new)
Description :  Get all render options for a given collection
Reference :  Link ¶

⚼ Request

GET:  /stac/collections/{collectionId}/configurations/render-options
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique identifier for the render option. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the render option. ,
Required: True ,
}
string ,
description:
{
Description: A longer description of the render option that can be used to explain its content. ,
Required: False ,
}
string ,
type:
{
Description: The type of rendering to apply (raster or vector). ,
Enum:
{
raster-tile: Raster tile rendering type. ,
vt-polygon: Vector tile polygon rendering type. ,
vt-line: Vector tile line rendering type. ,
}
,
Required: False ,
}
enum ,
options:
{
Description: A URL query-string encoded string of TiTiler rendering options. Valid only for `raster-tile` types. See 'Query Parameters': https://developmentseed.org/titiler/endpoints/cog/#description ,
Required: False ,
}
string ,
vectorOptions:
{
Description: Options for rendering vector tiles. Valid only for `vt-polygon` and `vt-line` types. ,
Required: False ,
}
{
tilejsonKey:
{
Description: Asset key containing the TileJSON URL. ,
Required: True ,
}
string ,
sourceLayer:
{
Description: Name of the source layer in the vector tiles. ,
Required: True ,
}
string ,
fillColor:
{
Description: Fill color for polygon features. ,
Required: False ,
}
string ,
strokeColor:
{
Description: Stroke color for line features. ,
Required: False ,
}
string ,
strokeWidth:
{
Description: Width of line strokes in pixels. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: MapBox GL filter expression to filter features. ,
Required: False ,
}
[
string ,
]
,
}
,
minZoom:
{
Description: Minimum zoom level at which to display this layer. ,
Format: int32 ,
Required: False ,
}
integer ,
legend:
{
Description: Legend configuration for this render option. ,
Required: False ,
}
{
type:
{
Description: Legend type to make, one of: `continuous`, `classmap`, `interval` or `none` (note, `none` is a string literal). ,
Enum:
{
continuous: Continuous color ramp legend. ,
classmap: Classified map with discrete colors for classes. ,
interval: Interval-based legend with discrete ranges. ,
none: No legend. ,
}
,
Required: False ,
}
enum ,
labels:
{
Description: Text labels to display on the legend. ,
Required: False ,
}
[
string ,
]
,
trimStart:
{
Description: The number of items to trim from the start of the legend definition. Used if there are values important for rendering (e.g. nodata) that aren't desirable in the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
trimEnd:
{
Description: Number of items to trim from the end of the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleFactor:
{
Description: A factor to multiply interval legend labels by. Useful for scaled rasters whose colormap definitions map to unscaled values, effectively showing legend labels as scaled values. ,
Format: float ,
Required: False ,
}
number ,
}
,
conditions:
{
Description: A list of property/value conditions that must be in the active mosaic CQL for this render option to be enabled ,
Required: False ,
}
[
{
property:
{
Description: Property name to check in the active CQL filter. ,
Required: True ,
}
string ,
value:
{
Description: Value that the property must equal. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionRenderOptions_Create (new)
Description :  Add a render option for a given collection
Reference :  Link ¶

⚼ Request

POST:  /stac/collections/{collectionId}/configurations/render-options
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
body:
{
Description: Render option configuration to be created or updated. ,
Required: True ,
}
{
id:
{
Description: Unique identifier for the render option. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the render option. ,
Required: True ,
}
string ,
description:
{
Description: A longer description of the render option that can be used to explain its content. ,
Required: False ,
}
string ,
type:
{
Description: The type of rendering to apply (raster or vector). ,
Enum:
{
raster-tile: Raster tile rendering type. ,
vt-polygon: Vector tile polygon rendering type. ,
vt-line: Vector tile line rendering type. ,
}
,
Required: False ,
}
enum ,
options:
{
Description: A URL query-string encoded string of TiTiler rendering options. Valid only for `raster-tile` types. See 'Query Parameters': https://developmentseed.org/titiler/endpoints/cog/#description ,
Required: False ,
}
string ,
vectorOptions:
{
Description: Options for rendering vector tiles. Valid only for `vt-polygon` and `vt-line` types. ,
Required: False ,
}
{
tilejsonKey:
{
Description: Asset key containing the TileJSON URL. ,
Required: True ,
}
string ,
sourceLayer:
{
Description: Name of the source layer in the vector tiles. ,
Required: True ,
}
string ,
fillColor:
{
Description: Fill color for polygon features. ,
Required: False ,
}
string ,
strokeColor:
{
Description: Stroke color for line features. ,
Required: False ,
}
string ,
strokeWidth:
{
Description: Width of line strokes in pixels. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: MapBox GL filter expression to filter features. ,
Required: False ,
}
[
string ,
]
,
}
,
minZoom:
{
Description: Minimum zoom level at which to display this layer. ,
Format: int32 ,
Required: False ,
}
integer ,
legend:
{
Description: Legend configuration for this render option. ,
Required: False ,
}
{
type:
{
Description: Legend type to make, one of: `continuous`, `classmap`, `interval` or `none` (note, `none` is a string literal). ,
Enum:
{
continuous: Continuous color ramp legend. ,
classmap: Classified map with discrete colors for classes. ,
interval: Interval-based legend with discrete ranges. ,
none: No legend. ,
}
,
Required: False ,
}
enum ,
labels:
{
Description: Text labels to display on the legend. ,
Required: False ,
}
[
string ,
]
,
trimStart:
{
Description: The number of items to trim from the start of the legend definition. Used if there are values important for rendering (e.g. nodata) that aren't desirable in the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
trimEnd:
{
Description: Number of items to trim from the end of the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleFactor:
{
Description: A factor to multiply interval legend labels by. Useful for scaled rasters whose colormap definitions map to unscaled values, effectively showing legend labels as scaled values. ,
Format: float ,
Required: False ,
}
number ,
}
,
conditions:
{
Description: A list of property/value conditions that must be in the active mosaic CQL for this render option to be enabled ,
Required: False ,
}
[
{
property:
{
Description: Property name to check in the active CQL filter. ,
Required: True ,
}
string ,
value:
{
Description: Value that the property must equal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique identifier for the render option. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the render option. ,
Required: True ,
}
string ,
description:
{
Description: A longer description of the render option that can be used to explain its content. ,
Required: False ,
}
string ,
type:
{
Description: The type of rendering to apply (raster or vector). ,
Enum:
{
raster-tile: Raster tile rendering type. ,
vt-polygon: Vector tile polygon rendering type. ,
vt-line: Vector tile line rendering type. ,
}
,
Required: False ,
}
enum ,
options:
{
Description: A URL query-string encoded string of TiTiler rendering options. Valid only for `raster-tile` types. See 'Query Parameters': https://developmentseed.org/titiler/endpoints/cog/#description ,
Required: False ,
}
string ,
vectorOptions:
{
Description: Options for rendering vector tiles. Valid only for `vt-polygon` and `vt-line` types. ,
Required: False ,
}
{
tilejsonKey:
{
Description: Asset key containing the TileJSON URL. ,
Required: True ,
}
string ,
sourceLayer:
{
Description: Name of the source layer in the vector tiles. ,
Required: True ,
}
string ,
fillColor:
{
Description: Fill color for polygon features. ,
Required: False ,
}
string ,
strokeColor:
{
Description: Stroke color for line features. ,
Required: False ,
}
string ,
strokeWidth:
{
Description: Width of line strokes in pixels. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: MapBox GL filter expression to filter features. ,
Required: False ,
}
[
string ,
]
,
}
,
minZoom:
{
Description: Minimum zoom level at which to display this layer. ,
Format: int32 ,
Required: False ,
}
integer ,
legend:
{
Description: Legend configuration for this render option. ,
Required: False ,
}
{
type:
{
Description: Legend type to make, one of: `continuous`, `classmap`, `interval` or `none` (note, `none` is a string literal). ,
Enum:
{
continuous: Continuous color ramp legend. ,
classmap: Classified map with discrete colors for classes. ,
interval: Interval-based legend with discrete ranges. ,
none: No legend. ,
}
,
Required: False ,
}
enum ,
labels:
{
Description: Text labels to display on the legend. ,
Required: False ,
}
[
string ,
]
,
trimStart:
{
Description: The number of items to trim from the start of the legend definition. Used if there are values important for rendering (e.g. nodata) that aren't desirable in the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
trimEnd:
{
Description: Number of items to trim from the end of the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleFactor:
{
Description: A factor to multiply interval legend labels by. Useful for scaled rasters whose colormap definitions map to unscaled values, effectively showing legend labels as scaled values. ,
Format: float ,
Required: False ,
}
number ,
}
,
conditions:
{
Description: A list of property/value conditions that must be in the active mosaic CQL for this render option to be enabled ,
Required: False ,
}
[
{
property:
{
Description: Property name to check in the active CQL filter. ,
Required: True ,
}
string ,
value:
{
Description: Value that the property must equal. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (201)

{
id:
{
Description: Unique identifier for the render option. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the render option. ,
Required: True ,
}
string ,
description:
{
Description: A longer description of the render option that can be used to explain its content. ,
Required: False ,
}
string ,
type:
{
Description: The type of rendering to apply (raster or vector). ,
Enum:
{
raster-tile: Raster tile rendering type. ,
vt-polygon: Vector tile polygon rendering type. ,
vt-line: Vector tile line rendering type. ,
}
,
Required: False ,
}
enum ,
options:
{
Description: A URL query-string encoded string of TiTiler rendering options. Valid only for `raster-tile` types. See 'Query Parameters': https://developmentseed.org/titiler/endpoints/cog/#description ,
Required: False ,
}
string ,
vectorOptions:
{
Description: Options for rendering vector tiles. Valid only for `vt-polygon` and `vt-line` types. ,
Required: False ,
}
{
tilejsonKey:
{
Description: Asset key containing the TileJSON URL. ,
Required: True ,
}
string ,
sourceLayer:
{
Description: Name of the source layer in the vector tiles. ,
Required: True ,
}
string ,
fillColor:
{
Description: Fill color for polygon features. ,
Required: False ,
}
string ,
strokeColor:
{
Description: Stroke color for line features. ,
Required: False ,
}
string ,
strokeWidth:
{
Description: Width of line strokes in pixels. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: MapBox GL filter expression to filter features. ,
Required: False ,
}
[
string ,
]
,
}
,
minZoom:
{
Description: Minimum zoom level at which to display this layer. ,
Format: int32 ,
Required: False ,
}
integer ,
legend:
{
Description: Legend configuration for this render option. ,
Required: False ,
}
{
type:
{
Description: Legend type to make, one of: `continuous`, `classmap`, `interval` or `none` (note, `none` is a string literal). ,
Enum:
{
continuous: Continuous color ramp legend. ,
classmap: Classified map with discrete colors for classes. ,
interval: Interval-based legend with discrete ranges. ,
none: No legend. ,
}
,
Required: False ,
}
enum ,
labels:
{
Description: Text labels to display on the legend. ,
Required: False ,
}
[
string ,
]
,
trimStart:
{
Description: The number of items to trim from the start of the legend definition. Used if there are values important for rendering (e.g. nodata) that aren't desirable in the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
trimEnd:
{
Description: Number of items to trim from the end of the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleFactor:
{
Description: A factor to multiply interval legend labels by. Useful for scaled rasters whose colormap definitions map to unscaled values, effectively showing legend labels as scaled values. ,
Format: float ,
Required: False ,
}
number ,
}
,
conditions:
{
Description: A list of property/value conditions that must be in the active mosaic CQL for this render option to be enabled ,
Required: False ,
}
[
{
property:
{
Description: Property name to check in the active CQL filter. ,
Required: True ,
}
string ,
value:
{
Description: Value that the property must equal. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionRenderOptions_Get (new)
Description :  Get a render option for a given collection
Reference :  Link ¶

⚼ Request

GET:  /stac/collections/{collectionId}/configurations/render-options/{renderOptionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
renderOptionId:
{
Description: Unique identifier for the render option. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique identifier for the render option. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the render option. ,
Required: True ,
}
string ,
description:
{
Description: A longer description of the render option that can be used to explain its content. ,
Required: False ,
}
string ,
type:
{
Description: The type of rendering to apply (raster or vector). ,
Enum:
{
raster-tile: Raster tile rendering type. ,
vt-polygon: Vector tile polygon rendering type. ,
vt-line: Vector tile line rendering type. ,
}
,
Required: False ,
}
enum ,
options:
{
Description: A URL query-string encoded string of TiTiler rendering options. Valid only for `raster-tile` types. See 'Query Parameters': https://developmentseed.org/titiler/endpoints/cog/#description ,
Required: False ,
}
string ,
vectorOptions:
{
Description: Options for rendering vector tiles. Valid only for `vt-polygon` and `vt-line` types. ,
Required: False ,
}
{
tilejsonKey:
{
Description: Asset key containing the TileJSON URL. ,
Required: True ,
}
string ,
sourceLayer:
{
Description: Name of the source layer in the vector tiles. ,
Required: True ,
}
string ,
fillColor:
{
Description: Fill color for polygon features. ,
Required: False ,
}
string ,
strokeColor:
{
Description: Stroke color for line features. ,
Required: False ,
}
string ,
strokeWidth:
{
Description: Width of line strokes in pixels. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: MapBox GL filter expression to filter features. ,
Required: False ,
}
[
string ,
]
,
}
,
minZoom:
{
Description: Minimum zoom level at which to display this layer. ,
Format: int32 ,
Required: False ,
}
integer ,
legend:
{
Description: Legend configuration for this render option. ,
Required: False ,
}
{
type:
{
Description: Legend type to make, one of: `continuous`, `classmap`, `interval` or `none` (note, `none` is a string literal). ,
Enum:
{
continuous: Continuous color ramp legend. ,
classmap: Classified map with discrete colors for classes. ,
interval: Interval-based legend with discrete ranges. ,
none: No legend. ,
}
,
Required: False ,
}
enum ,
labels:
{
Description: Text labels to display on the legend. ,
Required: False ,
}
[
string ,
]
,
trimStart:
{
Description: The number of items to trim from the start of the legend definition. Used if there are values important for rendering (e.g. nodata) that aren't desirable in the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
trimEnd:
{
Description: Number of items to trim from the end of the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleFactor:
{
Description: A factor to multiply interval legend labels by. Useful for scaled rasters whose colormap definitions map to unscaled values, effectively showing legend labels as scaled values. ,
Format: float ,
Required: False ,
}
number ,
}
,
conditions:
{
Description: A list of property/value conditions that must be in the active mosaic CQL for this render option to be enabled ,
Required: False ,
}
[
{
property:
{
Description: Property name to check in the active CQL filter. ,
Required: True ,
}
string ,
value:
{
Description: Value that the property must equal. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionRenderOptions_CreateOrReplace (new)
Description :  Update a render option for a given collection
Reference :  Link ¶

⚼ Request

PUT:  /stac/collections/{collectionId}/configurations/render-options/{renderOptionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
renderOptionId:
{
Description: Unique identifier for the render option. ,
Required: True ,
}
string ,
body:
{
Description: Render option configuration to be created or updated. ,
Required: True ,
}
{
id:
{
Description: Unique identifier for the render option. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the render option. ,
Required: True ,
}
string ,
description:
{
Description: A longer description of the render option that can be used to explain its content. ,
Required: False ,
}
string ,
type:
{
Description: The type of rendering to apply (raster or vector). ,
Enum:
{
raster-tile: Raster tile rendering type. ,
vt-polygon: Vector tile polygon rendering type. ,
vt-line: Vector tile line rendering type. ,
}
,
Required: False ,
}
enum ,
options:
{
Description: A URL query-string encoded string of TiTiler rendering options. Valid only for `raster-tile` types. See 'Query Parameters': https://developmentseed.org/titiler/endpoints/cog/#description ,
Required: False ,
}
string ,
vectorOptions:
{
Description: Options for rendering vector tiles. Valid only for `vt-polygon` and `vt-line` types. ,
Required: False ,
}
{
tilejsonKey:
{
Description: Asset key containing the TileJSON URL. ,
Required: True ,
}
string ,
sourceLayer:
{
Description: Name of the source layer in the vector tiles. ,
Required: True ,
}
string ,
fillColor:
{
Description: Fill color for polygon features. ,
Required: False ,
}
string ,
strokeColor:
{
Description: Stroke color for line features. ,
Required: False ,
}
string ,
strokeWidth:
{
Description: Width of line strokes in pixels. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: MapBox GL filter expression to filter features. ,
Required: False ,
}
[
string ,
]
,
}
,
minZoom:
{
Description: Minimum zoom level at which to display this layer. ,
Format: int32 ,
Required: False ,
}
integer ,
legend:
{
Description: Legend configuration for this render option. ,
Required: False ,
}
{
type:
{
Description: Legend type to make, one of: `continuous`, `classmap`, `interval` or `none` (note, `none` is a string literal). ,
Enum:
{
continuous: Continuous color ramp legend. ,
classmap: Classified map with discrete colors for classes. ,
interval: Interval-based legend with discrete ranges. ,
none: No legend. ,
}
,
Required: False ,
}
enum ,
labels:
{
Description: Text labels to display on the legend. ,
Required: False ,
}
[
string ,
]
,
trimStart:
{
Description: The number of items to trim from the start of the legend definition. Used if there are values important for rendering (e.g. nodata) that aren't desirable in the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
trimEnd:
{
Description: Number of items to trim from the end of the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleFactor:
{
Description: A factor to multiply interval legend labels by. Useful for scaled rasters whose colormap definitions map to unscaled values, effectively showing legend labels as scaled values. ,
Format: float ,
Required: False ,
}
number ,
}
,
conditions:
{
Description: A list of property/value conditions that must be in the active mosaic CQL for this render option to be enabled ,
Required: False ,
}
[
{
property:
{
Description: Property name to check in the active CQL filter. ,
Required: True ,
}
string ,
value:
{
Description: Value that the property must equal. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique identifier for the render option. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the render option. ,
Required: True ,
}
string ,
description:
{
Description: A longer description of the render option that can be used to explain its content. ,
Required: False ,
}
string ,
type:
{
Description: The type of rendering to apply (raster or vector). ,
Enum:
{
raster-tile: Raster tile rendering type. ,
vt-polygon: Vector tile polygon rendering type. ,
vt-line: Vector tile line rendering type. ,
}
,
Required: False ,
}
enum ,
options:
{
Description: A URL query-string encoded string of TiTiler rendering options. Valid only for `raster-tile` types. See 'Query Parameters': https://developmentseed.org/titiler/endpoints/cog/#description ,
Required: False ,
}
string ,
vectorOptions:
{
Description: Options for rendering vector tiles. Valid only for `vt-polygon` and `vt-line` types. ,
Required: False ,
}
{
tilejsonKey:
{
Description: Asset key containing the TileJSON URL. ,
Required: True ,
}
string ,
sourceLayer:
{
Description: Name of the source layer in the vector tiles. ,
Required: True ,
}
string ,
fillColor:
{
Description: Fill color for polygon features. ,
Required: False ,
}
string ,
strokeColor:
{
Description: Stroke color for line features. ,
Required: False ,
}
string ,
strokeWidth:
{
Description: Width of line strokes in pixels. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: MapBox GL filter expression to filter features. ,
Required: False ,
}
[
string ,
]
,
}
,
minZoom:
{
Description: Minimum zoom level at which to display this layer. ,
Format: int32 ,
Required: False ,
}
integer ,
legend:
{
Description: Legend configuration for this render option. ,
Required: False ,
}
{
type:
{
Description: Legend type to make, one of: `continuous`, `classmap`, `interval` or `none` (note, `none` is a string literal). ,
Enum:
{
continuous: Continuous color ramp legend. ,
classmap: Classified map with discrete colors for classes. ,
interval: Interval-based legend with discrete ranges. ,
none: No legend. ,
}
,
Required: False ,
}
enum ,
labels:
{
Description: Text labels to display on the legend. ,
Required: False ,
}
[
string ,
]
,
trimStart:
{
Description: The number of items to trim from the start of the legend definition. Used if there are values important for rendering (e.g. nodata) that aren't desirable in the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
trimEnd:
{
Description: Number of items to trim from the end of the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleFactor:
{
Description: A factor to multiply interval legend labels by. Useful for scaled rasters whose colormap definitions map to unscaled values, effectively showing legend labels as scaled values. ,
Format: float ,
Required: False ,
}
number ,
}
,
conditions:
{
Description: A list of property/value conditions that must be in the active mosaic CQL for this render option to be enabled ,
Required: False ,
}
[
{
property:
{
Description: Property name to check in the active CQL filter. ,
Required: True ,
}
string ,
value:
{
Description: Value that the property must equal. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (201)

{
id:
{
Description: Unique identifier for the render option. ,
Required: True ,
}
string ,
name:
{
Description: Short descriptive name for the render option. ,
Required: True ,
}
string ,
description:
{
Description: A longer description of the render option that can be used to explain its content. ,
Required: False ,
}
string ,
type:
{
Description: The type of rendering to apply (raster or vector). ,
Enum:
{
raster-tile: Raster tile rendering type. ,
vt-polygon: Vector tile polygon rendering type. ,
vt-line: Vector tile line rendering type. ,
}
,
Required: False ,
}
enum ,
options:
{
Description: A URL query-string encoded string of TiTiler rendering options. Valid only for `raster-tile` types. See 'Query Parameters': https://developmentseed.org/titiler/endpoints/cog/#description ,
Required: False ,
}
string ,
vectorOptions:
{
Description: Options for rendering vector tiles. Valid only for `vt-polygon` and `vt-line` types. ,
Required: False ,
}
{
tilejsonKey:
{
Description: Asset key containing the TileJSON URL. ,
Required: True ,
}
string ,
sourceLayer:
{
Description: Name of the source layer in the vector tiles. ,
Required: True ,
}
string ,
fillColor:
{
Description: Fill color for polygon features. ,
Required: False ,
}
string ,
strokeColor:
{
Description: Stroke color for line features. ,
Required: False ,
}
string ,
strokeWidth:
{
Description: Width of line strokes in pixels. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: MapBox GL filter expression to filter features. ,
Required: False ,
}
[
string ,
]
,
}
,
minZoom:
{
Description: Minimum zoom level at which to display this layer. ,
Format: int32 ,
Required: False ,
}
integer ,
legend:
{
Description: Legend configuration for this render option. ,
Required: False ,
}
{
type:
{
Description: Legend type to make, one of: `continuous`, `classmap`, `interval` or `none` (note, `none` is a string literal). ,
Enum:
{
continuous: Continuous color ramp legend. ,
classmap: Classified map with discrete colors for classes. ,
interval: Interval-based legend with discrete ranges. ,
none: No legend. ,
}
,
Required: False ,
}
enum ,
labels:
{
Description: Text labels to display on the legend. ,
Required: False ,
}
[
string ,
]
,
trimStart:
{
Description: The number of items to trim from the start of the legend definition. Used if there are values important for rendering (e.g. nodata) that aren't desirable in the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
trimEnd:
{
Description: Number of items to trim from the end of the legend. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleFactor:
{
Description: A factor to multiply interval legend labels by. Useful for scaled rasters whose colormap definitions map to unscaled values, effectively showing legend labels as scaled values. ,
Format: float ,
Required: False ,
}
number ,
}
,
conditions:
{
Description: A list of property/value conditions that must be in the active mosaic CQL for this render option to be enabled ,
Required: False ,
}
[
{
property:
{
Description: Property name to check in the active CQL filter. ,
Required: True ,
}
string ,
value:
{
Description: Value that the property must equal. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionRenderOptions_Delete (new)
Description :  Delete a render option for a given collection
Reference :  Link ¶

⚼ Request

DELETE:  /stac/collections/{collectionId}/configurations/render-options/{renderOptionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
renderOptionId:
{
Description: Unique identifier for the render option. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionTileSettings_GetAll (new)
Description :  Get the tile settings for a given collection
Reference :  Link ¶

⚼ Request

GET:  /stac/collections/{collectionId}/configurations/tile-settings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
minZoom:
{
Description: The minimum zoom level that can be requested for this collection. Provides a hard limit for the tile servers to ensure they don't get requests for low zoom levels, which would cause many files to be fetched and the tile servers to hang. ,
Format: int32 ,
Required: True ,
}
integer ,
maxItemsPerTile:
{
Description: Maximum number of items to include in a single tile. ,
Format: int32 ,
Required: True ,
}
integer ,
defaultLocation:
{
Description: Default map location when displaying this collection. ,
Required: False ,
}
{
zoom:
{
Description: Default zoom level for the map. ,
Format: int32 ,
Required: True ,
}
integer ,
coordinates:
{
Description: Default center coordinates [latitude, longitude] for the map. ,
Required: True ,
}
[
number ,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionTileSettings_Replace (new)
Description :  Update the tile settings for a given collection
Reference :  Link ¶

⚼ Request

PUT:  /stac/collections/{collectionId}/configurations/tile-settings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
body:
{
Description: Tile settings configuration to be updated. ,
Required: True ,
}
{
minZoom:
{
Description: The minimum zoom level that can be requested for this collection. Provides a hard limit for the tile servers to ensure they don't get requests for low zoom levels, which would cause many files to be fetched and the tile servers to hang. ,
Format: int32 ,
Required: True ,
}
integer ,
maxItemsPerTile:
{
Description: Maximum number of items to include in a single tile. ,
Format: int32 ,
Required: True ,
}
integer ,
defaultLocation:
{
Description: Default map location when displaying this collection. ,
Required: False ,
}
{
zoom:
{
Description: Default zoom level for the map. ,
Format: int32 ,
Required: True ,
}
integer ,
coordinates:
{
Description: Default center coordinates [latitude, longitude] for the map. ,
Required: True ,
}
[
number ,
]
,
}
,
}
,
}

⚐ Response (200)

{
minZoom:
{
Description: The minimum zoom level that can be requested for this collection. Provides a hard limit for the tile servers to ensure they don't get requests for low zoom levels, which would cause many files to be fetched and the tile servers to hang. ,
Format: int32 ,
Required: True ,
}
integer ,
maxItemsPerTile:
{
Description: Maximum number of items to include in a single tile. ,
Format: int32 ,
Required: True ,
}
integer ,
defaultLocation:
{
Description: Default map location when displaying this collection. ,
Required: False ,
}
{
zoom:
{
Description: Default zoom level for the map. ,
Format: int32 ,
Required: True ,
}
integer ,
coordinates:
{
Description: Default center coordinates [latitude, longitude] for the map. ,
Required: True ,
}
[
number ,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacItems_GetFeatures (new)
Description :  Fetch features of the feature collection with id `collectionId`. Every feature in a dataset belongs to a collection. A dataset may consist of multiple feature collections. A feature collection is often a collection of features of a similar type, based on a common schema.")
Reference :  Link ¶

⚼ Request

GET:  /stac/collections/{collectionId}/items
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
limit:
{
Description: The optional limit parameter recommends the number of items that should be present in the response document. If the limit parameter value is greater than advertised limit maximum, the server must return the maximum possible number of items, rather than responding with an error. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items must not be counted. Minimum = 1. Maximum = 10000. Default = 10. ,
Format: int64 ,
Required: False ,
}
integer ,
bbox:
{
Description: Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth): - Lower left corner, coordinate axis 1 - Lower left corner, coordinate axis 2 - Minimum value, coordinate axis 3 (optional) - Upper right corner, coordinate axis 1 - Upper right corner, coordinate axis 2 - Maximum value, coordinate axis 3 (optional) The coordinate reference system of the values is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84). For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box. If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries. ,
Required: False ,
}
array ,
datetime:
{
Description: Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples: - A date-time: "2018-02-12T23:20:50Z" - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z" Only features that have a temporal property that intersects the value of `datetime` are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: GeoJSON FeatureCollection type. ,
Enum:
{
FeatureCollection: Standard GeoJSON FeatureCollection type. ,
}
,
Required: True ,
}
enum ,
features:
{
Description: Array of STAC Items in the collection. ,
Required: True ,
}
[
{
type:
{
Description: GeoJSON type identifier for Feature ,
Enum:
{
Feature: Standard GeoJSON Feature type identifier ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: Geometry object defining the feature's shape ,
Required: True ,
}
string ,
bbox:
{
Description: Bounding box coordinates for the feature ,
Required: True ,
}
[
number ,
]
,
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the feature ,
Required: True ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
collection:
{
Description: ID of the STAC collection this item belongs to. ,
Required: False ,
}
string ,
properties:
{
Description: Attributes associated with the feature ,
Required: True ,
}
{
platform:
{
Description: Platform that acquired the data. ,
Required: False ,
}
string ,
instruments:
{
Description: Instruments that acquired the data. ,
Required: False ,
}
[
string ,
]
,
constellation:
{
Description: Constellation of satellites that acquired the data. ,
Required: False ,
}
string ,
mission:
{
Description: Mission associated with the data. ,
Required: False ,
}
string ,
providers:
{
Description: Organizations or individuals who provide the data. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provider organization or individual. ,
Required: True ,
}
string ,
description:
{
Description: Description of the provider. ,
Required: False ,
}
string ,
roles:
{
Description: Roles played by the provider (e.g., producer, processor, host). ,
Required: False ,
}
[
string ,
]
,
url:
{
Description: URL to the provider's website. ,
Required: False ,
}
string ,
}
,
]
,
gsd:
{
Description: Ground sample distance in meters. ,
Format: float ,
Required: False ,
}
number ,
created:
{
Description: Creation timestamp of the data. ,
Format: date-time ,
Required: False ,
}
string ,
updated:
{
Description: Last update timestamp of the data. ,
Format: date-time ,
Required: False ,
}
string ,
title:
{
Description: Human-readable title for the item. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the item. ,
Required: False ,
}
string ,
datetime:
{
Description: Datetime the asset represents in RFC 3339 format. ,
Required: True ,
}
string ,
start_datetime:
{
Description: Start time of the item observation period. ,
Format: date-time ,
Required: False ,
}
string ,
end_datetime:
{
Description: End time of the item observation period. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
links:
{
Description: Links to related resources and endpoints. ,
Required: True ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
assets:
{
Description: Assets ,
Required: True ,
}
object ,
_msft:ts:
{
Description: MSFT Timestamp ,
Required: False ,
}
string ,
_msft:etag:
{
Description: MSFT ETag ,
Required: False ,
}
string ,
}
,
]
,
bbox:
{
Description: Bounding box of all items in format [west, south, east, north]. ,
Required: False ,
}
[
number ,
]
,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
links:
{
Description: Links to related resources and endpoints. ,
Required: False ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
context:
{
Description: Context information for the search response. ,
Required: False ,
}
{
returned:
{
Description: Number of items returned in the response. ,
Format: int32 ,
Required: True ,
}
integer ,
limit:
{
Description: Maximum number of items requested. ,
Format: int32 ,
Required: False ,
}
integer ,
matched:
{
Description: Total number of items matching the query. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacItems_Create (new)
Description :  Create a new STAC item or a set of items in a collection
Reference :  Link ¶

⚼ Request

POST:  /stac/collections/{collectionId}/items
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
body:
{
Description: STAC Item or ItemCollection Represents a STAC Item or ItemCollection as defined by the STAC 1.0.0 standard. - **Item**: A GeoJSON Feature that represents a single spatiotemporal asset. It includes metadata such as geometry, datetime, and links to related assets. Example: A satellite image with its metadata. - **ItemCollection**: A GeoJSON FeatureCollection that contains multiple Items. It is used to group multiple related Items together, such as a collection of satellite images. This union allows the request body to accept either a single Item or a collection of Items. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: Url used to monitor the background operation ,
}
string ,
operation-location:
{
Description: Url used to monitor the background operation ,
}
string ,
}
,
$schema:
{
Description: Spatio geo-catalog operation ,
}
{
id:
{
Description: Operation id ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Operation status ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Operation type ,
Required: True ,
}
string ,
creationTime:
{
Description: The UTC time at which the operation was created ,
Format: date-time ,
Required: True ,
}
string ,
collectionId:
{
Description: Collection ID ,
Required: False ,
}
string ,
statusHistory:
{
Description: The history of the operation status in time ,
Required: True ,
}
[
{
timestamp:
{
Description: The UTC time at which the status was set ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
errorCode:
{
Description: If the status is failed, the error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: If the status is failed, the error message ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The UTC time at which the operation was started ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The UTC time at which the operation finished its execution ,
Format: date-time ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information elements about the particular operation type ,
Required: False ,
}
object ,
error:
{
Description: Error information ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacItems_Get (new)
Description :  Fetch a single STAC Item
Reference :  Link ¶

⚼ Request

GET:  /stac/collections/{collectionId}/items/{itemId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: GeoJSON type identifier for Feature ,
Enum:
{
Feature: Standard GeoJSON Feature type identifier ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: Geometry object defining the feature's shape ,
Required: True ,
}
string ,
bbox:
{
Description: Bounding box coordinates for the feature ,
Required: True ,
}
[
number ,
]
,
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the feature ,
Required: True ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
collection:
{
Description: ID of the STAC collection this item belongs to. ,
Required: False ,
}
string ,
properties:
{
Description: Attributes associated with the feature ,
Required: True ,
}
{
platform:
{
Description: Platform that acquired the data. ,
Required: False ,
}
string ,
instruments:
{
Description: Instruments that acquired the data. ,
Required: False ,
}
[
string ,
]
,
constellation:
{
Description: Constellation of satellites that acquired the data. ,
Required: False ,
}
string ,
mission:
{
Description: Mission associated with the data. ,
Required: False ,
}
string ,
providers:
{
Description: Organizations or individuals who provide the data. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provider organization or individual. ,
Required: True ,
}
string ,
description:
{
Description: Description of the provider. ,
Required: False ,
}
string ,
roles:
{
Description: Roles played by the provider (e.g., producer, processor, host). ,
Required: False ,
}
[
string ,
]
,
url:
{
Description: URL to the provider's website. ,
Required: False ,
}
string ,
}
,
]
,
gsd:
{
Description: Ground sample distance in meters. ,
Format: float ,
Required: False ,
}
number ,
created:
{
Description: Creation timestamp of the data. ,
Format: date-time ,
Required: False ,
}
string ,
updated:
{
Description: Last update timestamp of the data. ,
Format: date-time ,
Required: False ,
}
string ,
title:
{
Description: Human-readable title for the item. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the item. ,
Required: False ,
}
string ,
datetime:
{
Description: Datetime the asset represents in RFC 3339 format. ,
Required: True ,
}
string ,
start_datetime:
{
Description: Start time of the item observation period. ,
Format: date-time ,
Required: False ,
}
string ,
end_datetime:
{
Description: End time of the item observation period. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
links:
{
Description: Links to related resources and endpoints. ,
Required: True ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
assets:
{
Description: Assets ,
Required: True ,
}
object ,
_msft:ts:
{
Description: MSFT Timestamp ,
Required: False ,
}
string ,
_msft:etag:
{
Description: MSFT ETag ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacItems_CreateOrReplace (new)
Description :  Create or replace a STAC item in a collection
Reference :  Link ¶

⚼ Request

PUT:  /stac/collections/{collectionId}/items/{itemId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item id ,
Required: True ,
}
string ,
body:
{
Description: STAC Item ,
Required: True ,
}
{
type:
{
Description: GeoJSON type identifier for Feature ,
Enum:
{
Feature: Standard GeoJSON Feature type identifier ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: Geometry object defining the feature's shape ,
Required: True ,
}
string ,
bbox:
{
Description: Bounding box coordinates for the feature ,
Required: True ,
}
[
number ,
]
,
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the feature ,
Required: True ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
collection:
{
Description: ID of the STAC collection this item belongs to. ,
Required: False ,
}
string ,
properties:
{
Description: Attributes associated with the feature ,
Required: True ,
}
{
platform:
{
Description: Platform that acquired the data. ,
Required: False ,
}
string ,
instruments:
{
Description: Instruments that acquired the data. ,
Required: False ,
}
[
string ,
]
,
constellation:
{
Description: Constellation of satellites that acquired the data. ,
Required: False ,
}
string ,
mission:
{
Description: Mission associated with the data. ,
Required: False ,
}
string ,
providers:
{
Description: Organizations or individuals who provide the data. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provider organization or individual. ,
Required: True ,
}
string ,
description:
{
Description: Description of the provider. ,
Required: False ,
}
string ,
roles:
{
Description: Roles played by the provider (e.g., producer, processor, host). ,
Required: False ,
}
[
string ,
]
,
url:
{
Description: URL to the provider's website. ,
Required: False ,
}
string ,
}
,
]
,
gsd:
{
Description: Ground sample distance in meters. ,
Format: float ,
Required: False ,
}
number ,
created:
{
Description: Creation timestamp of the data. ,
Format: date-time ,
Required: False ,
}
string ,
updated:
{
Description: Last update timestamp of the data. ,
Format: date-time ,
Required: False ,
}
string ,
title:
{
Description: Human-readable title for the item. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the item. ,
Required: False ,
}
string ,
datetime:
{
Description: Datetime the asset represents in RFC 3339 format. ,
Required: True ,
}
string ,
start_datetime:
{
Description: Start time of the item observation period. ,
Format: date-time ,
Required: False ,
}
string ,
end_datetime:
{
Description: End time of the item observation period. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
links:
{
Description: Links to related resources and endpoints. ,
Required: True ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
assets:
{
Description: Assets ,
Required: True ,
}
object ,
_msft:ts:
{
Description: MSFT Timestamp ,
Required: False ,
}
string ,
_msft:etag:
{
Description: MSFT ETag ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: Url used to monitor the background operation ,
}
string ,
operation-location:
{
Description: Url used to monitor the background operation ,
}
string ,
}
,
$schema:
{
Description: Spatio geo-catalog operation ,
}
{
id:
{
Description: Operation id ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Operation status ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Operation type ,
Required: True ,
}
string ,
creationTime:
{
Description: The UTC time at which the operation was created ,
Format: date-time ,
Required: True ,
}
string ,
collectionId:
{
Description: Collection ID ,
Required: False ,
}
string ,
statusHistory:
{
Description: The history of the operation status in time ,
Required: True ,
}
[
{
timestamp:
{
Description: The UTC time at which the status was set ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
errorCode:
{
Description: If the status is failed, the error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: If the status is failed, the error message ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The UTC time at which the operation was started ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The UTC time at which the operation finished its execution ,
Format: date-time ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information elements about the particular operation type ,
Required: False ,
}
object ,
error:
{
Description: Error information ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacItems_Update (new)
Description :  Update a STAC item in a collection
Reference :  Link ¶

⚼ Request

PATCH:  /stac/collections/{collectionId}/items/{itemId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item id ,
Required: True ,
}
string ,
body:
{
Description: STAC Item ,
Required: True ,
}
{
type:
{
Description: GeoJSON type identifier for Feature ,
Enum:
{
Feature: Standard GeoJSON Feature type identifier ,
}
,
Required: False ,
}
enum ,
geometry:
{
Description: Geometry object defining the feature's shape ,
Required: False ,
}
string ,
bbox:
{
Description: Bounding box coordinates for the feature ,
Required: False ,
}
[
number ,
]
,
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the feature ,
Required: False ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
collection:
{
Description: ID of the STAC collection this item belongs to. ,
Required: False ,
}
string ,
properties:
{
Description: Attributes associated with the feature ,
Required: False ,
}
{
platform:
{
Description: Platform that acquired the data. ,
Required: False ,
}
string ,
instruments:
{
Description: Instruments that acquired the data. ,
Required: False ,
}
[
string ,
]
,
constellation:
{
Description: Constellation of satellites that acquired the data. ,
Required: False ,
}
string ,
mission:
{
Description: Mission associated with the data. ,
Required: False ,
}
string ,
providers:
{
Description: Organizations or individuals who provide the data. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provider organization or individual. ,
Required: True ,
}
string ,
description:
{
Description: Description of the provider. ,
Required: False ,
}
string ,
roles:
{
Description: Roles played by the provider (e.g., producer, processor, host). ,
Required: False ,
}
[
string ,
]
,
url:
{
Description: URL to the provider's website. ,
Required: False ,
}
string ,
}
,
]
,
gsd:
{
Description: Ground sample distance in meters. ,
Format: float ,
Required: False ,
}
number ,
created:
{
Description: Creation timestamp of the data. ,
Format: date-time ,
Required: False ,
}
string ,
updated:
{
Description: Last update timestamp of the data. ,
Format: date-time ,
Required: False ,
}
string ,
title:
{
Description: Human-readable title for the item. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the item. ,
Required: False ,
}
string ,
datetime:
{
Description: Datetime the asset represents in RFC 3339 format. ,
Required: False ,
}
string ,
start_datetime:
{
Description: Start time of the item observation period. ,
Format: date-time ,
Required: False ,
}
string ,
end_datetime:
{
Description: End time of the item observation period. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
links:
{
Description: Links to related resources and endpoints. ,
Required: False ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
assets:
{
Description: Assets ,
Required: False ,
}
object ,
_msft:ts:
{
Description: MSFT Timestamp ,
Required: False ,
}
string ,
_msft:etag:
{
Description: MSFT ETag ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: Url used to monitor the background operation ,
}
string ,
operation-location:
{
Description: Url used to monitor the background operation ,
}
string ,
}
,
$schema:
{
Description: Spatio geo-catalog operation ,
}
{
id:
{
Description: Operation id ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Operation status ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Operation type ,
Required: True ,
}
string ,
creationTime:
{
Description: The UTC time at which the operation was created ,
Format: date-time ,
Required: True ,
}
string ,
collectionId:
{
Description: Collection ID ,
Required: False ,
}
string ,
statusHistory:
{
Description: The history of the operation status in time ,
Required: True ,
}
[
{
timestamp:
{
Description: The UTC time at which the status was set ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
errorCode:
{
Description: If the status is failed, the error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: If the status is failed, the error message ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The UTC time at which the operation was started ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The UTC time at which the operation finished its execution ,
Format: date-time ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information elements about the particular operation type ,
Required: False ,
}
object ,
error:
{
Description: Error information ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacItems_Delete (new)
Description :  Delete a STAC item from a collection
Reference :  Link ¶

⚼ Request

DELETE:  /stac/collections/{collectionId}/items/{itemId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Catalog collection id ,
Required: True ,
}
string ,
itemId:
{
Description: STAC Item id ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: Url used to monitor the background operation ,
}
string ,
operation-location:
{
Description: Url used to monitor the background operation ,
}
string ,
}
,
$schema:
{
Description: Spatio geo-catalog operation ,
}
{
id:
{
Description: Operation id ,
Format: uuid ,
Required: True ,
}
string ,
status:
{
Description: Operation status ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Operation type ,
Required: True ,
}
string ,
creationTime:
{
Description: The UTC time at which the operation was created ,
Format: date-time ,
Required: True ,
}
string ,
collectionId:
{
Description: Collection ID ,
Required: False ,
}
string ,
statusHistory:
{
Description: The history of the operation status in time ,
Required: True ,
}
[
{
timestamp:
{
Description: The UTC time at which the status was set ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
Pending: Operation accepted and ready to be run ,
Running: Operation is running ,
Succeeded: Operation has already finished its execution ,
Canceled: Operation canceled by the user ,
Canceling: Operation is being canceling ,
Failed: Operation failed ,
}
,
Required: True ,
}
enum ,
errorCode:
{
Description: If the status is failed, the error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: If the status is failed, the error message ,
Required: False ,
}
string ,
}
,
]
,
startTime:
{
Description: The UTC time at which the operation was started ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The UTC time at which the operation finished its execution ,
Format: date-time ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information elements about the particular operation type ,
Required: False ,
}
object ,
error:
{
Description: Error information ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacQueryables_GetAllByCollection (new)
Description :  Endpoint.
Reference :  Link ¶

⚼ Request

GET:  /stac/collections/{collectionId}/queryables
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Collection ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the queryable field. ,
Required: True ,
}
string ,
definition:
{
Description: Metadata for the queryable field. ,
Required: True ,
}
{
create_index:
{
Description: Whether to create a database index for this property. ,
Required: False ,
}
boolean ,
data_type:
{
Description: Data type of the queryable property. ,
Enum:
{
string: Character strings. Example: 'This is a literal string.' ,
number: Numbers including integers and floating point values. Examples: -100, 3.14159 ,
boolean: Booleans. Examples: true, false ,
timestamp: An instant with a granularity of a second or smaller. Example (JSON): { "timestamp": "1969-07-20T20:17:40Z" } ,
date: An instant with a granularity of a day. Example (JSON): { "date": "1969-07-20" } ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description ,
Required: False ,
}
string ,
}
,
create_index:
{
Description: Whether to create a database index for this field. ,
Required: False ,
}
boolean ,
data_type:
{
Description: Data type of the queryable field. ,
Enum:
{
string: Character strings. Example: 'This is a literal string.' ,
number: Numbers including integers and floating point values. Examples: -100, 3.14159 ,
boolean: Booleans. Examples: true, false ,
timestamp: An instant with a granularity of a second or smaller. Example (JSON): { "timestamp": "1969-07-20T20:17:40Z" } ,
date: An instant with a granularity of a day. Example (JSON): { "date": "1969-07-20" } ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacQueryables_Create (new)
Description :  Set queryables for a collection given a list of queryable definitions
Reference :  Link ¶

⚼ Request

POST:  /stac/collections/{collectionId}/queryables
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
body:
{
Description: Request queryable definition body ,
Required: True ,
}
{
name:
{
Description: Name of the queryable field. ,
Required: True ,
}
string ,
definition:
{
Description: Metadata for the queryable field. ,
Required: True ,
}
{
create_index:
{
Description: Whether to create a database index for this property. ,
Required: False ,
}
boolean ,
data_type:
{
Description: Data type of the queryable property. ,
Enum:
{
string: Character strings. Example: 'This is a literal string.' ,
number: Numbers including integers and floating point values. Examples: -100, 3.14159 ,
boolean: Booleans. Examples: true, false ,
timestamp: An instant with a granularity of a second or smaller. Example (JSON): { "timestamp": "1969-07-20T20:17:40Z" } ,
date: An instant with a granularity of a day. Example (JSON): { "date": "1969-07-20" } ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description ,
Required: False ,
}
string ,
}
,
create_index:
{
Description: Whether to create a database index for this field. ,
Required: False ,
}
boolean ,
data_type:
{
Description: Data type of the queryable field. ,
Enum:
{
string: Character strings. Example: 'This is a literal string.' ,
number: Numbers including integers and floating point values. Examples: -100, 3.14159 ,
boolean: Booleans. Examples: true, false ,
timestamp: An instant with a granularity of a second or smaller. Example (JSON): { "timestamp": "1969-07-20T20:17:40Z" } ,
date: An instant with a granularity of a day. Example (JSON): { "date": "1969-07-20" } ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
name:
{
Description: Name of the queryable field. ,
Required: True ,
}
string ,
definition:
{
Description: Metadata for the queryable field. ,
Required: True ,
}
{
create_index:
{
Description: Whether to create a database index for this property. ,
Required: False ,
}
boolean ,
data_type:
{
Description: Data type of the queryable property. ,
Enum:
{
string: Character strings. Example: 'This is a literal string.' ,
number: Numbers including integers and floating point values. Examples: -100, 3.14159 ,
boolean: Booleans. Examples: true, false ,
timestamp: An instant with a granularity of a second or smaller. Example (JSON): { "timestamp": "1969-07-20T20:17:40Z" } ,
date: An instant with a granularity of a day. Example (JSON): { "date": "1969-07-20" } ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description ,
Required: False ,
}
string ,
}
,
create_index:
{
Description: Whether to create a database index for this field. ,
Required: False ,
}
boolean ,
data_type:
{
Description: Data type of the queryable field. ,
Enum:
{
string: Character strings. Example: 'This is a literal string.' ,
number: Numbers including integers and floating point values. Examples: -100, 3.14159 ,
boolean: Booleans. Examples: true, false ,
timestamp: An instant with a granularity of a second or smaller. Example (JSON): { "timestamp": "1969-07-20T20:17:40Z" } ,
date: An instant with a granularity of a day. Example (JSON): { "date": "1969-07-20" } ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacQueryables_CreateOrReplace (new)
Description :  Updates a queryable given a queryable definition and corresponding collection id.
Reference :  Link ¶

⚼ Request

PUT:  /stac/collections/{collectionId}/queryables/{queryableName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
queryableName:
{
Description: Name of the queryable property to operate on. ,
Required: True ,
}
string ,
body:
{
Description: Request queryable definition body ,
Required: True ,
}
{
name:
{
Description: Name of the queryable field. ,
Required: True ,
}
string ,
definition:
{
Description: Metadata for the queryable field. ,
Required: True ,
}
{
create_index:
{
Description: Whether to create a database index for this property. ,
Required: False ,
}
boolean ,
data_type:
{
Description: Data type of the queryable property. ,
Enum:
{
string: Character strings. Example: 'This is a literal string.' ,
number: Numbers including integers and floating point values. Examples: -100, 3.14159 ,
boolean: Booleans. Examples: true, false ,
timestamp: An instant with a granularity of a second or smaller. Example (JSON): { "timestamp": "1969-07-20T20:17:40Z" } ,
date: An instant with a granularity of a day. Example (JSON): { "date": "1969-07-20" } ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description ,
Required: False ,
}
string ,
}
,
create_index:
{
Description: Whether to create a database index for this field. ,
Required: False ,
}
boolean ,
data_type:
{
Description: Data type of the queryable field. ,
Enum:
{
string: Character strings. Example: 'This is a literal string.' ,
number: Numbers including integers and floating point values. Examples: -100, 3.14159 ,
boolean: Booleans. Examples: true, false ,
timestamp: An instant with a granularity of a second or smaller. Example (JSON): { "timestamp": "1969-07-20T20:17:40Z" } ,
date: An instant with a granularity of a day. Example (JSON): { "date": "1969-07-20" } ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
name:
{
Description: Name of the queryable field. ,
Required: True ,
}
string ,
definition:
{
Description: Metadata for the queryable field. ,
Required: True ,
}
{
create_index:
{
Description: Whether to create a database index for this property. ,
Required: False ,
}
boolean ,
data_type:
{
Description: Data type of the queryable property. ,
Enum:
{
string: Character strings. Example: 'This is a literal string.' ,
number: Numbers including integers and floating point values. Examples: -100, 3.14159 ,
boolean: Booleans. Examples: true, false ,
timestamp: An instant with a granularity of a second or smaller. Example (JSON): { "timestamp": "1969-07-20T20:17:40Z" } ,
date: An instant with a granularity of a day. Example (JSON): { "date": "1969-07-20" } ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description ,
Required: False ,
}
string ,
}
,
create_index:
{
Description: Whether to create a database index for this field. ,
Required: False ,
}
boolean ,
data_type:
{
Description: Data type of the queryable field. ,
Enum:
{
string: Character strings. Example: 'This is a literal string.' ,
number: Numbers including integers and floating point values. Examples: -100, 3.14159 ,
boolean: Booleans. Examples: true, false ,
timestamp: An instant with a granularity of a second or smaller. Example (JSON): { "timestamp": "1969-07-20T20:17:40Z" } ,
date: An instant with a granularity of a day. Example (JSON): { "date": "1969-07-20" } ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (201)

{
name:
{
Description: Name of the queryable field. ,
Required: True ,
}
string ,
definition:
{
Description: Metadata for the queryable field. ,
Required: True ,
}
{
create_index:
{
Description: Whether to create a database index for this property. ,
Required: False ,
}
boolean ,
data_type:
{
Description: Data type of the queryable property. ,
Enum:
{
string: Character strings. Example: 'This is a literal string.' ,
number: Numbers including integers and floating point values. Examples: -100, 3.14159 ,
boolean: Booleans. Examples: true, false ,
timestamp: An instant with a granularity of a second or smaller. Example (JSON): { "timestamp": "1969-07-20T20:17:40Z" } ,
date: An instant with a granularity of a day. Example (JSON): { "date": "1969-07-20" } ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description ,
Required: False ,
}
string ,
}
,
create_index:
{
Description: Whether to create a database index for this field. ,
Required: False ,
}
boolean ,
data_type:
{
Description: Data type of the queryable field. ,
Enum:
{
string: Character strings. Example: 'This is a literal string.' ,
number: Numbers including integers and floating point values. Examples: -100, 3.14159 ,
boolean: Booleans. Examples: true, false ,
timestamp: An instant with a granularity of a second or smaller. Example (JSON): { "timestamp": "1969-07-20T20:17:40Z" } ,
date: An instant with a granularity of a day. Example (JSON): { "date": "1969-07-20" } ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacQueryables_Delete (new)
Description :  Delete queryables by name for specified collection.
Reference :  Link ¶

⚼ Request

DELETE:  /stac/collections/{collectionId}/queryables/{queryableName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: Unique identifier for the STAC collection. ,
Required: True ,
}
string ,
queryableName:
{
Description: Name of the queryable property to operate on. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacCollectionThumbnails_Get (new)
Description :  Get thumbnail for given collection. Args: request: The incoming request. collection_id: The ID of the collection to retrieve assets for. Returns: thumbnail image
Reference :  Link ¶

⚼ Request

GET:  /stac/collections/{collectionId}/thumbnail
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collectionId:
{
Description: STAC Collection ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacConformanceClass_Get (new)
Description :  Endpoint.
Reference :  Link ¶

⚼ Request

GET:  /stac/conformance
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
conformsTo:
{
Description: List of OGC API conformance classes implemented by this API. ,
Required: True ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacQueryables_GetAll (new)
Description :  Endpoint.
Reference :  Link ¶

⚼ Request

GET:  /stac/queryables
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the queryable field. ,
Required: True ,
}
string ,
definition:
{
Description: Metadata for the queryable field. ,
Required: True ,
}
{
create_index:
{
Description: Whether to create a database index for this property. ,
Required: False ,
}
boolean ,
data_type:
{
Description: Data type of the queryable property. ,
Enum:
{
string: Character strings. Example: 'This is a literal string.' ,
number: Numbers including integers and floating point values. Examples: -100, 3.14159 ,
boolean: Booleans. Examples: true, false ,
timestamp: An instant with a granularity of a second or smaller. Example (JSON): { "timestamp": "1969-07-20T20:17:40Z" } ,
date: An instant with a granularity of a day. Example (JSON): { "date": "1969-07-20" } ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description ,
Required: False ,
}
string ,
}
,
create_index:
{
Description: Whether to create a database index for this field. ,
Required: False ,
}
boolean ,
data_type:
{
Description: Data type of the queryable field. ,
Enum:
{
string: Character strings. Example: 'This is a literal string.' ,
number: Numbers including integers and floating point values. Examples: -100, 3.14159 ,
boolean: Booleans. Examples: true, false ,
timestamp: An instant with a granularity of a second or smaller. Example (JSON): { "timestamp": "1969-07-20T20:17:40Z" } ,
date: An instant with a granularity of a day. Example (JSON): { "date": "1969-07-20" } ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacSearchOperations_Get (new)
Description :  Endpoint.
Reference :  Link ¶

⚼ Request

GET:  /stac/search
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
collections:
{
Description: List of Collection IDs to include in the search. Only items in these collections will be searched. ,
Required: False ,
}
string ,
ids:
{
Description: Array of Item IDs to return specific items. ,
Required: False ,
}
string ,
bbox:
{
Description: Bounding box for spatial filtering in format [west, south, east, north]. ,
Required: False ,
}
array ,
intersects:
{
Description: GeoJSON geometry for spatial filtering. ,
Required: False ,
}
string ,
datetime:
{
Description: Temporal filter in RFC 3339 format, can be a single time or range. ,
Required: False ,
}
string ,
limit:
{
Description: Maximum number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
sign:
{
Description: Whether to sign asset URLs in the response. ,
Required: False ,
}
string ,
duration:
{
Description: URL signature duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
query:
{
Description: Property-based filtering expressed as a JSON object. ,
Required: False ,
}
string ,
sortby:
{
Description: Sort order for items. Format is property name prefixed with "+" for ascending or "-" for descending. ,
Required: False ,
}
string ,
fields:
{
Description: Determines which fields to include in the response. Format is comma-separated field names with "-" prefix to exclude fields. ,
Required: False ,
}
string ,
filter:
{
Description: CQL filter expression for advanced filtering of items. ,
Required: False ,
}
string ,
token:
{
Description: Pagination token for fetching the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: GeoJSON FeatureCollection type. ,
Enum:
{
FeatureCollection: Standard GeoJSON FeatureCollection type. ,
}
,
Required: True ,
}
enum ,
features:
{
Description: Array of STAC Items in the collection. ,
Required: True ,
}
[
{
type:
{
Description: GeoJSON type identifier for Feature ,
Enum:
{
Feature: Standard GeoJSON Feature type identifier ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: Geometry object defining the feature's shape ,
Required: True ,
}
string ,
bbox:
{
Description: Bounding box coordinates for the feature ,
Required: True ,
}
[
number ,
]
,
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the feature ,
Required: True ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
collection:
{
Description: ID of the STAC collection this item belongs to. ,
Required: False ,
}
string ,
properties:
{
Description: Attributes associated with the feature ,
Required: True ,
}
{
platform:
{
Description: Platform that acquired the data. ,
Required: False ,
}
string ,
instruments:
{
Description: Instruments that acquired the data. ,
Required: False ,
}
[
string ,
]
,
constellation:
{
Description: Constellation of satellites that acquired the data. ,
Required: False ,
}
string ,
mission:
{
Description: Mission associated with the data. ,
Required: False ,
}
string ,
providers:
{
Description: Organizations or individuals who provide the data. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provider organization or individual. ,
Required: True ,
}
string ,
description:
{
Description: Description of the provider. ,
Required: False ,
}
string ,
roles:
{
Description: Roles played by the provider (e.g., producer, processor, host). ,
Required: False ,
}
[
string ,
]
,
url:
{
Description: URL to the provider's website. ,
Required: False ,
}
string ,
}
,
]
,
gsd:
{
Description: Ground sample distance in meters. ,
Format: float ,
Required: False ,
}
number ,
created:
{
Description: Creation timestamp of the data. ,
Format: date-time ,
Required: False ,
}
string ,
updated:
{
Description: Last update timestamp of the data. ,
Format: date-time ,
Required: False ,
}
string ,
title:
{
Description: Human-readable title for the item. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the item. ,
Required: False ,
}
string ,
datetime:
{
Description: Datetime the asset represents in RFC 3339 format. ,
Required: True ,
}
string ,
start_datetime:
{
Description: Start time of the item observation period. ,
Format: date-time ,
Required: False ,
}
string ,
end_datetime:
{
Description: End time of the item observation period. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
links:
{
Description: Links to related resources and endpoints. ,
Required: True ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
assets:
{
Description: Assets ,
Required: True ,
}
object ,
_msft:ts:
{
Description: MSFT Timestamp ,
Required: False ,
}
string ,
_msft:etag:
{
Description: MSFT ETag ,
Required: False ,
}
string ,
}
,
]
,
bbox:
{
Description: Bounding box of all items in format [west, south, east, north]. ,
Required: False ,
}
[
number ,
]
,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
links:
{
Description: Links to related resources and endpoints. ,
Required: False ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
context:
{
Description: Context information for the search response. ,
Required: False ,
}
{
returned:
{
Description: Number of items returned in the response. ,
Format: int32 ,
Required: True ,
}
integer ,
limit:
{
Description: Maximum number of items requested. ,
Format: int32 ,
Required: False ,
}
integer ,
matched:
{
Description: Total number of items matching the query. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StacSearchOperations_Create (new)
Description :  Endpoint.
Reference :  Link ¶

⚼ Request

POST:  /stac/search
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body ,
Required: True ,
}
{
collections:
{
Description: List of collection IDs to search within. ,
Required: False ,
}
[
string ,
]
,
ids:
{
Description: List of specific item IDs to return. ,
Required: False ,
}
[
string ,
]
,
bbox:
{
Description: Bounding box for spatial filtering in format [west, south, east, north]. ,
Required: False ,
}
[
number ,
]
,
intersects:
{
Description: GeoJSON geometry for spatial filtering. ,
Required: False ,
}
string ,
datetime:
{
Description: Temporal filter in RFC 3339 format, can be a single time or range. ,
Required: False ,
}
string ,
limit:
{
Description: Maximum number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
conf:
{
Description: Conf ,
Required: False ,
}
object ,
sign:
{
Description: Whether to sign asset URLs in the response. ,
Enum:
{
true: Sign asset URLs in the response. ,
false: Do not sign asset URLs in the response. ,
}
,
Required: False ,
}
enum ,
duration:
{
Description: URL signature duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
query:
{
Description: https://github.com/stac-api-extensions/query Query ,
Required: False ,
}
object ,
sortby:
{
Description: https://github.com/stac-api-extensions/sort Sort criteria for the search results. ,
Required: False ,
}
[
{
field:
{
Description: The field name to sort by. ,
Required: True ,
}
string ,
direction:
{
Description: The sort direction (ascending or descending). ,
Enum:
{
asc: Sort results in ascending order. ,
desc: Sort results in descending order. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
fields:
{
Description: https://github.com/stac-api-extensions/fields Specifies which fields to include or exclude in the response. ,
Required: False ,
}
[
{
include:
{
Description: Array of field names to include in the response. ,
Required: False ,
}
[
string ,
]
,
exclude:
{
Description: Array of field names to exclude from the response. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
filter:
{
Description: https://github.com/stac-api-extensions/filter Filter ,
Required: False ,
}
object ,
filter-crs:
{
Description: Coordinate reference system for the filter. ,
Required: False ,
}
string ,
filter-lang:
{
Description: Filter language to use for the filter expression. ,
Enum:
{
cql-json: Common Query Language in JSON format. ,
cql2-json: Common Query Language 2 in JSON format ,
cql2-text: Common Query Language 2 in text format. ,
}
,
Required: False ,
}
enum ,
token:
{
Description: Pagination token for fetching the next set of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: GeoJSON FeatureCollection type. ,
Enum:
{
FeatureCollection: Standard GeoJSON FeatureCollection type. ,
}
,
Required: True ,
}
enum ,
features:
{
Description: Array of STAC Items in the collection. ,
Required: True ,
}
[
{
type:
{
Description: GeoJSON type identifier for Feature ,
Enum:
{
Feature: Standard GeoJSON Feature type identifier ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: Geometry object defining the feature's shape ,
Required: True ,
}
string ,
bbox:
{
Description: Bounding box coordinates for the feature ,
Required: True ,
}
[
number ,
]
,
msft:_created:
{
Description: MSFT Created ,
Required: False ,
}
string ,
msft:_updated:
{
Description: MSFT Updated ,
Required: False ,
}
string ,
msft:short_description:
{
Description: MSFT Short Description ,
Required: False ,
}
string ,
stac_extensions:
{
Description: URLs to STAC extensions implemented by this STAC resource. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique identifier for the feature ,
Required: True ,
}
string ,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
collection:
{
Description: ID of the STAC collection this item belongs to. ,
Required: False ,
}
string ,
properties:
{
Description: Attributes associated with the feature ,
Required: True ,
}
{
platform:
{
Description: Platform that acquired the data. ,
Required: False ,
}
string ,
instruments:
{
Description: Instruments that acquired the data. ,
Required: False ,
}
[
string ,
]
,
constellation:
{
Description: Constellation of satellites that acquired the data. ,
Required: False ,
}
string ,
mission:
{
Description: Mission associated with the data. ,
Required: False ,
}
string ,
providers:
{
Description: Organizations or individuals who provide the data. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provider organization or individual. ,
Required: True ,
}
string ,
description:
{
Description: Description of the provider. ,
Required: False ,
}
string ,
roles:
{
Description: Roles played by the provider (e.g., producer, processor, host). ,
Required: False ,
}
[
string ,
]
,
url:
{
Description: URL to the provider's website. ,
Required: False ,
}
string ,
}
,
]
,
gsd:
{
Description: Ground sample distance in meters. ,
Format: float ,
Required: False ,
}
number ,
created:
{
Description: Creation timestamp of the data. ,
Format: date-time ,
Required: False ,
}
string ,
updated:
{
Description: Last update timestamp of the data. ,
Format: date-time ,
Required: False ,
}
string ,
title:
{
Description: Human-readable title for the item. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the item. ,
Required: False ,
}
string ,
datetime:
{
Description: Datetime the asset represents in RFC 3339 format. ,
Required: True ,
}
string ,
start_datetime:
{
Description: Start time of the item observation period. ,
Format: date-time ,
Required: False ,
}
string ,
end_datetime:
{
Description: End time of the item observation period. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
links:
{
Description: Links to related resources and endpoints. ,
Required: True ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
assets:
{
Description: Assets ,
Required: True ,
}
object ,
_msft:ts:
{
Description: MSFT Timestamp ,
Required: False ,
}
string ,
_msft:etag:
{
Description: MSFT ETag ,
Required: False ,
}
string ,
}
,
]
,
bbox:
{
Description: Bounding box of all items in format [west, south, east, north]. ,
Required: False ,
}
[
number ,
]
,
stac_version:
{
Description: Stac Version ,
Required: False ,
}
string ,
links:
{
Description: Links to related resources and endpoints. ,
Required: False ,
}
[
{
rel:
{
Description: The relationship type of the link. ,
Required: False ,
}
string ,
title:
{
Description: The title of the link. ,
Required: False ,
}
string ,
type:
{
Description: The MIME type of the linked resource. ,
Enum:
{
image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. ,
image/jp2: Represents an image/jp2. ,
image/png: Represents an image/png. ,
image/jpeg: Represents an image/jpeg. ,
image/jpg: Represents an image/jpg. ,
image/webp: Represents an image/webp. ,
application/x-binary: Represents an application/x-binary. ,
application/xml: Represents an application/xml. ,
application/json: Represents an application/json. ,
application/geo+json: Represents an application/geo+json. ,
text/html: Represents a text/html. ,
text/plain: Represents a text/plain. ,
application/x-protobuf: Represents an application/x-protobuf. ,
}
,
Required: False ,
}
enum ,
href:
{
Description: The URL of the link. ,
Required: True ,
}
string ,
hreflang:
{
Description: The language of the linked resource. ,
Required: False ,
}
string ,
length:
{
Description: The length of the linked resource. ,
Format: int32 ,
Required: False ,
}
integer ,
method:
{
Description: Specifies the HTTP method that the resource expects. Default: GET. ,
Enum:
{
GET: No description available. ,
POST: No description available. ,
}
,
Required: False ,
}
enum ,
headers:
{
Description: Object key-value pairs that map to headers. Example: { "Accept": "application/json" }. ,
Required: False ,
}
object ,
body:
{
Description: For POST requests, the resource can specify the HTTP body as a JSON object. ,
Required: False ,
}
object ,
merge:
{
Description: Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false. ,
Required: False ,
}
boolean ,
}
,
]
,
context:
{
Description: Context information for the search response. ,
Required: False ,
}
{
returned:
{
Description: Number of items returned in the response. ,
Format: int32 ,
Required: True ,
}
integer ,
limit:
{
Description: Maximum number of items requested. ,
Format: int32 ,
Required: False ,
}
integer ,
matched:
{
Description: Total number of items matching the query. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}