Stac Collection Mosaics - Get

Service:

Planetary Computer

API Version:

2025-04-30-preview

Get Collection Mosaic
Get a mosaic definition from a given collection

GET https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/stac/collections/{collectionId}/configurations/mosaics/{mosaicId}?api-version=2025-04-30-preview

URI Parameters

Name	In	Required	Type	Description
collectionId	path	True	string maxLength: 500 pattern: .*	Unique identifier for the STAC collection.
mosaicId	path	True	string maxLength: 500 pattern: .*	Unique identifier for the mosaic configuration.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Mosaic	The request has succeeded.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://geocatalog.spatio.azure.com/.default

Examples

StacCollectionMosaics_Get

Sample request

HTTP

GET https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/stac/collections/c1007ec2-3ddc-4335-9edd-b1c26b1b4c92/configurations/mosaics/mos1?api-version=2025-04-30-preview

Sample response

Status code:

200

{
  "id": "mos1",
  "name": "Most recent available",
  "description": "Most recent available imagery in this collection",
  "cql": []
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
Cql	CQL model
CqlFilter	CQL Filter model
Mosaic	Defines a named mosaic with filtering criteria.
SortBy	SortBy model

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

Cql

Object

CQL model

Name	Type	Description
filter	CqlFilter	Filter
filter-lang	string	Filter language
sortby	SortBy[]	Sort by

CqlFilter

Object

CQL Filter model

Name	Type	Description
args	CqlArgument[]	Arguments for the logical operator
op	string	Logical operator

Mosaic

Object

Defines a named mosaic with filtering criteria.

Name	Type	Description
cql	Cql[]	A list of valid CQL2-JSON expressions used to filter the collection to moasic.
description	string	Detailed description of the mosaic.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-|_)[a-zA-Z0-9_-]*(?	Unique identifier for the mosaic.
name	string maxLength: 30	Short descriptive name for the mosaic.

SortBy

Object

SortBy model

Name	Type	Description
direction	string	Sort direction
field	string	Field to sort by