Stac Collection Config - Get

Service:: Planetary Computer

API-versie:: 2026-04-15

Configuratie ophalen
Download de volledige gebruikersconfiguratie voor een bepaalde verzameling

GET {endpoint}/stac/collections/{collectionId}/configurations?api-version=2026-04-15

URI-parameters

Name	In	Vereist	Type	Description
collectionId	path	True	string maxLength: 500 pattern: .*	Unieke identificatiecode voor de STAC-collectie.
endpoint	path	True	string (uri)	GeoCatalog-eindpunt, bijvoorbeeld. `https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com`
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	UserCollectionSettings	De aanvraag is voltooid.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

UserCollectionSettings

De aanvraag is voltooid.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Voorbeelden

StacCollectionConfig_Get

Voorbeeldaanvraag

HTTP

GET {endpoint}/stac/collections/naip-atl/configurations?api-version=2026-04-15

Voorbeeldrespons

Statuscode:: 200

{
  "tileSettings": {
    "minZoom": 6,
    "maxItemsPerTile": 35,
    "defaultLocation": null
  },
  "mosaicInfo": {
    "mosaics": [
      {
        "id": "default",
        "name": "Default",
        "description": "",
        "cql": []
      },
      {
        "id": "mos1",
        "name": "Most recent available",
        "description": "Most recent available imagery in this collection",
        "cql": []
      },
      {
        "id": "test-mosaic-1",
        "name": "Test Most recent available",
        "description": "Most recent available imagery in this collection - updated",
        "cql": []
      }
    ],
    "renderOptions": [
      {
        "id": "natural-color",
        "name": "Natural color",
        "description": "RGB from visual assets",
        "type": "raster-tile",
        "options": "assets=image&asset_bidx=image|1,2,3",
        "vectorOptions": null,
        "minZoom": 6,
        "legend": null,
        "conditions": null
      },
      {
        "id": "test-natural-color",
        "name": "Test Natural color updated",
        "description": "RGB from visual assets - updated",
        "type": "raster-tile",
        "options": "assets=image&asset_bidx=image|1,2,3",
        "vectorOptions": null,
        "minZoom": 6,
        "legend": null,
        "conditions": null
      }
    ],
    "defaultLocation": null,
    "defaultCustomQuery": null
  }
}

Definities

Name	Description
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors.
DefaultLocation	Definieert een standaard geografische locatie voor kaartvisualisatie.
LegendConfigType	Legendatype om te maken, een van: `continuous`, `classmap`, `interval` of `none` (let op, `none` is een letterlijke tekenreeks).
RenderOption	Definieert visualisatieparameters voor het weergeven van gegevens op een kaart.
RenderOptionCondition	Definieert een voorwaarde voor het inschakelen van een renderoptie.
RenderOptionLegend	Configuratie voor het genereren van een gegevenslegenda.
RenderOptionType	Hiermee geeft u de typen renderopties op voor kaartvisualisatie.
RenderOptionVectorOptions	Definieert parameters voor het renderen van vectortegels.
StacMosaic	Definieert een mozaïek met een naam op basis van filtercriteria.
StacMosaicConfiguration	Configuratie voor visualisatie van gegevensmozaïeken.
TileSettings	Configuratie voor visualisatie van kaarttegels.
UserCollectionSettings	Gebruikersspecifieke verzamelingsinstellingen voor visualisatie.

Azure.Core.Foundations.Error

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object met meer specifieke informatie over de fout. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

DefaultLocation

Object

Definieert een standaard geografische locatie voor kaartvisualisatie.

Name	Type	Description
coordinates	number[] (float)	Standaard middencoördinaten [breedtegraad, lengtegraad] voor de kaart.
zoom	integer (int32)	Standaard zoomniveau voor de kaart.

LegendConfigType

Opsomming

Legendatype om te maken, een van: continuous, classmap, interval of none (let op, none is een letterlijke tekenreeks).

Waarde	Description
continuous	Doorlopende legenda van het kleurverloop.
classmap	Geklasseerde kaart met discrete kleuren voor klassen.
interval	Op interval gebaseerde legenda met discrete bereiken.
none	Geen legende.

RenderOption

Object

Definieert visualisatieparameters voor het weergeven van gegevens op een kaart.

Name	Type	Default value	Description
conditions	RenderOptionCondition[]		Een lijst met eigenschaps-/waardevoorwaarden die in de actieve mosaic CQL moeten staan om deze renderoptie in te schakelen
description	string		Een langere beschrijving van de renderoptie die kan worden gebruikt om de inhoud ervan uit te leggen.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Unieke id voor de renderoptie.
legend	RenderOptionLegend		Legenda-configuratie voor deze renderoptie.
minZoom	integer (int32) maximum: 24	12	Minimaal zoomniveau waarop deze laag moet worden weergegeven.
name	string maxLength: 40		Korte beschrijvende naam voor de renderoptie.
options	string		Een URL-query-string, gecodeerde string met TiTiler-weergaveopties. Alleen geldig voor `raster-tile` types. Zie Queryparameters.
type	RenderOptionType	raster-tile	Het type weergave dat moet worden toegepast (raster of vector).
vectorOptions	RenderOptionVectorOptions		Opties voor het renderen van vectortegels. Alleen geldig voor `vt-polygon` en `vt-line` types.

