Previous Next

Get asset type based search resource metadata

get
/resources/v1/metadata-catalog/search/types/{assetType}/assets
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 search 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 search resource instance.

The following tables summarize the client request.

Path Parameters
Name Description Format
assetType Asset type 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 an AssetType-based Search 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/search/types/AVIArticle/assets"

Example 1 Response Header

The following example shows the response header.

HTTP/1.1 200 OK
ETag: "a446dafb1ac330b34d89dc788a7d14efee9ad49ec7af6e784d22951f2893722e" 
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": "Asset Search Resource",
  "links": [
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/search/types/AVIArticle/assets",
      "rel": "alternate",
      "templated": false,
      "mediaType": "application/schema+json",
      "method": "GET",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/search/types/AVIArticle/assets",
      "rel": "canonical",
      "templated": false,
      "mediaType": "application/json",
      "method": "GET",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/search/types/AVIArticle/assets",
      "rel": "describes",
      "templated": false,
      "mediaType": "application/json",
      "method": "GET",
      "profile": ""
    }
  ]
}	

Example 2

The following example shows how to get a json schema for a Search 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/search/types/AVIArticle/assets"

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": "Search Collection Items Schema",
  "description": "Schema for Search 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/searchAssetSchema#"
          }
        }
      }
    }
  }
}