Oracle® Fusion Middleware

WebCenter Sites REST APIリソース・リファレンス

11g リリース1 (11.1.1.8.0)

E49675-02(原本部品番号:E35835-02)

2013年10月

Oracle Fusion Middleware WebCenter Sites REST APIリソース・リファレンス, 11g リリース1 (11.1.1.8.0)

E49675-02

Copyright © 2012, 2013 Oracle and/or its affiliates. All rights reserved.

このソフトウェアおよび関連ドキュメントの使用と開示は、ライセンス契約の制約条件に従うものとし、知的財産に関する法律により保護されています。ライセンス契約で明示的に許諾されている場合もしくは法律によって認められている場合を除き、形式、手段に関係なく、いかなる部分も使用、複写、複製、翻訳、放送、修正、ライセンス供与、送信、配布、発表、実行、公開または表示することはできません。このソフトウェアのリバース・エンジニアリング、逆アセンブル、逆コンパイルは互換性のために法律によって規定されている場合を除き、禁止されています。

ここに記載された情報は予告なしに変更される場合があります。また、誤りが無いことの保証はいたしかねます。誤りを見つけた場合は、オラクル社までご連絡ください。

このソフトウェアまたは関連ドキュメントを、米国政府機関もしくは米国政府機関に代わってこのソフトウェアまたは関連ドキュメントをライセンスされた者に提供する場合は、次の通知が適用されます。

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

このソフトウェアもしくはハードウェアは様々な情報管理アプリケーションでの一般的な使用のために開発されたものです。このソフトウェアもしくはハードウェアは、危険が伴うアプリケーション(人的傷害を発生させる可能性があるアプリケーションを含む)への用途を目的として開発されていません。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用する際、安全に使用するために、適切な安全装置、バックアップ、冗長性(redundancy)、その他の対策を講じることは使用者の責任となります。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用したことに起因して損害が発生しても、オラクル社およびその関連会社は一切の責任を負いかねます。

OracleおよびJavaはOracle Corporationおよびその関連企業の登録商標です。その他の名称は、それぞれの所有者の商標または登録商標です。

Intel、Intel Xeonは、Intel Corporationの商標または登録商標です。すべてのSPARCの商標はライセンスをもとに使用し、SPARC International, Inc.の商標または登録商標です。AMD、Opteron、AMDロゴ、AMD Opteronロゴは、Advanced Micro Devices, Inc.の商標または登録商標です。UNIXは、The Open Groupの登録商標です。

このソフトウェアまたはハードウェア、そしてドキュメントは、第三者のコンテンツ、製品、サービスへのアクセス、あるいはそれらに関する情報を提供することがあります。オラクル社およびその関連会社は、第三者のコンテンツ、製品、サービスに関して一切の責任を負わず、いかなる保証もいたしません。オラクル社およびその関連会社は、第三者のコンテンツ、製品、サービスへのアクセスまたは使用によって損失、費用、あるいは損害が発生しても一切の責任を負いかねます。

目次

タイトルおよび著作権情報

はじめに

- 対象読者

- ドキュメントのアクセシビリティについて

- 関連ドキュメント

- 表記規則

1 REST API

- 1.1 リソースのデフォルトの場所

- 1.2 RESTリソース

- 1.2.1 アセット・タイプ

- 1.2.2 アセット

- 1.2.3 索引

- 1.2.4 サイト

- 1.2.5 サイト・プランのナビゲーション

- 1.2.6 ロール

- 1.2.7 アプリケーション

- 1.2.8 ユーザー

- 1.2.9 ユーザー・ロケール

- 1.2.10 ユーザー定義

- 1.2.11 ACL

- 1.2.12 グループ

- 1.2.13 地理的位置

- 1.2.14 現在のデバイス

- 1.2.15 推奨

- 1.2.16 セグメント

- 1.2.17 訪問者履歴

はじめに

『Oracle WebCenter Sites REST APIリソース・リファレンス』では、Oracle WebCenter Sitesで提供されるREST APIリソースについて説明します。REST APIは、Oracle WebCenter Sitesデータにアクセスするために使用されます。

対象読者

このガイドは主に開発者向けに作成されています。このガイドでは、開発者が企業のビジネス・ニーズを明確に理解していること、またオンライン・サイトおよびバック・エンド開発における自分の役割について基本的な理解を持っていることを前提としています。このガイドには、コンテンツ管理サイト、サイト・ユーザー、ワークフロー・プロセス、パブリッシュ方法およびOracle WebCenter Sitesのクライアント・オプションを設定することで開発者と協力する、管理者にも役立つ情報が書かれています。

開発者は、Java、JavaServer Pages (JSP)、XMLおよびHTMLに関する知識を持っている必要があります。管理者にプログラミングの経験は必要ありませんが、技術的な背景を理解していることが前提になります。

