コンテンツにスキップ

サイト一覧



GET /api/v1/workspace/website/list

概要

現在のブランド設定におけるサイト表示情報を一覧表示します。

呼び出し前の準備と使用手順

対象ワークスペースで routine.defaultAccess などの読み取り権限を持つ OpenAPI Key を使用します。現在のワークスペースはリクエストヘッダーの Key から判定され、このエントリでは workspaceUUID を渡して切り替えることはできません。

Query/Body は不要です。この OpenAPI ルートはパラメーターを共有クエリメソッドに渡さないため、フロントエンド/内部エントリの type 認可フィルターは適用できません。現在のブランド設定内のサイトを返し、isOpen や現在のワークスペースが認可されているかどうかによる項目ごとのフィルタリングは行いません。isCurSite は現在のサイトコードと等しいことのみを示し、クエリ可能/認可済みのフラグではありません。

regionCode は後続のクロスサイトターゲット選択に使用します。まず閲覧可能なワークスペース一覧と合わせてデータ認可を確認してください。endpoint はサイトコンソールの入口であり、OpenAPI やデータクエリサービスのルートアドレスとして直接使用することはできません。regionName はリクエストコンテキストの言語に応じたサイト名で、存在しない場合は null になります。サイト設定がない場合は [] を返します。

リクエストヘッダー

パラメーター名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得・入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

パラメーターの補足説明

現在の環境に設定済みのサイト情報を返します。content[*].regionCode は query.targetRegion の候補サイトコードとして使用できますが、サイトが存在するからといって、現在のワークスペースがそのサイトのデータアクセス認可を取得しているわけではありません。

query_data でクロスサイトのターゲットワークスペースと targetRegion を選択する場合は、まず /api/v1/wksp_share/granted_ws_list を呼び出し、対象の workspaceUUID と同じグループの regionCode を使用してください。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/workspace/website/list' \
  -H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

HTTP 200、application/json。以下の例は直接読み取り可能な主要フィールドを示します。

フィールド 型 説明
content array<object> サイト配列。空の結果は []。
content[].regionCode string サイトコード。元の文字列を使用し、表示名をコードとして扱いません。
content[].regionName string または null 現在の言語でのサイト表示名。空または null になる場合があります。
content[].endpoint string サイトコンソール設定 URL。空になる場合があります。汎用 API エンドポイントではありません。
content[].isCurSite boolean 現在のサイトかどうか。
content[].declaration object 空でない各サイトオブジェクトに、現在のワークスペースの共通宣言を追加します。
{
  "code": 200,
  "content": [
    {
      "regionCode": "site_example",
      "regionName": "サンプルサイト",
      "endpoint": "https://console.guance.com",
      "isCurSite": true,
      "declaration": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたは応答の説明 対処方法
500 ft.InternalServerError ワークスペース/サイト/認可設定、データベースまたはキャッシュの読み取り、およびレスポンスのフォーマットに失敗した場合 内部エラー traceId とクエリ条件を保持し、再試行しても失敗し続ける場合は管理者に設定の確認を依頼してください。空の結果からサイトにデータがないと推測しないでください。

フィードバック

このページは役に立ちましたか?