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

ID、タイプおよびサイトによるアセットとその依存アセットの集約された形式での読取り

get

/resources/v1/aggregates/{siteName}/{assetType}/{assetId}

リソース・エンドポイントは、指定されたサイト名に属する指定されたアセットおよび任意の深さまでのその依存アセットに関する情報を返します。これは、単数リソースです。

重要な注意: レスポンスの形式は、集約されたアセット形式です。集約されたアセット・レスポンスにはすべて'start'フィールドが含まれます。次に述べるルート・アセットは、レスポンス内の'start'キーの値が示すアセットです。このアセットは、レベル0の開始アセット(リクエストされたアセット、ここでは{assetId})です。このルート・アセットを介して、レスポンス内の下位レベルのすべての依存アセットにナビゲートする必要があります。

特別なケース: ルート・アセットまたは任意の深さの任意の依存アセットのタイプがContentQueryやRecommendationなどのコレクション・アセット・タイプの場合、アセット・データに加えて結果がコレクション・アセットとしても評価され、アイテム配列で返されます。デフォルトの結果数は10です。各アイテムも集約されたアセットで、問合せパラメータはこれにも適用されます。WebCenter Sites集約REST APIでは、collection-asset-resourceを介したコレクション・リソースへのアクセスおよびrecommendation-resourceを介した推奨アセットへのアクセスが推奨されます。結果の数およびページネーションを制御できるためです。

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

パス・パラメータ

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

問合せパラメータ

名前	説明	形式
assetDepth	任意の正の整数または文字列"all"を受け入れます。整数のアセットの深さで、どのツリー・レベルまで依存アセットをトラバースするかを定義します。文字列"all"は全体のことです。デフォルト値は2です。assetDepth値が無効(負の数値)の場合、デフォルトのassetDepth値が使用されます。	文字列
expand	これは、レスポンスに展開するアセット・タイプの制御に使用されます。アセット・タイプのセミコロン区切りのリストを受け入れます。これらのアセット・タイプのアセットは展開されます。他のアセット・タイプは展開されません。ただし、ルート・アセット(参照: リソースの説明内の注意)は常に展開されます。デフォルトでは、すべてのアセット・タイプが展開されます。リストでアセット・タイプの前にNOT演算子(!)を置くと、そのアセット・タイプを展開から除外することを示します。次に例を示します。 expand=assetType1,assetType2は、'assetType1'および'assetType2'のアセットのみ展開することを意味します。 expand=!assetType1,!assetType2は、'assetType1'および'assetType2'以外のすべてのアセットを展開することを意味します。	文字列
fields	これは、レスポンスでAssetTypeについて返す属性の制御に使用されます。この問合せパラメータは、指定された深さ以内にこのassetTypeのアセットが出現し、そのassetTypeの展開が許可されている場合にのみ機能します。assetType1(attr1,attr2)の形式のアセット・タイプに対する属性のカンマ区切りのリストを受け入れます。これは、assetType1のattr1およびattr2のみを返すということです。アセット・タイプが指定されない場合、fieldsパラメータの属性はルート・アセット(参照: リソースの説明内の注意)のみに適用されます。fields問合せパラメータが指定されない場合、デフォルトではすべての属性が返されます。このパラメータには、次のようにワイルドカードを含めることができます *fields=(attr1,attr2)では、すべてのアセット・タイプについてattr1およびattr2のみが返されます。 fields=!(attr1,attr2,attr3)では、すべてのアセット・タイプについてatt1、attr2およびattr3以外のすべての属性が返されます。 fields=!attr1,attr2*では、ルート・アセットについてattr1およびattr2以外のすべての属性が返されます。	文字列
links	リンク名のカンマ区切りのリストを受け入れます。デフォルトでは、このパラメータですべてのリンク(schema、selfおよびcanonicalリソース)が返されます。	文字列
profileName	訪問者サービス・プロファイル名を受け入れます。このprofileNameは、結果を評価するために任意の深さに出現する推奨アセットに適用されます。	文字列
segments	サイト内に存在するセグメント名のカンマ区切りのリストを受け入れます。これらのセグメントは、結果を評価するために任意の深さに出現する推奨アセットに適用されます。セグメントが指定されない場合、このパラメータはデフォルト・セグメントを使用します。	文字列

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

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

application/json

200レスポンス

集約された形式のアセットのデータ

例1