ドキュメントのアクセシビリティについて

Oracleのアクセシビリティについての詳細情報は、Oracle Accessibility ProgramのWebサイト(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc)を参照してください。

Oracle Supportへのアクセス

Oracleサポート・サービスでは、My Oracle Supportを通して電子支援サービスを提供しています。詳細情報は(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info) か、聴覚に障害のあるお客様は (http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs)を参照してください。

関連ドキュメント

詳細は、Oracle WebCenter Sitesリリース11gR1のドキュメント・セットの次のドキュメントを参照してください。

- Oracle WebCenter Sites動作保証マトリックス

- Oracle Fusion Middleware WebCenter Sitesリリース・ノート

- Oracle Fusion Middleware WebCenter Sitesインストレーション・ガイド

- Oracle Fusion Middleware WebCenter Sitesユーザーズ・ガイド

- Oracle Fusion Middleware WebCenter Sites管理者ガイド

- Oracle WebCenter Sitesタグ・リファレンス

- Oracle WebCenter Sites Java APIリファレンス

次の追加ドキュメントにも有用な情報が含まれている場合があります。

- Oracle Fusion Middleware WebCenter Sitesプロパティ・ファイル・リファレンス

- Oracle WebCenter Sites REST API Beanリファレンス

表記規則

このマニュアルでは次の表記規則を使用します。

規則

意味

太字

太字は、操作に関連するGraphical User Interface要素、または本文中で定義されている用語および用語集に記載されている用語を示します。

イタリック体

イタリックは、ユーザーが特定の値を指定するプレースホルダ変数を示します。

固定幅フォント

固定幅フォントは、段落内のコマンド、URL、サンプル内のコード、画面に表示されるテキスト、または入力するテキストを示します。

1 REST API

Oracle WebCenter Sitesでは、WebCenter SitesデータにアクセスするためのREST APIが提供されます。RESTサービスは、Satellite Serverキャッシュを利用するためにWebCenter SitesとSatellite Serverの両方でサポートされます。

この章の内容は、次のとおりです。

- 第1.1項「リソースのデフォルトの場所」

- 第1.2項「RESTリソース」

1.1 リソースのデフォルトの場所

RESTリソースのデフォルトの場所は、WebCenter Sites BaseURIの下です。

<protocol>://<hostname:port>/<servletPath>/REST/

たとえば、ローカル・インストールではBaseURIは次のようになります。

http://localhost:<port>/cs/REST/

<BaseURI>/application.wadlファイルには、このリファレンスで説明するリソースがリストされています。

1.2 RESTリソース

この項では、リソースが存在しない場合または予想外のエラーが発生した場合に返される要件やエラー・コードを含め、サポートされるRESTリソースおよびメソッドをリストします。

リソース・ビューのタイプ

各リソースには、リストと詳細の2つのタイプのビューがあります。リスト・ビューには、特定のタイプのリソース(たとえば、users)に加え、リソースごとに1つ、詳細ビューをポイントするhrefがリストされます。たとえば、リソース<BaseURI>/usersは、システム内のすべてのユーザーの名前を示すリスト・ビューを返し、その中にはfwadminというユーザーが含まれています。

<users>
<href>http://<hostname>:<port>/cs/REST/users/fwadmin</href>
<name>fwadmin</name>
</users>

fwadminエントリには、fwadminの詳細を確認できる詳細ビューのURLを示す<href>が含まれています。

RESTセキュリティ

次のリストに、RESTリソースのセキュリティ要件を示します。

- /timezoneと/userlocalesを除き、その他すべてのRESTリソースは保護されています。RESTリソースのセキュリティについては、『Oracle Fusion Middleware WebCenter Sites開発者ガイド』および『Oracle Fusion Middleware WebCenter Sites管理者ガイド』を参照してください。

- デフォルトでは、認可の失敗が発生すると、Central Authentication Service (CAS)のログイン・ページが表示されます。かわりに500エラーを受け取るには、リクエスト時にURLにauth-redirect=falseを追加します。

- すべてのREST POST/PUT/DELETEリクエストを有効なものとして認証するには、各リクエストにX-CSRF-Tokenをキーとするヘッダーと、CASチケット(マルチまたはシングル)またはsessionidのいずれかの値が必要です。

この項の残りの部分では、次のリソースについて説明します。

- 第1.2.1項「アセット・タイプ」

- 第1.2.2項「アセット」

- 第1.2.3項「索引」

- 第1.2.4項「サイト」

- 第1.2.5項「サイト・プランのナビゲーション」

- 第1.2.6項「ロール」

- 第1.2.7項「アプリケーション」

- 第1.2.8項「ユーザー」

- 第1.2.9項「ユーザー・ロケール」

