Mosaics Register Search - Register

Dienst:: Planetary Computer

API-Version:: 2026-04-15

Registrieren Suche
Registrieren einer Suchanfrage

POST {endpoint}/data/mosaic/register?api-version=2026-04-15

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	GeoCatalog-Endpunkt, z. B. `https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com`
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
bbox	number[] (float)	Geografischer Begrenzungsrahmen zum Filtern von Elementen [Westen, Süden, Osten, Norden]
collections	string[]	Liste der STAC-Sammlungs-IDs, die in das Mosaik aufgenommen werden sollen
datetime	string	Zeitlicher Filter im RFC 3339-Format oder -Intervall
filter		Filter
filter-lang	FilterLanguage	Format der Abfragesprache, das im filter-Parameter verwendet wird
ids	string[]	Liste der spezifischen STAC-Element-IDs, die in das Mosaik aufgenommen werden sollen
intersects	Geometry: LineString MultiLineString MultiPoint MultiPolygon Point Polygon	GeoJSON-Geometrie zum räumlichen Filtern von Elementen nach Schnittmenge
metadata	MosaicMetadata	Zusätzliche Metadaten, die mit dem Mosaik verknüpft werden sollen
query		Abfrage
sortby	StacSortExtension[]	Kriterien für die Bestellung von Elementen im Mosaik

Antworten

Name	Typ	Beschreibung
200 OK	TilerMosaicSearchRegistrationResponse	Die Anforderung ist erfolgreich.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

TilerMosaicSearchRegistrationResponse

Die Anforderung ist erfolgreich.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

Beispiele

MosaicsRegisterSearch_Register

Beispielanforderung

HTTP

POST {endpoint}/data/mosaic/register?api-version=2026-04-15

{
  "filter": {
    "op": "and",
    "args": [
      {
        "op": "=",
        "args": [
          {
            "property": "collection"
          },
          "naip-atl"
        ]
      },
      {
        "op": ">=",
        "args": [
          {
            "property": "datetime"
          },
          "2021-01-01T00:00:00Z"
        ]
      },
      {
        "op": "<=",
        "args": [
          {
            "property": "datetime"
          },
          "2022-12-31T23:59:59Z"
        ]
      }
    ]
  },
  "filter-lang": "cql2-json",
  "sortby": [
    {
      "direction": "desc",
      "field": "datetime"
    }
  ]
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "searchid": "ba13fc7947b9b585690d84ee61aaa653",
  "links": [
    {
      "href": "https://Sanitized.sanitized_label.sanitized_location.geocatalog.spatio.azure.com/data/mosaic/ba13fc7947b9b585690d84ee61aaa653/info",
      "rel": "metadata",
      "type": "application/json",
      "title": "Mosaic metadata"
    },
    {
      "href": "https://Sanitized.sanitized_label.sanitized_location.geocatalog.spatio.azure.com/data/mosaic/ba13fc7947b9b585690d84ee61aaa653/tilejson.json",
      "rel": "tilejson",
      "type": "application/json",
      "title": "Link for TileJSON"
    },
    {
      "href": "https://Sanitized.sanitized_label.sanitized_location.geocatalog.spatio.azure.com/data/mosaic/ba13fc7947b9b585690d84ee61aaa653/WMTSCapabilities.xml",
      "rel": "wmts",
      "type": "application/json",
      "title": "Link for WMTS"
    }
  ]
}

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Laut Azure REST API-Richtlinien – https://aka.ms/AzureRestApiGuidelines#handling-errors.
FilterLanguage	Optionen für den filter-lang-Wert in einer POST-Anforderung. Basierend auf https://github.com/stac-api-extensions/filter#queryables Beachten Sie die Hinzufügung von cql2-json, das vom pgstac-Backend verwendet wird, aber nicht in der obigen Spezifikation enthalten ist. Definiert die unterstützten Filtersprachen für STAC-API-Abfragen.
LineString	stellt eine LineString dar.
MosaicMetadata	Metadateninformationen für Mosaik- oder Suchergebnisse
MosaicMetadataType	Typ der Metadatenressource im System
MultiLineString	repräsentiert einen MultiLineString.
MultiPoint	Repräsentiert einen MultiPoint.
MultiPolygon	stellt ein MultiPolygon dar.
Point	Repräsentiert eine GeoJSON-Punktgeometrie.
Polygon	Stellt ein Polygon dar.
RegisterMosaic	Eingabeparameter für die Registrierung eines neuen Mosaiks von STAC-Elementen
StacLink	Link-Modell. Ref: http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/link.yaml Stellt eine Verbindung dar.
StacLinkType	MIME-Typisierung für Links.
StacSearchSortingDirection	Definiert die Sortierrichtungen für Abfrageergebnisse in der STAC-API.
StacSortExtension	https://github.com/radiantearth/stac-api-spec/tree/master/extensions/sort#sort-api-extension Stellt eine Sortierspezifikation für STAC-API-Abfragen dar.
TilerMosaicSearchRegistrationResponse	Antwort auf eine erfolgreiche Mosaik-Registrierung mit Such-ID und verwandten Links

