宛先サーバー設定の取得
このページでは、/authoring/destination-servers
API エンドポイントを使用して、既存の宛先サーバー設定に関する情報を取得するために使用できる API リクエストおよびペイロードの例を示します。
宛先サーバーによって使用される機能について詳しくは、以下の記事を参照してください。
宛先サーバー API 操作の概要 get-started
続行する前に、「はじめる前に」を参照し、API の呼び出しを正常に行うために必要となる重要な情報(必要な宛先オーサリング権限および必要なヘッダーの取得方法など)を確認してください。
宛先サーバー設定の取得 retrieve
/authoring/destination-servers
エンドポイントに GET
リクエストを行うことで、既存の宛先サーバー設定を取得できます。
platform.adobe.io/data/core/activation/authoring/destination-servers
API 形式
以下の API 形式を使用して、お使いのアカウントに関するすべての宛先サーバー設定を取得します。
GET /authoring/destination-servers
以下の API 形式を使用して、{INSTANCE_ID}
パラメーターで定義された、特定の宛先サーバー設定を取得します。
GET /authoring/destination-servers/{INSTANCE_ID}
以下の 2 つのリクエストは、リクエストで INSTANCE_ID
パラメーターを渡すかどうかに応じて、お客様の IMS 組織に対するすべての宛先サーバー設定か、特定の宛先サーバー設定を取得します。
以下の各タブを選択して、対応するペイロードおよびその応答を表示します。
以下のリクエストは、IMS Org ID およびサンドボックスの設定に基づいて、アクセス権のある宛先サーバー設定のリストを取得します。
accordion | ||
---|---|---|
リクエスト | ||
|
accordion | ||
---|---|---|
応答 | ||
応答が成功すると、HTTP ステータス 200 が、使用した IMS Org ID およびサンドボックス名に基づいた、アクセス権のある宛先サーバー設定のリストと共に返されます。1 つの
|
以下のリクエストは、{INSTANCE_ID}
パラメーターで定義された、特定の宛先サーバー設定を取得します。
accordion | ||||||||
---|---|---|---|---|---|---|---|---|
リクエスト | ||||||||
|
accordion | ||
---|---|---|
応答 | ||
応答が成功すると、HTTP ステータス 200 が、提供された
|
API エラー処理 error-handling
Destination SDK API エンドポイントは、一般的な Experience Platform API エラーメッセージの原則に従います。Platform トラブルシューティングガイドの API ステータスコードおよびリクエストヘッダーエラーを参照してください。
次の手順 next-steps
このドキュメントでは、Destination SDK /authoring/destination-servers
API エンドポイントを使用した、宛先サーバー設定の取得方法を確認しました。
このエンドポイントでできることについて詳しくは、以下の記事を参照してください。