- 第1.2.10項「ユーザー定義」

- 第1.2.11項「ACL」

- 第1.2.12項「グループ」

- 第1.2.13項「地理的位置」

- 第1.2.14項「現在のデバイス」

- 第1.2.15項「推奨」

- 第1.2.16項「セグメント」

- 第1.2.17項「訪問者履歴」

1.2.1 アセット・タイプ

すべてのアセット・タイプ

/types

説明

このリソースは、システム内のアセット・タイプのリストを読み取ります。

RESTメソッド

GET

可能性のあるエラー・コード

500 予想外のエラーが発生した場合

選択されたアセット・タイプ

/types/{assettype}

説明

このリソースは、指定されたアセット・タイプに関する詳細情報を表示します。

RESTメソッド

GET、PUT、DELETE

可能性のあるエラー・コード

404 アセット・タイプが存在しない場合

500 予想外のエラーが発生した場合

すべてのサブタイプ

/types/{assettype}/subtypes

説明

このリソースは、指定されたアセット・タイプのすべてのサブタイプを読み取ります。

RESTメソッド

GET

可能性のあるエラー・コード

404 アセット・タイプが存在しない場合

500 予想外のエラーが発生した場合

選択されたサブタイプ

/types/{assettype}/subtypes/{subtype}

説明

このリソースは、指定されたアセット・タイプの指定されたサブタイプを読み取ります。

RESTメソッド

GET

可能性のあるエラー・コード

404 アセット・タイプまたはサブタイプが存在しない場合

500 予想外のエラーが発生した場合

サイト対応アセット・タイプ

/sites/{sitename}/types

説明

このリソースは、指定されたサイトにあるすべてのアセット・タイプをリストします。

RESTメソッド

GET

可能性のあるエラー・コード

404 サイトが存在しない場合

500 予想外のエラーが発生した場合

サイト固有アセット・タイプ検索

/sites/{sitename}/types/{assettype}/search

説明

このリソースは、指定されたサイトにある指定されたアセット・タイプの検索をサポートします。

注意: すべての検索へのアクセスは、AssetリソースでLIST権限を付与することによって提供されます。この場合、検索アクセスはアセット・タイプごとではなく、サイトごとまたはすべてのサイトに対して構成できます。検索サービスにアクセスできるすべてのユーザーは、(特定のサイトが指定されている場合は、そのサイト内の)すべてのアセット・タイプのアセットを検索できます。

RESTメソッド

GET

可能性のあるエラー・コード

404 サイトが存在しない場合

グローバル・アセット・タイプ検索

/types/{assettype}/search

説明

このリソースは、指定されたアセット・タイプの検索をサポートします。

このリソースを機能させるには、WebCenter Sitesでアセット・タイプ索引を構成する必要があります(そうでないと、例外がスローされ、404エラー・コードがユーザーに表示されます)。

注意: すべての検索へのアクセスは、AssetリソースでLIST権限を付与することによって提供されます。この場合、検索アクセスはアセット・タイプごとではなく、サイトごとまたはすべてのサイトに対して構成できます。検索サービスにアクセスできるすべてのユーザーは、(特定のサイトが指定されている場合は、そのサイト内の)すべてのアセット・タイプのアセットを検索できます。

問合せパラメータ

- q
問合せ文字列を指定します。これは、索引構成時に指定された検索エンジン固有の問合せです。(デフォルトの検索エンジンはLuceneです。)

- field:[fieldname]:[Operation]
[fieldname]のフィールドに対する問合せ条件を指定します。[Operation]はオプションで、equals、range、startswith、phrase、wildcard、similarまたはcontainsのいずれかを指定できます。デフォルトはcontainsです。range演算については、値の書式は{lower bound}:{upper bound}(たとえば、1:10)です。最初に指定された値のみが検索で使用されます。

- startindex
結果を返す開始地点となる開始索引を指定します。

- count
返されるアイテムの合計数を指定します。

- sortfield:[fieldname]:[asc/des]
結果のソート基準になるフィールドを指定します。

注意: Luceneでは、トークン化されていない索引付けフィールドのみソートできます。

例:

http://<hostname>:<port>/cs/REST/types/Content_
C/search?field:name:contains=FSII&startindex=5&count=3

RESTメソッド

GET

可能性のあるエラー・コード

404 索引付け構成が存在しない場合

500 予想外のエラーが発生した場合

1.2.2 アセット

選択されたアセット、選択されたサイト

/sites/{sitename}/types/{assettype}/assets/{id}

説明

このリソースは、指定されたアセットで操作するためのCreate、Edit、Update、Delete(CRUD)機能を開発者に提供します。{id}は長いアセットID書式です。

RESTメソッド

HEAD、GET、POST、PUT、DELETE

可能性のあるエラー・コード

404 サイトが存在しない場合

