Get recommendation resource metadata
get
/resources/v1/metadata-catalog/aggregates/{siteName}/engage/recommendation/{recommendationName}/items
The resource endpoint returns description of the resource, including the resource name, a link to the json schema of the resource, and a link to the recommendation resource instance when requested with "application/json". When requested with "application/schema+json", the json schema of the resource is returned. The default is "application/json".
Note: This is the metadata URL returned from an OPTIONS request of the recommendation resource instance.
The following tables summarize the client request.
Path Parameters
| Name | Description | Format |
|---|---|---|
| recommendationName | Name of the recommendation | string |
| siteName | Name of the site | string |
The following tables summarize the server response.
Supported Media Types
- application/json
- application/schema+json
200 Response
Resource metadata.
Example 1
The following example shows how to get a description for a Recommendation resource, by submitting a GET request on the REST resource using cURL.
curl -i -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/engage/recommendation/Running%20Recommendation/items"
Example 1 Response Header
The following example shows the response header.
HTTP/1.1 200 OK ETag: "0bb17f1ed7ed60919f95b2d6995f2cee13f73828f803f88cfc7bac8b1507e97e" Cache-Control: max-age=0 Content-Type: application/json;charset=utf-8
Example 1 Response Body
The following example shows the contents of the response body in JSON format.
{
"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": ""
}
]
}
Example 2
The following example shows how to get a json schema for a Recommendation resource, by submitting a GET request on the REST resource using cURL.
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"
Example 2 Response Header
The following example shows the response header.
HTTP/1.1 200 OK Cache-Control: max-age=0,no-cache,no-store Content-Type: application/schema+json;charset=utf-8
Example 2 Response Body
The following example shows the contents of the response body, in JSON format.
{
"$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#"
}
}
}
}
}
}