次の例に、cURLを使用してRESTリソースに対するGETリクエストを送信し、WebCenter Sitesでavisportsサンプル・サイトのIDが1328196047241のAVIArticleアセットのnameおよびcreateddate値のみを取得する方法を示します。詳細は、「cURLの使用」を参照してください。

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

"fields=name,createddate": ルート・アセット(AVIArticle:1328196047241)のこれらの属性のみ必要です。
"expand=AVIArticle": ルート・アセットに対して親アセットが存在する場合、デフォルトでは親アセットは展開されます。ルート・アセットには親アセットArticleCategory:1327351719208があります。ここでは、ルート・アセットのみが必要です。そのため、タイプAVIArticleのアセットのみを展開するよう指定することで、親を含む他のアセット・タイプのアセットの展開を制限しています。

curl -i -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/AVIArticle/1328196047241?fields=name,createddate&expand=AVIArticle"

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

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

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

例1 レスポンス本文

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

{
  "start": "AVIArticle:1328196047241",
  "links": [
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/AVIArticle/1328196047241?fields=name,createddate&expand=AVIArticle",
      "rel": "self",
      "templated": false,
      "mediaType": "",
      "method": "",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/AVIArticle/1328196047241?fields=name,createddate&expand=AVIArticle",
      "rel": "canonical",
      "templated": false,
      "mediaType": "",
      "method": "",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/AVIArticle/1328196047241",
      "rel": "describedby",
      "templated": false,
      "mediaType": "application/schema+json",
      "method": "GET",
      "profile": ""
    }
  ],
  "AVIArticle:1328196047241": {
    "name": "Veteran Skier Says Goodbye",
    "createddate": {
      "value": "2012-04-27T13:38:49.777Z",
      "timezone": "India Standard Time",
      "description": ""
    },
    "parents": [
      {
        "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/ArticleCategory/1327351719208",
        "rel": "assetReference",
        "templated": false,
        "mediaType": "",
        "method": "GET",
        "profile": ""
      }
    ]
  }
}

例2

次の例に、cURLを使用してRESTリソースに対するGETリクエストを送信し、WebCenter Sitesでavisportsサンプル・サイトのIDが1328196047241のAVIArticleアセットの名前および深さ1の関連イメージ・アセットの名前を取得する方法を示します。

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

"assetDepth=1": 深さ1の関連イメージ(依存アセット)の詳細が必要です。このため、深さ1までの集約アセット・データが必要です。
"fields=name,relatedImage;AVIImage(name)": (1) ルート・アセット(AVIArticle:1328196047241)のnameおよびrelatedImage属性および(2) relatedImageアセットのname属性が必要です。
"expand=AVIArticle,AVIImage": タイプAVIArticleのルート・アセットとタイプAVIImageのそのrelatedImageアセットのみが必要です。そのため、この問合せパラメータを使用して他のすべてのアセットの展開を制限しています。

curl -i -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/AVIArticle/1328196047241?assetDepth=1&fields=name,relatedImage;AVIImage(name)&expand=AVIArticle,AVIImage

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

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

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

例2 レスポンス本文

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

{
  "AVIImage:1327351719292": {
    "name": "Yellow Skier",
    "parents": [
      {
        "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/ImageCategory/1327351718428",
        "rel": "assetReference",
        "templated": false,
        "mediaType": "",
        "method": "GET",
        "profile": ""
      }
    ]
  },
  "start": "AVIArticle:1328196047241",
  "links": [
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/AVIArticle/1328196047241?expand=AVIArticle,AVIImage&fields=name,relatedImage;AVIImage(name)&assetDepth=1",
      "rel": "self",
      "templated": false,
      "mediaType": "",
      "method": "",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/AVIArticle/1328196047241?expand=AVIArticle,AVIImage&fields=name,relatedImage;AVIImage(name)&assetDepth=1",
      "rel": "canonical",
      "templated": false,
      "mediaType": "",
      "method": "",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/AVIArticle/1328196047241",
      "rel": "describedby",
      "templated": false,
      "mediaType": "application/schema+json",
      "method": "GET",
      "profile": ""
    }
  ],
  "AVIArticle:1328196047241": {
    "name": "Veteran Skier Says Goodbye",
    "relatedImage": {
      "id": 1327351719292,
      "type": "AVIImage"
    },
    "parents": [
      {
        "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/ArticleCategory/1327351719208",
        "rel": "assetReference",
        "templated": false,
        "mediaType": "",
        "method": "GET",
        "profile": ""
      }
    ]
  }
}