404 アセット・タイプが存在しない場合

404 アセットが存在しない場合

500 予想外のエラーが発生した場合

すべてのアセットのアソシエーション、選択されたサイト

/sites/{sitename}/types/{assettype}/assets/{id}/associations

説明

このリソースは、指定されたサイトにあるすべてのアセットのアソシエーションをリストします。

RESTメソッド

GET

可能性のあるエラー・コード

404 サイトが存在しない場合

404 アセット・タイプが存在しない場合

404 アセットが存在しない場合

500 予想外のエラーが発生した場合

選択されたアセットのアソシエーションおよびサイト

/sites/{sitename}/types/{assettype}/assets/{id}/associations/
{assocName}

説明

このリソースは、指定されたサイトにある指定されたアセットのアソシエーションをリストします。

RESTメソッド

GET

可能性のあるエラー・コード

404 サイトが存在しない場合

404 アセット・タイプが存在しない場合

404 アセットが存在しない場合

500 予想外のエラーが発生した場合

サイト固有アセット検索

/sites/{sitename}/search

説明

このリソースは、指定されたサイトにあるすべてのアセットの検索をサポートします。

注意: すべての検索へのアクセスは、AssetリソースでLIST権限を付与することによって提供されます。この場合、検索アクセスはアセット・タイプごとではなく、サイトごとまたはすべてのサイトに対して構成できます。検索サービスにアクセスできるすべてのユーザーは、(特定のサイトが指定されている場合は、そのサイト内の)すべてのアセット・タイプのアセットを検索できます。

RESTメソッド

GET

可能性のあるエラー・コード

404 サイトが存在しない場合

グローバル・アセット検索

/search

説明

このリソースは、アセットでのグローバル検索をサポートします。

注意: RESTは、返されるアセットのタイプを制限しません。このため、特定のアセット・タイプへのアクセス権を持っていないユーザーに、そのタイプのアセットが返される可能性があります。

注意: すべての検索へのアクセスは、AssetリソースでLIST権限を付与することによって提供されます。この場合、検索アクセスはアセット・タイプごとではなく、サイトごとまたはすべてのサイトに対して構成できます。検索サービスにアクセスできるすべてのユーザーは、(特定のサイトが指定されている場合は、そのサイト内の)すべてのアセット・タイプのアセットを検索できます。

問合せパラメータ

- q
問合せ文字列を指定します。これは、索引構成時に指定された検索エンジン固有の問合せです。(デフォルトの検索エンジンはLuceneです。)

- field:[fieldname]:[Operation]
[fieldname]のフィールドに対する問合せ条件と指定された演算を指定します。[Operation]はオプションで、equals、range、startswith、phrase、wildcard、similarまたはcontainsのいずれかを指定できます。デフォルトはcontainsです。range演算については、値の書式は{lower bound}:{upper bound}(たとえば、1:10)です。

- startindex
結果を返す開始地点となる開始索引を指定します。

- count
返されるアイテムの合計数を指定します。

- sortfield:[fieldname]:[asc/des]
結果のソート基準になるフィールドを指定します。

注意: Luceneでは、トークン化されていない索引付けフィールドのみソートできます。

例:

http://<hostname>:<port>/cs/REST/types/Content_
C/search?field:name:contains=FSII&startindex=5&count=3

RESTメソッド

GET

可能性のあるエラー・コード

500 予想外のエラーが発生した場合

1.2.3 索引

索引付け構成

/indexes

説明

このリソースは、グローバル索引付けとアセット・タイプに基づく索引付けの構成をリストします。グローバル索引付けでは、すべてのアセット・タイプに対して1つの索引が作成されます。アセット・タイプ索引付けでは、アセット・タイプごとに1つの索引が作成されます。

RESTメソッド

GET、PUT、POST、DELETE

可能性のあるエラー・コード

404 索引付け構成が存在しない場合

500 予想外のエラーが発生した場合

索引付け構成

/indexes/{source}

説明

このリソースは、グローバル索引付けの構成をサポートし、グローバル索引付け構成およびアセット・タイプ別索引付け構成における操作のためにCRUD機能を提供します。グローバル索引付けでは、すべてのアセット・タイプに対して1つの索引が作成されます。アセット・タイプ索引付けでは、アセット・タイプごとに1つの索引が作成されます。

注意: このリソースのURLでは、ソースはGlobal(グローバル索引の場合)またはアセット・タイプの名前(各アセット・タイプに基づく索引の場合)です。アセット・タイプに基づく索引付けの場合、選択したHTTPメソッド(PUT、POST、DELETE)と索引ステータス(ENABLED、PAUSED)に応じて、索引付けプロセスの自動的な開始、停止、一時停止または再開も行われます。グローバル索引付けは、デフォルトではすべてのアセット・タイプに対して有効になっています(ただし、構成が存在しない可能性もあります)。

