ジャンプ先

• リクエスト
• レスポンス

サイトのナビゲーションの取得

get

/resources/v1/aggregates/{siteName}/navigation

リソース・エンドポイントは、指定されたサイト名のナビゲーション・データを返します。

重要な注意: これは、単数リソースです。レスポンスの形式は、集約されたアセット形式です(「アセット・リソース・エンドポイント」の注意を参照してください)。アセット情報に加えてナビゲーション・データも含まれる点を除き、アセット・リソース・エンドポイントに似ています。そのため、すべての集約アセット問合せパラメータ(assetDepth、expand、fields、segments、profileName)はこのリソースにも適用されます。ナビゲーション・データ(ナビゲーションに関する子ノード)はすべて、レスポンスの'children'配列で提供されます。各子もまた集約されたアセットです。指定した集約アセット問合せパラメータは子配列の各子にも適用されます。

リクエスト

パス・パラメータ

• siteName: string
  サイトの名前

問合せパラメータ

• assetDepth: number
  このパラメータの詳細は、「アセット・リソース」の'assetDepth'問合せパラメータを参照してください。子配列の各子にも適用されます。
• code: string
  サイト・ノード・タイプのカンマ区切りのリストを受け入れます。パブリケーション(サイト)下の配置された子ノード(ページ)を返すか、配置されていない子ノードを返すかを決定します。デフォルト・ノード・タイプは、placedです。
  使用方法:

  • "code=unplaced"。配置されていない子のみをレスポンスに含めることを意味します
  • "code=placed,unplaced"。配置された子および配置されていない子の両方をレスポンスに含めることを意味します。
• expand: string
  assetTypeのカンマ区切りのリストを受け入れます。このパラメータの詳細は、「アセット・リソース」の'expand'問合せパラメータを参照してください。子配列の各子にも適用されます。
• fields: string
  このパラメータの詳細は、「アセット・リソース」の'fields'問合せパラメータを参照してください。子配列の各子にも適用されます。'children'配列は、レスポンスから除外できません。
• links: string
  リンク名のカンマ区切りのリストを受け入れます。デフォルトでは、このパラメータですべてのリンク(schema、selfおよびcanonicalリソース)が返されます。
• navigationDepth: number
  任意の正の整数または文字列"all"を受け入れます。整数のナビゲーションの深さで、どの子レベルまでサイト・ナビゲーションをトラバースするかを定義します。文字列"all"は全体のことです。デフォルト値は2です。navigationDepth値が無効(負の数値)の場合、デフォルトのnavigationDepth値が使用されます。ノードの子は、子配列で提供されます。この子属性は除外できません。各子アイテムもまた集約されており、集約されたアセットの問合せパラメータはすべて各アイテムに適用できます。
• profileName: string
  このパラメータの詳細は、「アセット・リソース」の'profileName'問合せパラメータを参照してください。子配列の各子にも適用されます。
• segments: string
  このパラメータの詳細は、「アセット・リソース」の'segments'問合せパラメータを参照してください。子配列の各子にも適用されます。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

集約された形式のサイト・ナビゲーション・データ

先頭に戻る