ジャンプ先

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

IDによるコレクション・アセットとその評価された結果の取得

get

/resources/v1/aggregates/{siteName}/{collectionAssetType}/{assetId}/items

リソース・エンドポイントは、指定されたサイト名に属する指定されたコレクション・アセットの評価された結果を集約された形式で返します。

重要な注意: これは、コレクション・リソースです。指定したコレクション・アセットの評価された結果はすべて、レスポンスのアイテム配列で提供されます。各結果も集約されたアセットです。そのため、すべての集約アセット問合せパラメータ(assetDepth、expand、fields、segments、profileName)はこのリソースにも適用されます。これらの集約アセット問合せパラメータは、アイテム配列の各結果に適用されます。集約アセットとその問合せパラメータの詳細は、「アセット・リソース・エンドポイント」を参照してください。

リクエスト

パス・パラメータ

• assetId: integer(double)
  コレクション・アセットのID
• collectionAssetType: string
  コレクション・アセット・タイプの名前
• siteName: string
  サイトの名前

問合せパラメータ

• assetDepth: number
  このパラメータの詳細は、「アセット・リソース・エンドポイント」の'assetDepth'問合せパラメータを参照してください。アイテム配列の各結果に適用されます。
• expand: string
  assetTypeのカンマ区切りのリストを受け入れます。このパラメータの詳細は、「アセット・リソース・エンドポイント」の'expand'問合せパラメータを参照してください。アイテム配列の各結果に適用されます。
• fields: string
  このパラメータの詳細は、「アセット・リソース・エンドポイント」の'fields'問合せパラメータを参照してください。アイテム配列の各結果に適用されます。
• limit: number
  返されるアイテムの合計数を指定します。
• links: string
  リンク名のカンマ区切りのリストを受け入れます。デフォルトでは、このパラメータですべてのリンク(next、prev、first、last、schema、selfおよびcanonicalリソース)が返されます。
• offset: number
  結果を返す開始地点となる開始索引を指定します。
• profileName: string
  このパラメータの詳細は、「アセット・リソース」の'profileName'問合せパラメータを参照してください。アイテム配列の各結果に適用されます。
• segments: string
  これについては、「アセット・リソース」の'segments'問合せパラメータを参照してください。アイテム配列の各結果に適用されます。
• totalResults: boolean
  ブール値を受け入れます。trueに設定すると、レスポンスに結果総数フィールドが表示されます。デフォルトはfalseです。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

集約された形式のコレクション・アセット結果。

先頭に戻る