RESTメソッド

GET、POST、PUT、DELETE

可能性のあるエラー・コード

404 索引付け構成が存在しない場合

500 予想外のエラーが発生した場合

1.2.4 サイト

すべてのサイト

/sites

説明

このリソースは、システムにあるすべてのサイトをリストします。

RESTメソッド

GET

可能性のあるエラー・コード

500 予想外のエラーが発生した場合

選択されたサイト

/sites/{sitename}

説明

このリソースは、指定されたサイトで操作するためのCRUD機能を開発者に提供します。

サイトでCRUD操作を実行するには、ユーザーはグループを介して付与された権限に加え、そのサイトでGeneralAdminまたはSiteAdminロールを持っている必要があります。AdminSiteを管理するには、ユーザーはGeneralAdminロールを持っている必要があります。

RESTメソッド

HEAD、GET、POST、PUT、DELETE

可能性のあるエラー・コード

404 サイトが存在しない場合

500 予想外のエラーが発生した場合

1.2.5 サイト・プランのナビゲーション

パブリケーション・ノード

/sites/{sitename}/navigation

説明

このリソースは、{sitename}によって指定されたサイトのサイト・プラン・ツリーを読み取ります。このリソースにアクセスするには、対応するサイト・リソースでREAD権限を持っている必要があります。このサービスに定義されている問合せパラメータは次のとおりです。

- depth: サイト・プラン・ツリーの読取りが可能な深さを制御します。
デフォルト値: 1

許容される値: 整数、または最大深度まで読み取る場合は文字列all(大/小文字の区別なし)。

- code: 読み取られるサイト・プラン・ノードのタイプ(配置済または未配置)を制御します。デフォルトでは、配置済ページと未配置ページの両方が読み取られて返されます。このパラメータの値は大/小文字を区別しません。

サイト・プラン・ツリーの詳細は、『Oracle Fusion Middleware WebCenter Sites開発者ガイド』を参照してください。

RESTメソッド

GET

可能性のあるエラー・コード

400 深さの解析で例外が発生しました。

400 深さが0以下です。

403 ユーザーに権限がありません。

404 サイトが存在しません。

500 サイトにサイト・プラン・パブリケーション・ノードがありません。

500 その他の予想外のエラーが発生しました。

ページ・ノード

/sites/{sitename}/navigation/{pageid}

説明

このリソースは、{sitename}によって指定されたサイトと{pageid}によってルートとして指定されたページのサイト・プラン・サブツリーを読み取ります。このリソースにアクセスするには、少なくともpageidによって指定されたページ・アセット・リソースに対してREAD権限を持っている必要があります。このサービスに定義されている問合せパラメータは次のとおりです。

depth: サイト・プラン・サブツリーの読取りが可能な深さを
制御します。

デフォルト値: 1

許容される値: 整数、または最大深度まで読み取る場合は文字列all(大/小文字の区別なし)。

サイト・プラン・ツリーの詳細は、『Oracle Fusion Middleware WebCenter Sites開発者ガイド』を参照してください。

RESTメソッド

GET

可能性のあるエラー・コード

400 Pageアセット・タイプがサイトで有効ではありません。

400 深さの解析で例外が発生しました。

400 深さが0以下です。

403 ユーザーに権限がありません。

404 サイトまたはページ・アセット(あるいはその両方)が存在しません。

500 ノード・パスがページに対してNULLです。

500 ページのノード・パスにノード要素が存在しません。

500 ルート・ノードがページのパブリケーション・ノードではありません。

500 子ノードに一貫性がありません。

500 その他の予想外のエラーが発生しました。

1.2.6 ロール

すべてのロール

/roles

説明

このリソースは、システムに格納されているロールのリストを読み取ります。

RESTメソッド

GET

可能性のあるエラー・コード

500 予想外のエラーが発生した場合

選択されたロール

/roles/{rolename}

説明

このリソースは、指定されたロールで操作するためのCRUD機能を提供します。

RESTメソッド

GET、POST、PUT、DELETE

可能性のあるエラー・コード

404 ロールが存在しない場合

500 予想外のエラーが発生した場合

1.2.7 アプリケーション

すべてのアプリケーション

/applications

説明

このリソースは、登録済のアプリケーションをリストします。

RESTメソッド

GET

可能性のあるエラー・コード

500 予想外のエラーが発生した場合

選択されたアプリケーション

/applications/{applicationid}

説明

このリソースは、アプリケーションのFW_ViewおよびFW_ApplicationアセットでCRUD操作を実行することにより、指定されたアプリケーションを登録します。アプリケーション登録の詳細は、『Oracle Fusion Middleware WebCenter Sites開発者ガイド』を参照してください。

