Get collection asset resource metadata

get

/resources/v1/metadata-catalog/aggregates/{siteName}/{collectionAssetType}/{assetId}/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 collection asset 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 collection asset resource instance.

• Request
• Response
• Examples

The following tables summarize the client request.

Path Parameters

Name	Description	Format
assetId	ID of the collection asset	integer double
collectionAssetType	Name of the collection asset type	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 Collection asset 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/ContentQuery/1395380847207/items"

Example 1 Response Header

The following example shows the response header.

HTTP/1.1 200 OK
ETag: "bba52a3de3b27aa059141f01461bb0366af214518321d9c2155dc0fe4cfb678d" 
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 Collection Resource",
  "links": [
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/ContentQuery/1395380847207/items",
      "rel": "alternate",
      "templated": false,
      "mediaType": "application/schema+json",
      "method": "GET",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/ContentQuery/1395380847207/items",
      "rel": "canonical",
      "templated": false,
      "mediaType": "application/json",
      "method": "GET",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/ContentQuery/1395380847207/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 Collection asset 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/ContentQuery/1395380847207/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#"
          }
        }
      }
    }
  }
}