Stac Collection Render Options - Create

Service:: Planetary Computer

Version d'API:: 2026-04-15

Ajouter l’option de rendu de collection
Ajouter une option de rendu pour une collection donnée

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
collectionId	path	True	string maxLength: 500 pattern: .*	Identificateur unique de la collection STAC.
endpoint	path	True	string (uri)	Terminaison GeoCatalog, par exemple `https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com`
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
id	True	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Identifiant unique pour l’option de rendu.
name	True	string maxLength: 40	Nom descriptif court pour l’option de rendu.
conditions		RenderOptionCondition[]	Une liste des conditions de propriété/valeur qui doivent être dans le CQL de la mosaïque active pour que cette option de rendu soit activée
description		string	Une description plus longue de l’option de rendu qui peut être utilisée pour expliquer son contenu.
legend		RenderOptionLegend	Configuration de légende pour cette option de rendu.
minZoom		integer (int32) maximum: 24	Niveau de zoom minimal pour afficher ce calque.
options		string	Une chaîne d’options de rendu TiTiler encodée par une chaîne de requête. Valable uniquement pour `raster-tile` les types. Voir paramètres de requête.
type		RenderOptionType	Le type de rendu à appliquer (raster ou vectoriel).
vectorOptions		RenderOptionVectorOptions	Options pour le rendu des tuiles vectorielles. Valable uniquement pour `vt-polygon` et `vt-line` types.

Réponses

Nom	Type	Description
201 Created	RenderOption	La requête a réussi et une nouvelle ressource a été créée en conséquence.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Nom

Type

Description

201 Created

RenderOption

La requête a réussi et une nouvelle ressource a été créée en conséquence.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

StacCollectionRenderOptions_Create

Exemple de requête

HTTP

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

{
  "id": "test-natural-color",
  "name": "Test Natural color",
  "type": "raster-tile",
  "options": "assets=image&asset_bidx=image|1,2,3",
  "minZoom": 6
}

Exemple de réponse

Code d’état:: 201

{
  "id": "test-natural-color",
  "name": "Test Natural color",
  "type": "raster-tile",
  "options": "assets=image&asset_bidx=image|1,2,3",
  "minZoom": 6
}

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Selon Azure directives de l’API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
LegendConfigType	Type de légende à former, l’un des suivants : `continuous`, `classmap`, `interval` ou `none` (note, `none` est un littéral de la corde).
RenderOption	Définit des paramètres de visualisation pour le rendu des données sur une carte.
RenderOptionCondition	Définit une condition pour activer une option de rendu.
RenderOptionLegend	Configuration pour générer une légende de données.
RenderOptionType	Spécifie les types d’options de rendu pour la visualisation de cartes.
RenderOptionVectorOptions	Définit des paramètres pour le rendu de tuiles vectorielles.

Azure.Core.Foundations.Error

Objet

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Objet

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet

Objet contenant des informations plus spécifiques sur l’erreur. Selon Azure directives de l’API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

LegendConfigType

Énumération

Type de légende à former, l’un des suivants : continuous, classmap, interval ou none (note, none est un littéral de la corde).

Valeur	Description
continuous	Inscription en rampe colorée continue.
classmap	Carte classifiée avec des couleurs discrètes pour les classes.
interval	Légende basée sur les intervalles avec des plages discrètes.
none	Aucune légende.

RenderOption

Objet

Définit des paramètres de visualisation pour le rendu des données sur une carte.

Nom	Type	Valeur par défaut	Description
conditions	RenderOptionCondition[]		Une liste des conditions de propriété/valeur qui doivent être dans le CQL de la mosaïque active pour que cette option de rendu soit activée
description	string		Une description plus longue de l’option de rendu qui peut être utilisée pour expliquer son contenu.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Identifiant unique pour l’option de rendu.
legend	RenderOptionLegend		Configuration de légende pour cette option de rendu.
minZoom	integer (int32) maximum: 24	12	Niveau de zoom minimal pour afficher ce calque.
name	string maxLength: 40		Nom descriptif court pour l’option de rendu.
options	string		Une chaîne d’options de rendu TiTiler encodée par une chaîne de requête. Valable uniquement pour `raster-tile` les types. Voir paramètres de requête.
type	RenderOptionType	raster-tile	Le type de rendu à appliquer (raster ou vectoriel).
vectorOptions	RenderOptionVectorOptions		Options pour le rendu des tuiles vectorielles. Valable uniquement pour `vt-polygon` et `vt-line` types.

RenderOptionCondition

Objet

Définit une condition pour activer une option de rendu.

Nom	Type	Description
property	string	Nom de propriété à vérifier dans le filtre CQL actif.
value	string	Valeur que la propriété doit égaler.

RenderOptionLegend

Objet

Configuration pour générer une légende de données.

Nom	Type	Description
labels	string[]	Des étiquettes textuelles à afficher sur la légende.
scaleFactor	number (float)	Un facteur pour multiplier les labels de légendes d’intervalle par. Utile pour les rasters à échelle dont les définitions de colormap correspondent à des valeurs non mises à l’échelle, affichant effectivement les étiquettes de légende comme des valeurs mises à l’échelle.
trimEnd	integer (int32)	Nombre d’éléments à couper à partir de la fin de la légende.
trimStart	integer (int32)	Le nombre d’éléments à tailler depuis le début de la définition de la légende. Utilisé s’il y a des valeurs importantes pour le rendu (par exemple nodata) qui ne sont pas souhaitables dans la légende.
type	LegendConfigType	Type de légende à former, l’un des suivants : `continuous`, `classmap`, `interval` ou `none` (note, `none` est un littéral de la corde).

RenderOptionType

Énumération

Spécifie les types d’options de rendu pour la visualisation de cartes.

Valeur	Description
raster-tile	Type de rendu de tuiles raster.
vt-polygon	Type de rendu polygonal en tuiles vectorielles.
vt-line	Type de rendu de lignes en tuiles vectorielles.

RenderOptionVectorOptions

Objet

Définit des paramètres pour le rendu de tuiles vectorielles.

Nom	Type	Description
fillColor	string	Couleur de remplissage pour les caractéristiques polygonales.
filter	string[]	Expression du filtre MapBox GL vers les caractéristiques du filtre.
sourceLayer	string	Nom de la couche source dans les tuiles vectorielles.
strokeColor	string	Couleur de trait pour les traits de ligne.
strokeWidth	integer (int32)	Largeur des traits de ligne en pixels.
tilejsonKey	string	Clé d’atout contenant l’URL TileJSON.