RESTメソッド

GET、PUT、POST、DELETE

可能性のあるエラー・コード

404 アプリケーションが存在しない場合

500 予想外のエラーが発生した場合

1.2.8 ユーザー

すべてのユーザー

/users

説明

このリソースは、システムに定義されているすべてのユーザーをリストします。

RESTメソッド

GET

可能性のあるエラー・コード

500 予想外のエラーが発生した場合

選択されたユーザー

/users/{username}

説明

このリソースは、指定されたユーザーで操作するためのCRUD機能を提供します。ユーザー・プロファイルにイメージが含まれている場合、サービスによって90 x 90ピクセルのサムネイル・イメージが返されます。異なるサイズでサムネイル・イメージが必要な場合、パラメータimageHeightおよびimageWidth(ピクセル単位)を使用してリクエストできます。これにより、指定されたサイズでサムネイル・イメージが返されます。実際にアップロードされたイメージは、ユーザー情報がリクエストされたときに常に元のサイズで返されます。ユーザー・サービスによってサムネイル・イメージのみが返され、実際のイメージは返されないように制限するには、thumbOnlyパラメータをtrueに設定します。

otherAttributesフィールドは、カスタム・ユーザー属性のプレースホルダを提供します。カスタム・ユーザー属性は、LDAPまたはWebCenter SitesデータベースでWebCenter Sitesユーザーを作成するときに定義します。(LDAPの場合、各ユーザーはdir.iniのpeopleParentプロパティに指定された値の子になることに注意してください。peopleParentプロパティの値は、LDAPとの統合中に設定されます。)

カスタム・ユーザー属性がどこで作成されるかに関係なく、WebCenter Sitesアプリケーションで有効にするには、それらをWebCenter Sitesのdir.iniファイルのrequiredPeopleAttrsプロパティで、次の形式でキーと値のペアとして指定する必要があります。

requiredPeopleAttrs=
attribute1=description1&attribute2=description2

キーはWebCenter Sitesデータベース(またはLDAP)に表示される属性名で、値はWebCenter Sitesインタフェースに表示される属性の説明です。このプロパティは、ユーザー属性の定義時にWebCenter Sites管理インタフェースとREST APIの両方によって参照されます。

説明(続き)

たとえば、Phone numberとFaxという2つの属性をすべてのユーザーに対して指定するには、次の手順を実行します。

1. Phone numberとFaxという2つの属性を定義します。WebCenter Sitesを使用している場合は、これらをユーザー属性として定義します(これらはSystemUserAttr表に格納されます)。

2. WebCenter Sitesのdir.iniファイルで、属性参照をrequiredPeopleAttrsプロパティに次のように指定します。requiredPeopleAttrs=phone=Phone number&fax=Fax

3. 前述の構成により、WebCenter Sites管理インタフェースとWEM管理インタフェースのユーザー・アカウント・フォームにPhone numberとFaxが属性として表示されるようになります。

4. Phone number:12345678および
Fax:23456789のユーザーを作成する場合、ユーザーURI /users/{username}でRESTリクエストを呼び出すと、otherAttributesフィールドに次の情報が指定されます。

<otherAttributes>
<name>phone</name>
<value>12345678</value>
</otherAttributes>
<otherAttributes>
<name>fax</name>
<value>23456789</value>
</otherAttributes>

RESTメソッド

HEAD、GET、POST、PUT、DELETE

可能性のあるエラー・コード

404 ユーザーが存在しない場合

500 予想外のエラーが発生した場合

すべてのサイト・ユーザー

/sites/{sitename}/users

説明

このリソースは、指定されたサイトのすべてのユーザーのロールをリストします。

RESTメソッド

GET

可能性のあるエラー・コード

404 サイトが存在しない場合

500 予想外のエラーが発生した場合

選択されたサイト・ユーザー

/sites/{sitename}/users/{username}

説明

このリソースは、指定されたサイト上の指定されたユーザーのロールをリストし、次にリストするRESTメソッドをサポートします。

RESTメソッド

GET

可能性のあるエラー・コード

404 サイトが存在しない場合

404 ユーザーが存在しない場合

500 予想外のエラーが発生した場合

1.2.9 ユーザー・ロケール

/userlocalesリソースは保護されていません。

ユーザー・ロケール

/userlocales

説明

このリソースは、システムに定義されているすべてのロケールをリストします。

RESTメソッド

GET

可能性のあるエラー・コード

500 予想外のエラーが発生した場合

1.2.10 ユーザー定義

ユーザー定義

/userdef

説明

このリソースは、ユーザー・プロファイルの属性を読み取ります。認証のためにデータベースが使用される場合、WebCenter Sitesの事前定義済ユーザー属性のみが返されます。LDAPが使用される場合は、事前定義済のWebCenter Sites属性に加え、dir.iniファイルのrequiredPeopleAttrsプロパティに定義されている属性が返されます。

