推奨リソース・メタデータの取得

get

/resources/v1/metadata-catalog/aggregates/{siteName}/engage/recommendation/{recommendationName}/items

リソース・エンドポイントは、"application/json"を指定したリクエストの場合、リソース名、リソースのJSONスキーマへのリンク、推奨リソース・インスタンスへのリンクなどのリソースの説明を返します。"application/schema+json"を指定したリクエストの場合、リソースのJSONスキーマが返されます。デフォルトは、"application/json"です。注意: これは、推奨リソース・インスタンスのOPTIONSリクエストから返されるメタデータURLです。

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

次の表に、クライアント・リクエストをまとめます。

パス・パラメータ

名前	説明	形式
recommendationName	推奨項目の名前	文字列
siteName	サイトの名前	文字列

次の表に、サーバー・レスポンスをまとめます。

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

• application/json
• application/schema+json

200レスポンス

リソース・メタデータ。

例1

次の例に、cURLを使用してRESTリソースに対するGETリクエストを送信し、推奨リソースの説明を取得する方法を示します。

curl -i -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/engage/recommendation/Running%20Recommendation/items"

例1 レスポンス・ヘッダー

次の例に、レスポンス・ヘッダーを示します。

HTTP/1.1 200 OK
ETag: "0bb17f1ed7ed60919f95b2d6995f2cee13f73828f803f88cfc7bac8b1507e97e" 
Cache-Control: max-age=0
Content-Type: application/json;charset=utf-8

例1 レスポンス本文

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
  "name": "Aggregated Recommendation Resource",
  "links": [
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/engage/recommendation/Running%20Recommendation/items",
      "rel": "alternate",
      "templated": false,
      "mediaType": "application/schema+json",
      "method": "GET",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/engage/recommendation/Running%20Recommendation/items",
      "rel": "canonical",
      "templated": false,
      "mediaType": "application/json",
      "method": "GET",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/engage/recommendation/Running%20Recommendation/items",
      "rel": "describes",
      "templated": false,
      "mediaType": "application/json",
      "method": "GET",
      "profile": ""
    }
  ]
}

例2

次の例に、cURLを使用してRESTリソースに対するGETリクエストを送信し、推奨リソースのJSONスキーマを取得する方法を示します。

curl -i -H "Accept: application/schema+json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/engage/recommendation/Running%20Recommendation/items"

例2 レスポンス・ヘッダー

次の例に、レスポンス・ヘッダーを示します。

HTTP/1.1 200 OK
Cache-Control: max-age=0,no-cache,no-store
Content-Type: application/schema+json;charset=utf-8

例2 レスポンス本文

次の例に、JSON形式のレスポンス本文のコンテンツを示します。

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Collection Items Schema",
  "description": "Schema for Collection Resource",
  "allOf": [
    {
      "$ref": "http://<host>:<port>/<context>/schema/collectionResource#"
    },
    {
      "$ref": "#/definitions/collectionItems"
    }
  ],
  "definitions": {
    "collectionItems": {
      "type": "object",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "$ref": "http://<host>:<port>/<context>/schema/aggregatedAssetSchema#"
          }
        }
      }
    }
  }
}