Stac Collection Render Options - Create

サービス:: Planetary Computer

API バージョン:: 2026-04-15

コレクションレンダリングオプションを追加
特定のコレクションのレンダリングオプションを追加する

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

URI パラメーター

名前	/	必須	型	説明
collectionId	path	True	string maxLength: 500 pattern: .*	STAC コレクションの一意の識別子。
endpoint	path	True	string (uri)	GeoCatalogのエンドポイント、例えば `https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com`
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
id	True	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	レンダリングオプションの一意識別子。
name	True	string maxLength: 40	レンダリングオプションの簡単な説明名です。
conditions		RenderOptionCondition[]	このレンダリングオプションを有効にするためにアクティブなモザイクCQL内で必須のプロパティ/値条件のリストです
description		string	レンダリングオプションの内容を説明するために使える、より詳しい説明です。
legend		RenderOptionLegend	このレンダリングオプションのレジェンド設定。
minZoom		integer (int32) maximum: 24	このレイヤーを表示するための最小ズームレベル。
options		string	TiTilerレンダリングオプションのURLクエリ文字列でエンコードされた文字列です。 `raster-tile`タイプのみ有効です。クエリパラメータを参照してください。
type		RenderOptionType	適用するレンダリングの種類(ラスタかベクターか)。
vectorOptions		RenderOptionVectorOptions	ベクタータイルのレンダリングオプション。これは、 `vt-polygon` および `vt-line` タイプにのみ適用されます。

応答

名前	型	説明
201 Created	RenderOption	要求が成功し、結果として新しいリソースが作成されました。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	予期しないエラー応答。ヘッダー x-ms-error-code: string

名前

型

説明

201 Created

RenderOption

要求が成功し、結果として新しいリソースが作成されました。

Other Status Codes

Azure.Core.Foundations.ErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
https://geocatalog.spatio.azure.com/.default

例

StacCollectionRenderOptions_Create

要求のサンプル

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
}

応答のサンプル

状態コード:: 201

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

定義

名前	説明
Azure.Core.Foundations.Error	エラーオブジェクト。
Azure.Core.Foundations.ErrorResponse	エラーの詳細を含む応答。
Azure.Core.Foundations.InnerError	エラーに関するより具体的な情報を含むオブジェクト。 REST APIのガイドラインAzure https://aka.ms/AzureRestApiGuidelines#handling-errors。
LegendConfigType	例例のタイプは、 `continuous`、 `classmap`、 `interval` 、または `none` のいずれかです( `none` は文字列です)。
RenderOption	地図上のデータレンダリングのための可視化パラメータを定義します。
RenderOptionCondition	レンダリングオプションを有効にする条件を定義します。
RenderOptionLegend	データ凡例を生成するための設定。
RenderOptionType	地図の可視化用のレンダリングオプションの種類を指定します。
RenderOptionVectorOptions	ベクタータイルレンダリングのパラメータを定義します。

Azure.Core.Foundations.Error

Object

エラーオブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
details	Azure.Core.Foundations.Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	Azure.Core.Foundations.InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

Object

エラーの詳細を含む応答。

名前	型	説明
error	Azure.Core.Foundations.Error	エラーオブジェクト。

Azure.Core.Foundations.InnerError

Object

エラーに関するより具体的な情報を含むオブジェクト。 REST APIのガイドラインAzure https://aka.ms/AzureRestApiGuidelines#handling-errors。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
innererror	Azure.Core.Foundations.InnerError	内部エラー。

LegendConfigType

列挙

例例のタイプは、 continuous、 classmap、 interval 、または none のいずれかです( none は文字列です)。

値	説明
continuous	連続したカラーランプの例。
classmap	クラスごとに離散的な色を持つ分類マップ。
interval	離散的な範囲を持つ区間ベースの凡例。
none	凡例を表示しません。

RenderOption

Object

地図上のデータレンダリングのための可視化パラメータを定義します。

名前	型	規定値	説明
conditions	RenderOptionCondition[]		このレンダリングオプションを有効にするためにアクティブなモザイクCQL内で必須のプロパティ/値条件のリストです
description	string		レンダリングオプションの内容を説明するために使える、より詳しい説明です。
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		レンダリングオプションの一意識別子。
legend	RenderOptionLegend		このレンダリングオプションのレジェンド設定。
minZoom	integer (int32) maximum: 24	12	このレイヤーを表示するための最小ズームレベル。
name	string maxLength: 40		レンダリングオプションの簡単な説明名です。
options	string		TiTilerレンダリングオプションのURLクエリ文字列でエンコードされた文字列です。 `raster-tile`タイプのみ有効です。クエリパラメータを参照してください。
type	RenderOptionType	raster-tile	適用するレンダリングの種類(ラスタかベクターか)。
vectorOptions	RenderOptionVectorOptions		ベクタータイルのレンダリングオプション。これは、 `vt-polygon` および `vt-line` タイプにのみ適用されます。

RenderOptionCondition

Object

レンダリングオプションを有効にする条件を定義します。

名前	型	説明
property	string	プロパティ名でアクティブなCQLフィルターで確認してください。
value	string	その価値は、その不動産が等しくなければならない。

RenderOptionLegend

Object

データ凡例を生成するための設定。

名前	型	説明
labels	string[]	凡例に表示するテキストラベル。
scaleFactor	number (float)	区間凡例ラベルを掛ける係数。カラーマップの定義がスケールされていない値にマッピングされているスケーリングラスタに有用で、実質的にレジェンドラのラベルをスケールされた値として表示します。
trimEnd	integer (int32)	伝説の最後から削るアイテムの数。
trimStart	integer (int32)	凡例定義の冒頭から切り取るべき項目数。表示に含まれない値(例:nodata)がレンダリングに重要でない場合に使用されます。
type	LegendConfigType	例例のタイプは、 `continuous`、 `classmap`、 `interval` 、または `none` のいずれかです( `none` は文字列です)。

RenderOptionType

列挙

地図の可視化用のレンダリングオプションの種類を指定します。

値	説明
raster-tile	ラスタタイルレンダリングタイプ。
vt-polygon	ベクタータイルポリゴンレンダリングタイプ。
vt-line	ベクタータイル線レンダリングタイプ。

RenderOptionVectorOptions

Object

ベクタータイルレンダリングのパラメータを定義します。

名前	型	説明
fillColor	string	ポリゴン特徴の塗りつぶし色。
filter	string[]	MapBox GLフィルターの表現からフィルター特徴への変換。
sourceLayer	string	ベクタータイルのソースレイヤーの名前。
strokeColor	string	線の特徴のストロークカラー。
strokeWidth	integer (int32)	ピクセル単位の線幅。
tilejsonKey	string	TileJSON URLを含むアセットキー。