RESTメソッド

GET

可能性のあるエラー・コード

500 予想外のエラーが発生した場合

1.2.11 ACL

ACL

/acls

説明

このリストは、WebCenter Sitesに定義されているすべてのACLをリストします。

RESTメソッド

GET

可能性のあるエラー・コード

500 予想外のエラーが発生した場合

1.2.12 グループ

すべてのグループ

/groups

説明

このリソースは、システム内のすべてのRESTセキュリティ・グループをリストします。

RESTメソッド

GET

可能性のあるエラー・コード

500 予想外のエラーが発生した場合

選択されたグループ

/groups/{groupname}

説明

このリソースは、指定されたグループのセキュリティ権限構成を提供します。

RESTメソッド

GET

可能性のあるエラー・コード

404 リクエストされたグループが見つからない場合

1.2.13 地理的位置

/timezoneリソースは保護されていません。

タイムゾーン

/timezone

説明

このリソースは、サーバーのタイムゾーンを返します。

RESTメソッド

GET

可能性のあるエラー・コード

500 予想外のエラーが発生した場合

1.2.14 現在のデバイス

現在のデバイス情報

/currentdevice

説明

このサービスは、HTTPリクエストのUser-Agentヘッダーからデバイス情報を取得し、一致するデバイスとデバイス・グループ情報をDeviceBeanの形式で返します。現在のデバイス・リポジトリにUser-Agentが存在しており、そのリポジトリに指定されているとおりのデバイス機能を持っている場合は、返されたDeviceBeanにDeviceCapabilites Beanが含まれます。

例:

Input to the service is User-Agent header.
Behavior of service for different cases -
Case 1) User-Agent is present in device repository and
a) User-Agent matches to a device group -
Result:    A DeviceBean with following info
is returned -
DeviceBean
{
Name of device;
User Agent of device;
DeviceGroupBean; //A bean
representing a matching
device group, with
details such as name,
suffix, priority.
DeviceCapabilitiesBean; //A
bean representing all
device capabilities as
present in current device
repository.
}

b) User-Agent does not match to any device group -
Result: A DeviceBean with name of device as
present in repository, its capabilities as
DeviceCapabilitiesBean and matching device
group as default one i.e. Desktop device
group.

Case 2) User-Agent is NOT present in device repository(In
which case DeviceCapabilitiesBean will not be
returned, as capabilities are read from device
repository) and

説明(続き)

a) User-agent matches to a device group based on
user-agent regular expression as a criteria
defined in some Device Group -
Result:   A DeviceBean with name as 'Unknown
Device',its user-agent and a DeviceGroupBean
with info about matched DeviceGroup. NO
DeviceCapabilitiesBean.

b) User-Agent does not match to any device group.
The default device group DESKTOP will be
returned as matching device group.
Result: A DeviceBean with name as 'Unknown
Device',it's user-agent and DESKTOP
DeviceGroupBean."

RESTメソッド

GET

可能性のあるエラー・コード

500 予想外のエラーが発生した場合

1.2.15 推奨

選択された推奨

/sites/{sitename}/engage/recommendation/{recommendation}

説明

このリソースは、指定されたサイトのコンテキストにおける推奨アセットを提供します。fieldsパラメータを使用して、推奨アセットで取得および移入される属性を指定できます。また、segmentsパラメータを使用して、結果に含めるセグメントのカンマ区切りリストも指定できます。

パラメータ:

- visitorid (必須): ユーザーのIDまたはユーザー名。

- fields: 推奨アセットから取得される属性のカンマ区切りリスト。属性name、idおよびdescriptionはデフォルトで選択されます。
例: fields=name,id,createdby,updatedby,description

- segments: 結果に含めるセグメントのカンマ区切りリスト。

URLの例: http://localhost:8080/cs/REST/sites/FirstSiteII/engage/recommendation/SportsRecommendation?fields=name,id,description,createdby,updatedby&visitorid=hellouser

RESTメソッド

GET

可能性のあるエラー・コード

404 サイトまたは推奨が存在しない場合

500 予想外のエラーが発生した場合

1.2.16 セグメント

選択されたセグメント

/sites/{sitename}/engage/segments

説明

このサービスは、セグメントの名前付きセットのセグメント詳細または訪問者のセグメント詳細を提供します。

パラメータ:

- visitorid (必須): ユーザーの訪問者IDまたはユーザー名。

- segments: セグメントのカンマ区切りリスト。
例: ?segments=seg1,seg2,seg3

- fields: 結果に含めるセグメント・アセットの各フィールドのカンマ区切りリスト。フィールドname、descriptionおよびidはデフォルトで含められます。
例: fields=name,id,createdby,updatedby,description