RenderOptionCondition

Object

Definieert een voorwaarde voor het inschakelen van een renderoptie.

Name	Type	Description
property	string	Naam van de eigenschap om het actieve CQL-filter in te checken.
value	string	Waarde waar de eigenschap gelijk aan moet zijn.

RenderOptionLegend

Object

Configuratie voor het genereren van een gegevenslegenda.

Name	Type	Description
labels	string[]	Tekstlabels om op de legenda weer te geven.
scaleFactor	number (float)	Een factor om intervallegendalabels mee te vermenigvuldigen. Handig voor geschaalde rasters waarvan de colormapdefinities worden toegewezen aan niet-geschaalde waarden, waarbij legendalabels effectief worden weergegeven als geschaalde waarden.
trimEnd	integer (int32)	Aantal items dat moet worden bijgesneden vanaf het einde van de legenda.
trimStart	integer (int32)	Het aantal items dat moet worden bijgesneden vanaf het begin van de legendadefinitie. Wordt gebruikt als er waarden zijn die belangrijk zijn voor het renderen (bijv. nodata) die niet wenselijk zijn in de legenda.
type	LegendConfigType	Legendatype om te maken, een van: `continuous`, `classmap`, `interval` of `none` (let op, `none` is een letterlijke tekenreeks).

RenderOptionType

Opsomming

Hiermee geeft u de typen renderopties op voor kaartvisualisatie.

Waarde	Description
raster-tile	Type voor het renderen van rastertegels.
vt-polygon	Het vectortype van de tegelveelhoek teruggeven.
vt-line	Het vectortype van het de lijnteruggeven van de tegel.

RenderOptionVectorOptions

Object

Definieert parameters voor het renderen van vectortegels.

Name	Type	Description
fillColor	string	Opvulkleur voor polygoonobjecten.
filter	string[]	MapBox GL filterexpressie om functies te filteren.
sourceLayer	string	Naam van de bronlaag in de vectortegels.
strokeColor	string	Lijnkleur voor lijnkenmerken.
strokeWidth	integer (int32)	Breedte van lijnstreken in pixels.
tilejsonKey	string	Activasleutel met de TileJSON-URL.

StacMosaic

Object

Definieert een mozaïek met een naam op basis van filtercriteria.

Name	Type	Description
cql	Cql[]	Een lijst met geldige CQL2-JSON expressies die zijn gebruikt om de collectie te filteren op moasic.
description	string	Gedetailleerde beschrijving van het mozaïek.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Unieke identificatiecode voor het mozaïek.
name	string maxLength: 30	Korte beschrijvende naam voor het mozaïek.

StacMosaicConfiguration

Object

Configuratie voor visualisatie van gegevensmozaïeken.

Name	Type	Description
defaultCustomQuery		Een lijst met CQL-JSON expressies die u als standaard voor deze verzameling kunt gebruiken.
defaultLocation	DefaultLocation	Standaard kaartlocatie bij het weergeven van deze collectie.
mosaics	StacMosaic[]	Vooraf gedefinieerde datamozaïeken beschikbaar voor deze collectie.
renderOptions	RenderOption[]	Beschikbare renderopties voor het visualiseren van de gegevens.

TileSettings

Object

Configuratie voor visualisatie van kaarttegels.

Name	Type	Description
defaultLocation	DefaultLocation	Standaard kaartlocatie bij het weergeven van deze collectie.
maxItemsPerTile	integer (int32)	Het maximum aantal items dat in één tegel moet worden opgenomen.
minZoom	integer (int32) maximum: 24	Het minimale zoomniveau dat voor deze collectie kan worden aangevraagd. Biedt een harde limiet voor de tegelservers om ervoor te zorgen dat ze geen aanvragen krijgen voor lage zoomniveaus, waardoor veel bestanden worden opgehaald en de tegelservers vastlopen.

UserCollectionSettings

Object

Gebruikersspecifieke verzamelingsinstellingen voor visualisatie.

Name	Type	Description
mosaicInfo	StacMosaicConfiguration	Instellingen voor visualisatie van gegevensmozaïeken.
tileSettings	TileSettings	Instellingen voor visualisatie van kaarttegels.

Delen via

Stac Collection Config - Get

URI-parameters

Antwoorden

Beveiliging

OAuth2Auth

Bereiken

Voorbeelden

StacCollectionConfig_Get

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

DefaultLocation

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions

StacMosaic

StacMosaicConfiguration

TileSettings

UserCollectionSettings