Azure.Core.Foundations.Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Laut Azure REST API-Richtlinien – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

FilterLanguage

Enumeration

Optionen für den filter-lang-Wert in einer POST-Anforderung.

Basierend auf https://github.com/stac-api-extensions/filter#queryables

Beachten Sie die Hinzufügung von cql2-json, das vom pgstac-Backend verwendet wird, aber nicht in der obigen Spezifikation enthalten ist.

Definiert die unterstützten Filtersprachen für STAC-API-Abfragen.

Wert	Beschreibung
cql-json	Allgemeine Abfragesprache im JSON-Format.
cql2-json	Common Query Language 2 im JSON-Format
cql2-text	Common Query Language 2 im Textformat.

LineString

Objekt

stellt eine LineString dar.

Name	Typ	Beschreibung
bbox	number[] (float)	Optionale Begrenzungsbox der Geometrie.
coordinates	number[] (float)	Die Koordinaten der Linienkette.
type	string: LineString	Diskriminator-Eigenschaft für Geometrie.

MosaicMetadata

Objekt

Metadateninformationen für Mosaik- oder Suchergebnisse

Name	Typ	Standardwert	Beschreibung
assets	string[]		Liste der in der Ressource enthaltenen Objektkennungen
bounds	string		Geografischer Begrenzungsrahmen im Format [West, Süd, Ost, Nord]
defaults	object		Standardeinstellungen
maxzoom	integer (int32)		Maximal unterstützte Zoomstufe
minzoom	integer (int32)		Unterstützte Mindestzoomstufe
name	string		Lesbarer Name für die Ressource
type	MosaicMetadataType	mosaic	Typ der Metadatenressource

MosaicMetadataType

Enumeration

Typ der Metadatenressource im System

Wert	Beschreibung
mosaic	Metadaten für ein Mosaik aus mehreren Raster-Assets
search	Metadaten für ein Suchanfrageergebnis

MultiLineString

Objekt

repräsentiert einen MultiLineString.

Name	Typ	Beschreibung
bbox	number[] (float)	Optionale Begrenzungsbox der Geometrie.
coordinates	number[] (float)	Die Koordinaten der Multilinestring.
type	string: MultiLineString	Diskriminator-Eigenschaft für Geometrie.

MultiPoint

Objekt

Repräsentiert einen MultiPoint.

Name	Typ	Beschreibung
bbox	number[] (float)	Optionale Begrenzungsbox der Geometrie.
coordinates	number[] (float)	Die Koordinaten des Multipunkts.
type	string: MultiPoint	Diskriminator-Eigenschaft für Geometrie.

MultiPolygon

Objekt

stellt ein MultiPolygon dar.

Name	Typ	Beschreibung
bbox	number[] (float)	Optionale Begrenzungsbox der Geometrie.
coordinates	number[] (float)	Die Koordinaten des Multipolygons.
type	string: MultiPolygon	Diskriminator-Eigenschaft für Geometrie.

Point

Objekt

Repräsentiert eine GeoJSON-Punktgeometrie.

Name	Typ	Beschreibung
bbox	number[] (float)	Optionale Begrenzungsbox der Geometrie.
coordinates	number[] (float)	Die Koordinaten des Punktes sind [Längengrad, Breitengrad].
type	string: Point	Diskriminator-Eigenschaft für Geometrie.

Polygon

Objekt

Stellt ein Polygon dar.

Name	Typ	Beschreibung
bbox	number[] (float)	Optionale Begrenzungsbox der Geometrie.
coordinates	number[] (float)	Die Koordinaten des Polygons.
type	string: Polygon	Diskriminator-Eigenschaft für Geometrie.