URLの例:

- セグメントのリストのセグメント詳細を取得するには:

http://localhost:8080/cs/REST/sites/FirstSiteII/engage/segments?segments=Seg1,Seg2&fields=name,updatedby&visitorid=username

- 訪問者のセグメント詳細を取得するには:

http://localhost:8080/cs/REST/sites/FirstSiteII/engage/segments?visitorid=usern

RESTメソッド

GET

可能性のあるエラー・コード

404 サイトが存在しない場合

500 予想外のエラーが発生した場合

1.2.17 訪問者履歴

訪問者履歴

/visitor/visitorhistory

説明

このリソースは、訪問者の履歴を取得して記録するための各インタフェースを提供します。訪問者履歴を記録するには、履歴属性を次の形式で指定する必要があります。

?visitorid=testuser&historyDef=LoginRecord&
param1=attributeName1&value1=valueOfAttributeName1

パラメータ:

- visitorid (必須): ユーザーのIDまたはユーザー名。

- historyDef (必須): 取得中または記録中の履歴定義。

- fields: 結果に含める訪問者履歴の各フィールドのカンマ区切りリスト。フィールドname、descriptionおよびidはデフォルトで含められます。

例: fields=name,id,createdby,updatedby,description

RESTメソッド

GET、POST

可能性のあるエラー・コード

500 予想外のエラーが発生した場合

オラクル社の法律上の注意点について

コピーライトについて

Copyright © 1994-2014, Oracle and/or its affiliates.All rights reserved.

商標と登録商標について

OracleおよびJavaはOracle Corporationおよびその関連企業の登録商標です。その他の名称は、それぞれの所有者の商標または登録商標です。

Intel、Intel Xeonは、Intel Corporationの商標または登録商標です。すべてのSPARCの商標はライセンスをもとに使用し、SPARC International, Inc.の商標または登録商標です。AMD、Opteron、AMDロゴ、AMD Opteronロゴは、Advanced Micro Devices, Inc.の商標または登録商標です。UNIXは、The Open Groupの登録商標です。

ライセンス制約の保証と結果的に生じる損害の免責

このソフトウェアおよび関連ドキュメントの使用と開示は、ライセンス契約の制約条件に従うものとし、知的財産に関する法律により保護されています。ライセンス契約で明示的に許諾されている場合もしくは法律によって認められている場合を除き、形式、手段に関係なく、いかなる部分も使用、複写、複製、翻訳、放送、修正、ライセンス供与、送信、配布、発表、実行、公開または表示することはできません。このソフトウェアのリバース・エンジニアリング、逆アセンブル、逆コンパイルは互換性のために法律によって規定されている場合を除き、禁止されています。

保証免責

ここに記載された情報は予告なしに変更される場合があります。また、誤りが無いことの保証はいたしかねます。誤りを見つけた場合は、オラクル社までご連絡ください。

制限付権利

このソフトウェアまたは関連ドキュメントを、米国政府機関もしくは米国政府機関に代わってこのソフトウェアまたは関連ドキュメントをライセンスされた者に提供する場合は、次の通知が適用されます。

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs.No other rights are granted to the U.S. Government.

危険な用途への使用について

このソフトウェアもしくはハードウェアは様々な情報管理アプリケーションでの一般的な使用のために開発されたものです。このソフトウェアもしくはハードウェアは、危険が伴うアプリケーション（人的傷害を発生させる可能性があるアプリケーションを含む）への用途を目的として開発されていません。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用する際、安全に使用するために、適切な安全装置、バックアップ、冗長性（redundancy）、その他の対策を講じることは使用者の責任となります。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用したことに起因して損害が発生しても、オラクル社およびその関連会社は一切の責任を負いかねます。

第三者のコンテンツ、製品、サービスに対する免責事項

このソフトウェアまたはハードウェア、そしてドキュメントは、第三者のコンテンツ、製品、サービスへのアクセス、あるいはそれらに関する情報を提供することがあります。オラクル社およびその関連会社は、第三者のコンテンツ、製品、サービスに関して一切の責任を負わず、いかなる保証もいたしません。オラクル社およびその関連会社は、第三者のコンテンツ、製品、サービスへのアクセスまたは使用によって損失、費用、あるいは損害が発生しても一切の責任を負いかねます。

ドラフトのアルファ版およびベータ版ドキュメントについて

このドキュメントが試作版の場合:

このドキュメントは試作版であり、デモおよび暫定使用のみを目的としたものです。このソフトウェアを使用するハードウェアに限定するものではありません。オラクル社およびその関連会社は、このドキュメントに関して一切の責任を負わず、いかなる保証もいたしません。また、このドキュメントを使用したことによって損失、費用、あるいは損害が発生しても、一切の責任を負いかねます。