1. <ProductName> REST API Oracle WebCenter Sites Aggregate REST APIリファレンス
  2. クイック・スタート

クイック・スタート

Oracle WebCenter Sites Aggregate REST API用に環境を設定します。

前提条件

WebCenter Sitesがインストールされ、稼働している必要があります。

cURLのインストール

このドキュメントの例ではcURLコマンド行ツールを使用してWebCenter Sites Aggregate REST APIへのアクセス方法を示します。cURLの使用の詳細は、「cURLの使用」を参照してください。

次の手順では、Windows 64ビット・システムでのcURLのインストール方法を示します。

  1. ブラウザで、cURLホーム・ページ(http://curl.haxx.se)に移動し、左のナビゲーション・メニューで「Download」をクリックします。

  2. 「cURL Releases and Downloads」ページで、使用しているオペレーティング・システムに対応したcURLソフトウェアのSSL対応バージョンを見つけ、ZIPファイルをダウンロードするリンクをクリックしてソフトウェアをインストールします。

  3. 「cURL CA Certs」ページ(http://curl.haxx.se/docs/caextract.html)にナビゲートし、cURLをインストールしたフォルダにca-bundle.crt SSL CA証明書バンドルをダウンロードします。

  4. コマンド・ウィンドウを開いて、cURLをインストールしたディレクトリにナビゲートし、cURL環境変数CURL_CA_BUNDLEをSSL CA証明書バンドルの場所に設定します。次に例を示します。

    C:\curl> set CURL_CA_BUNDLE=ca-bundle.crt

これで、cURLを使用してOracle WebCenter Portalにリクエストを送信する準備ができました。

最初のリクエスト

この手順では、WebCenter Sites Aggregate REST APIによって提供される基本的なRESTサービスについて順を追って説明します。このステップで、これらのサービスのREST呼出しを行うこともできます。avisportsサンプル・サイトはデモ用です。

  1. アセット・リソース

    このリソースのREST呼出しを行うと、WebCenter Sitesでアセット・データとその依存アセットを取得できます。

    1. 次のcURLコマンドを実行します。

      curl -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/AVIArticle/1328196047241"

      これで、IDが1328196047241のAVIArticleアセットとその依存アセットのデータを取得するREST呼出しが正常に行われました。

    2. 次のcURLコマンドを実行します。

      curl -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/AVIArticle/1328196047241?assetDepth=0"

      これで、IDが1328196047241のAVIArticleアセットのデータを依存アセットを取得せずに取得するREST呼出しが正常に行われました。

      このリソースを完全に理解するには、「アセット・リソース」の「ID、タイプおよびサイトによるアセットとその依存アセットの集約された形式での読取り」を参照してください。

  2. ナビゲーション・リソース

    このリソースのREST呼出しを行うと、WebCenter Sitesでサイトのナビゲーション・データを取得できます。

    1. 次のcURLコマンドを実行します。

      curl -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/navigation"

      これで、avisportsサイト・ナビゲーション・データ(階層上このサイト下にあるすべてのページ)を取得するREST呼出しが正常に行われました。

    2. 次のcURLコマンドを実行します。

      curl -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/navigation?navigationDepth=1"

      これで、avisportsサイト・ナビゲーション・データを取得するが、このサイトの直下のページのみを取得するREST呼出しが正常に行われました。

      このリソースを完全に理解するには、「ナビゲーション・リソース」を参照してください。

  3. コレクション・アセット・リソース

    このリソースのREST呼出しを行うと、WebCenter Sitesで指定したサイトのコレクション・アセット・データとその結果を取得できます。

    1. 次のcURLコマンドを実行します。

      curl -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/ContentQuery/1395380847207/items"

      これで、avisportsサイトのIDが1395380847207のContentQueryアセットの結果を取得するREST呼出しが正常に行われました。

    2. 次のcURLコマンドを実行します。

      curl -H "Accept: application/json" -X GET "http://cnkumar-lap:8080/cs/REST/resources/v1/aggregates/avisports/ContentQuery/1395380847207/items?limit=2"

      これで、avisportsサイトのIDが1395380847207のContentQueryアセットの最初の2つの結果のみを取得するREST呼出しが正常に行われました。

      このリソースを完全に理解するには、「コレクション・アセット・リソース」を参照してください。

  4. 推奨リソース

    このリソースのREST呼出しを行うと、WebCenter Sitesで指定したサイトの推奨アセット・データとその推奨されたアセットを取得できます。

    1. 次のcURLコマンドを実行します。

      curl -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/engage/recommendation/Running%20Recommendation/items"

      これで、avisportsサイトのRunning Recommendationという名前の推奨アセットの推奨されたアセットを取得するREST呼出しが正常に行われました。

    2. 次のcURLコマンドを実行します。

      curl -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/engage/recommendation/Running%20Recommendation/items?limit=2"

      これで、avisportsサイトのRunning Recommendationという名前の推奨アセットの最初の2つの推奨されたアセットのみを取得するREST呼出しが正常に行われました。

      このリソースを完全に理解するには、「推奨リソース」を参照してください。

  5. 検索リソース

    このリソースのREST呼出しを行うと、アセットを検索できます。

    1. 次のcURLコマンドを実行します。

      curl -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/search/sites/avisports/assets"

      これで、avisportsサイトのすべてのアセットを検索するREST呼出しが正常に行われました。

    2. 次のcURLコマンドを実行します。

      curl -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/search/sites/avisports/types/AVIArticle/assets"

      これで、avisportsサイトのAVIArticleアセット・タイプのすべてのアセットを検索するREST呼出しが正常に行われました。

      このリソースを完全に理解するには、「検索リソース」を参照してください。