RegisterMosaic

Objekt

Eingabeparameter für die Registrierung eines neuen Mosaiks von STAC-Elementen

Name	Typ	Beschreibung
bbox	number[] (float)	Geografischer Begrenzungsrahmen zum Filtern von Elementen [Westen, Süden, Osten, Norden]
collections	string[]	Liste der STAC-Sammlungs-IDs, die in das Mosaik aufgenommen werden sollen
datetime	string	Zeitlicher Filter im RFC 3339-Format oder -Intervall
filter		Filter
filter-lang	FilterLanguage	Format der Abfragesprache, das im filter-Parameter verwendet wird
ids	string[]	Liste der spezifischen STAC-Element-IDs, die in das Mosaik aufgenommen werden sollen
intersects	Geometry: LineString MultiLineString MultiPoint MultiPolygon Point Polygon	GeoJSON-Geometrie zum räumlichen Filtern von Elementen nach Schnittmenge
metadata	MosaicMetadata	Zusätzliche Metadaten, die mit dem Mosaik verknüpft werden sollen
query		Abfrage
sortby	StacSortExtension[]	Kriterien für die Bestellung von Elementen im Mosaik

StacLink

Objekt

Link-Modell.

Ref: http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/link.yaml

Stellt eine Verbindung dar.

Name	Typ	Standardwert	Beschreibung
body			Für POST-Anfragen kann die Ressource den HTTP-Körper als JSON-Objekt angeben.
headers	object		Objekt-Schlüssel-Wert-Paare, die auf Header abgebildet werden. Beispiel: { "Akzeptieren": "application/json" }.
href	string		Die URL des Links.
hreflang	string		Die Sprache der verknüpften Ressource.
length	integer (int32)		Die Länge der verlinkten Ressource.
merge	boolean	False	Gibt an, ob vom Client erwartet wird, dass er den Body-Wert in den aktuellen Request-Body einfügt, bevor er dem Link folgt. Dies gilt nur, wenn der Server auf eine POST-Anfrage antwortet. Standardwert: false.
method	enum: GET POST	GET	Spezifiziert die HTTP-Methode, die die Ressource erwartet. Standard: GET.
rel	string		Der Beziehungstyp der Verbindung.
title	string		Der Titel des Links.
type	StacLinkType	application/json	Der MIME-Typ der verknüpften Ressource.

StacLinkType

Enumeration

MIME-Typisierung für Links.

Wert	Beschreibung
image/tiff; application=geotiff	Repräsentiert ein Bild/TIFF mit application=geotiff.
image/jp2	Stellt ein Bild/JP2 dar.
image/png	Stellt ein Bild/png dar.
image/jpeg	Stellt ein Bild/JPEG dar.
image/jpg	Stellt ein Bild/jpg dar.
image/webp	Stellt ein Bild/Webp dar.
application/x-binary	Repräsentiert eine Anwendung/x-Binär.
application/xml	Repräsentiert eine Anwendung/XML.
application/json	Repräsentiert eine Anwendung/JSON.
application/geo+json	Repräsentiert eine Anwendung/geo+json.
text/html	Stellt einen Text/HTML dar.
text/plain	Stellt einen Text/Plain dar.
application/x-protobuf	Repräsentiert eine Anwendung/x-Protobuf.

StacSearchSortingDirection

Enumeration

Definiert die Sortierrichtungen für Abfrageergebnisse in der STAC-API.

Wert	Beschreibung
asc	Sortieren Sie die Ergebnisse in aufsteigender Reihenfolge.
desc	Sortieren Sie die Ergebnisse in absteigender Reihenfolge.

StacSortExtension

Objekt

https://github.com/radiantearth/stac-api-spec/tree/master/extensions/sort#sort-api-extension

Stellt eine Sortierspezifikation für STAC-API-Abfragen dar.

Name	Typ	Beschreibung
direction	StacSearchSortingDirection	Die Sortierrichtung (aufsteigend oder absteigend).
field	string minLength: 1	Der Feldname, nach dem sortiert werden soll.

TilerMosaicSearchRegistrationResponse

Objekt

Antwort auf eine erfolgreiche Mosaik-Registrierung mit Such-ID und verwandten Links

Name	Typ	Beschreibung
links	StacLink[]	Weiterführende Links zum angemeldeten Mosaik
searchid	string	Eindeutige Kennung für die registrierte Suche