1. Oracle WebCenter Sites Aggregate REST APIリファレンス
  2. タスク
  3. アセット・リソース

ID、タイプおよびサイトによるアセットとその依存アセットの集約された形式での読取り

get

/resources/v1/aggregates/{siteName}/{assetType}/{assetId}

リソース・エンドポイントは、指定されたサイト名に属する指定されたアセットおよび任意の深さまでのその依存アセットに関する情報を返します。これは、単数リソースです。

重要な注意: レスポンスの形式は、集約されたアセット形式です。集約されたアセット・レスポンスにはすべて'start'フィールドが含まれます。次に述べるルート・アセットは、レスポンス内の'start'キーの値が示すアセットです。このアセットは、レベル0の開始アセット(リクエストされたアセット、ここでは{assetId})です。このルート・アセットを介して、レスポンス内の下位レベルのすべての依存アセットにナビゲートする必要があります。

特別なケース: ルート・アセットまたは任意の深さの任意の依存アセットのタイプがContentQueryやRecommendationなどのコレクション・アセット・タイプの場合、アセット・データに加えて結果がコレクション・アセットとしても評価され、アイテム配列で返されます。デフォルトの結果数は10です。各アイテムも集約されたアセットで、問合せパラメータはこれにも適用されます。WebCenter Sites Aggregate REST APIでは、collection-asset-resourceを介したコレクション・リソースへのアクセスおよびrecommendation-resourceを介した推奨アセットへのアクセスが推奨されます。結果の数およびページネーションを制御できるためです。

リクエスト

パス・パラメータ
問合せパラメータ
  • 任意の正の整数または文字列"all"を受け入れます。整数のアセットの深さで、どのツリー・レベルまで依存アセットをトラバースするかを定義します。文字列"all"は全体のことです。デフォルト値は2です。assetDepth値が無効(負の数値)の場合、デフォルトのassetDepth値が使用されます。
  • これは、レスポンスに展開するアセット・タイプの制御に使用されます。アセット・タイプのセミコロン区切りのリストを受け入れます。これらのアセット・タイプのアセットは展開されます。他のアセット・タイプは展開されません。ただし、ルート・アセット(参照: リソースの説明内の注意)は常に展開されます。デフォルトでは、すべてのアセット・タイプが展開されます。リストでアセット・タイプの前にNOT演算子(!)を置くと、そのアセット・タイプを展開から除外することを示します。
    次に例を示します。
    • expand=assetType1,assetType2は、'assetType1'および'assetType2'のアセットのみ展開することを意味します。
    • expand=!assetType1,!assetType2は、'assetType1'および'assetType2'以外のすべてのアセットを展開することを意味します。
  • これは、レスポンスでAssetTypeについて返す属性の制御に使用されます。この問合せパラメータは、指定された深さ以内にこのassetTypeのアセットが出現し、そのassetTypeの展開が許可されている場合にのみ機能します。assetType1(attr1,attr2)の形式のアセット・タイプに対する属性のカンマ区切りのリストを受け入れます。これは、assetType1のattr1およびattr2のみを返すということです。アセット・タイプが指定されない場合、fieldsパラメータの属性はルート・アセット(参照: リソースの説明内の注意)のみに適用されます。fields問合せパラメータが指定されない場合、デフォルトではすべての属性が返されます。このパラメータには、次のようにワイルドカードを含めることができます
    • fields=*(attr1,attr2)では、すべてのアセット・タイプについてattr1およびattr2のみが返されます。
    • fields=!*(attr1,attr2,attr3)では、すべてのアセット・タイプについてatt1、attr2およびattr3以外のすべての属性が返されます。
    • fields=!attr1,attr2では、ルート・アセットについてattr1およびattr2以外のすべての属性が返されます。
  • 訪問者サービス・プロファイル名を受け入れます。このprofileNameは、結果を評価するために任意の深さに出現する推奨アセットに適用されます。
  • サイト内に存在するセグメント名のカンマ区切りのリストを受け入れます。これらのセグメントは、結果を評価するために任意の深さに出現する推奨アセットに適用されます。セグメントが指定されない場合、このパラメータはデフォルト・セグメントを使用します。
先頭に戻る

レスポンス

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

200レスポンス

集約された形式のアセットのデータ
先頭に戻る