Oracle WebCenter Sites集約REST APIリファレンス

アセット・タイプによるサイトのアセットの検索

get

/resources/v1/search/sites/{siteName}/types/{assetType}/assets

リソース・エンドポイントは、アセット・タイプに基づいて1つのサイトのすべてのアセットのリストを返します。
これは、コレクション・リソースです。

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

パス・パラメータ

名前	説明	形式
assetType	アセット・タイプ	文字列
siteName	サイトの名前	文字列

問合せパラメータ

名前	説明	形式
countonly	ブール値を受け入れます。trueに設定すると、件数のみ表示され、結果は返されません。デフォルトはfalseです。	ブール
field:[fieldname]:[operation]	指定した演算を使用した[fieldname]のフィールドに対する問合せ条件を指定します。[Operation]はオプションで、equals、range、startswith、phrase、wildcard、similarまたはcontainsのいずれかを指定できます。デフォルトはcontainsです。range演算については、値の書式は{lower bound}:{upper bound}(たとえば、1:10)です。	文字列
fields	各検索結果の属性名のカンマ区切りのリストを受け入れます。デフォルトでは、各検索結果の名前と説明のみ返されます。	文字列
limit	返されるアイテムの合計数を指定します。	数値
links	リンク名のカンマ区切りのリストを受け入れます。デフォルトでは、このパラメータですべてのリンク(next、prev、first、last、schema、selfおよびcanonicalリソース)が返されます。	文字列
offset	結果を返す開始地点となる開始索引を指定します。	数値
orderBy	結果のソート基準になるフィールドを指定します。使用方法: orderBy=[fieldname]:[asc/des]。注意: Luceneでは、トークン化されていない索引付けフィールドのみソートできます。	文字列
q	問合せ文字列を指定します。これは、構成時に指定された検索エンジン固有の問合せです。(デフォルトの検索エンジンはLuceneです。)	文字列
searchengine	検索に使用する検索エンジンを指定します。デフォルトの検索エンジンはLuceneです。	文字列
totalResults	ブール値を受け入れます。trueに設定すると、レスポンスに結果総数フィールドが表示されます。デフォルトはfalseです。	ブール

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

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

application/json
application/xml

200レスポンス

アセット・タイプに基づいた1つのサイトのすべてのアセットのリスト

例1

次の例に、cURLを使用してRESTリソースに対するGETリクエストを送信し、WebCenter Sitesでavisportsサンプル・サイトの2つのAVIArticle名を取得する方法を示します。REST URLで、selfリンクのみを返すことも指定します。

問合せパラメータの詳細:

"limit=2": 2つの結果のみ必要です。'offset'が指定されていないため、デフォルトは0です。
"links=self": selfリンクのみ表示されます。

curl -i -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/search/sites/avisports/types/AVIArticle/assets?limit=2&links=self"

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

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

Cache-Control: max-age=0 
ETag: "1e0260979bc3b5d5367fb168cd467227d27ec90beeabd274d5c36e61d01fff44" 
Content-Type: application/json;charset=utf-8

例1 レスポンス本文

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

{
  "offset": 0,
  "limit": 100,
  "count": 2,
  "hasMore": true,
  "links": [
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/search/sites/avisports/types/AVIArticle/assets?limit=2&links=self",
      "rel": "self",
      "templated": false,
      "mediaType": "",
      "method": "",
      "profile": ""
    }
  ],
  "items": [
    {
      "name": "Veteran Skier Says Goodbye",
      "link": {
        "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/AVIArticle/1328196047241",
        "rel": "assetReference",
        "templated": false,
        "mediaType": "",
        "method": "GET",
        "profile": ""
      },
      "description": "",
      "id": "AVIArticle:1328196047241"
    },
    {
      "name": "Rookie Skier Makes Her Mark",
      "link": {
        "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/AVIArticle/1328196047309",
        "rel": "assetReference",
        "templated": false,
        "mediaType": "",
        "method": "GET",
        "profile": ""
      },
      "description": "",
      "id": "AVIArticle:1328196047309"
    }
  ]
}

例2

次の例に、cURLを使用してRESTリソースに対するGETリクエストを送信し、WebCenter Sitesでavisportsサンプル・サイトの"H"で始まる2つのAVIArticle名を取得する方法を示します。REST URLで、selfリンクのみを返すことも指定します。

問合せパラメータの詳細:

"limit=2": 2つの結果のみ必要です。'offset'が指定されていないため、デフォルトは0です。
"field:name:startswith=H": 名前が"H"で始まるAVIArticleが必要です。
"links=self": selfリンクのみ表示されます。

curl -i -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/search/sites/avisports/types/AVIArticle/assets?limit=2&links=self&field:name:startswith=H"

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

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

Cache-Control: max-age=0 
ETag: "e515a1e7e9c29bd87cb5ac34628a402671db9b997a1689f26e716b49b3d34663" 
Content-Type: application/json;charset=utf-8

例2 レスポンス本文

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

{
  "offset": 0,
  "limit": 18,
  "count": 2,
  "hasMore": true,
  "links": [
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/search/sites/avisports/types/AVIArticle/assets?field:name:startswith=H&limit=2&links=self",
      "rel": "self",
      "templated": false,
      "mediaType": "",
      "method": "",
      "profile": ""
    }
  ],
  "items": [
    {
      "name": "Hurricanes reaches deal with lefty Porter",
      "link": {
        "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/AVIArticle/1328196049231",
        "rel": "assetReference",
        "templated": false,
        "mediaType": "",
        "method": "GET",
        "profile": ""
      },
      "description": "",
      "id": "AVIArticle:1328196049231"
    },
    {
      "name": "How Dial A Spot",
      "link": {
        "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/AVIArticle/1330367422843",
        "rel": "assetReference",
        "templated": false,
        "mediaType": "",
        "method": "GET",
        "profile": ""
      },
      "description": "",
      "id": "AVIArticle:1330367422843"
    }
  ]
}