| Oracle® Fusion Middleware Oracle WebCenter PortalおよびOracle JDeveloperでのポータルの開発 11gリリース1 (11.1.1.9.0) E49666-05 |
|
 前 |
 次 |
| Oracle® Fusion Middleware Oracle WebCenter PortalおよびOracle JDeveloperでのポータルの開発 11gリリース1 (11.1.1.9.0) E49666-05 |
|
前 |
次 |
この章では、ピープル・コネクションに関連するREST APIについて説明します。
この章の内容は、次のとおりです。
アクティビティ・ストリームREST APIを使用して、アクティビティ・ストリームにおけるユーザーのアプリケーション・アクティビティを参照します。この項では、このアクションを実行するために使用できるREST APIメソッドの情報を提供します。
この項には次のサブセクションが含まれます:
|
注意: REST APIは、多様な方法で構成できるので、ユーザーのアクティビティの一部を返さずに、RESTクライアントでFrameworkアプリケーションとは別にアクティビティ・ストリームがどのように動作するのかをカスタマイズできるようにすることが可能です。 |
各RESTサービスは、そのサービスのエントリ・ポイントを提供するリソース索引内にリンク要素を持っています。ピープル・コネクションでは、各機能に独自のリンク要素があります。たとえば、ピープル・コネクションのアクティビティ・ストリーム機能のエントリ・ポイントを見つけるには、次のresourceTypeを持つリンク要素を見つけます。
urn:oracle:webcenter:activities:stream
対応するhrefまたはtemplate要素によって、URIエントリ・ポイントが提供され、それによってアクティビティ・ストリームから現在のユーザーのアプリケーション・アクティビティが取得されます。クライアントは、このエントリ・ポイントにHTTPリクエストを送信し、ピープル・コネクションのアクティビティ・ストリーム機能を使用します。
クライアントがエントリ・ポイントを識別すると、リソース・タイプの分類によりナビゲートして、必要な操作を実行できます。個々のリソース・タイプの詳細は、第42.1.4項「アクティビティ・ストリーム・リソース・タイプ」の該当の項を参照してください。
ピープル・コネクションのアクティビティ・ストリーム機能のリソース・タイプの分類は、次のとおりです。
urn:oracle:webcenter:activities:stream urn:oracle:webcenter:activities:activity
ピープル・コネクションREST APIのいずれかにアクセスするには、RESTサービスにログインする必要があります。その後、基礎となるサービスにより、権限の確認などが処理されます。
この項では、各リソース・タイプについて知っておく必要があるすべての情報を提供します。次のサブセクションが含まれます:
urn:oracle:webcenter:activities:stream
streamレスポンスには、アクティビティ・ストリームからのアクティビティの取得に使用するURIが含まれます。
ユーザーのストリームからアクティビティを取得するか、ユーザーのコネクションのストリームからアクティビティを取得できます。どのアクティビティを取得するのかをより細かく制御するには、アクティビティ・ストリーム問合せフィルタを使用します。問合せフィルタを使用すると、次のことを実行できます。
問合せ対象のユーザーを指定します
ユーザーのコネクションのアクティビティを結果に含めます
結果に、ホーム・ポータルなどポータルからのアクティビティを含めます
結果を、特定のサービスからのアクティビティに限定します
使用できるオプションは、streamリソースにアクセスするためにたどるパスと、使用するリンクのrelに応じて異なります。たとえば、アクティビティ・ストリーム問合せフィルタは、urn:oracle:webcenter:activities:streamのrel属性を持つリンクからのみ使用できます。personリソースからアクティビティ・ストリーム問合せフィルタにアクセスする場合は、personGuidパラメータが事前に設定されます。
表42-1は、リンクのrel要素に応じて返されるアクティビティを示しています。
表42-1 streamによって返されるアクティビティ
| rel | 戻り値 |
|---|---|
|
|
ユーザーのストリームからのアクティビティ( |
|
|
ユーザーのコネクションのストリームからのアクティビティ( |
|
|
アクティビティ・ストリーム問合せフィルタによって決定されるアクティビティ |
|
|
ポータル・アクティビティ・ストリームからのアクティビティ |
|
|
ポータル・アクティビティ・リストからのアクティビティ |
脚注 1 GUIDは、任意の有効なユーザーGUIDまたは@meです。
streamへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してこのリソースにアクセスする方法を示します:
resourceIndex
stream (rel="urn:oracle:webcenter:activities:stream:person" or
"urn:oracle:webcenter:activities:stream")
resourceIndex
person
stream (rel="urn:oracle:webcenter:activities:stream:person" or
"urn:oracle:webcenter:activities:stream:connections" or
"urn:oracle:webcenter:activities:stream")
resourceIndex
person
list
stream
resourceIndex
space
stream
stream
activity
param
stream (rel="urn:oracle:webcenter:activities:stream:space")
personReference stream
streamでサポートされるメソッド
次のメソッドは、streamでサポートされています。
GET
リクエスト-パラメータ:
startIndex, itemsPerPage
問合せフィルタURIに使用できる追加のパラメータは次のとおりです。
fromDate - アクティビティ開始日(yyyy-mm-dd)を指定します。
toDate - アクティビティ終了日(yyyy-mm-dd)を指定します。
data: 指定したデータのみを返します(詳細は、「共通のリクエスト問合せパラメータ」を参照してください)。streamリソースの場合、定数'data'をdataパラメータとして指定すると、そのリソースに関する基本情報が、コメントおよびお気に入り登録のサマリーを除いてすべて返されます。コメントまたはお気に入り登録を返す場合は、dataパラメータ値'commentsSummary'または'likesSummary'を指定します。
|
注意: 複数のデータ値を、カンマ区切りリストとして指定できます。たとえば、data=data, commentsSummaryと指定します。 |
personGuid: (必須)指定されたユーザーのストリームからアクティビティを取得します。有効な値: 任意の有効なユーザーGUIDまたは@me。
serviceIds: 指定されたサービスに対するアクティビティのみを返します。有効な値: アスタリスク(*)では、すべてのサービスが返されます。NULLまたは空にすると、(最上部バーの設定リンクから)サービス・フィルタのユーザー・プリファレンス設定が使用されます。
personal: 指定されたユーザーのアクティビティをホーム・ポータルに含めます。有効な値: trueまたはfalse。デフォルト値: false。
connections: 指定されたユーザーのコネクションのストリームからのアクティビティを含めます。有効な値: trueまたはfalse。デフォルト値: false。
groupSpaces: 指定したユーザーがメンバーとなっているすべてのポータルからのアクティビティを含めます。有効な値: trueまたはfalse。デフォルト値: false。
connectionListIds: アクティビティを表示するために使用されるコネクション・リストを指定するコネクション・リスト名のカンマ区切りリスト。
groupSpaceGuids: アクティビティを表示するために使用されるポータルGUIDのカンマ区切りリスト。
userGroupSpaceActivities: ユーザーのアクティビティをそれぞれのポータルに表示するかどうかを指定します。有効な値: trueまたはfalse。デフォルト値: false。
followedObjects: 現在のユーザーと指定されたユーザーの両方に追跡されるオブジェクトのすべてのアクティビティを表示するかどうかを指定します。有効な値: trueまたはfalse。デフォルト値: false。
followedObjectsUserActivities: 現在のユーザーと指定されたユーザーの両方が追跡するオブジェクトの指定されたユーザーのアクティビティを表示するかどうか指定します。有効な値: trueまたはfalse。デフォルト値: false。
advancedQuery: ストリーム・アクティビティに対するフィルタを指定します。ユーザー名、サービスIDおよびドキュメントの表示名などのオブジェクトの詳細のフィルタを作成します。
|
注意: advancedQueryパラメータに実際の値をプラグする必要があります。EL式を直接パラメータに渡すことはできません。通常、REST APIクライアントはEL変換を手動で処理し、実際のオブジェクト・データ値をREST URLに挿入します。次の例を参照してください。また、第39.4項「アクティビティ・ストリームの詳細な問合せオプションについて」も参照してください。 |
たとえば、次のURIでは、現在のユーザーのアクティビティ・ストリームから、そのユーザーがサービス・フィルタに対する個人プリファレンス設定で構成したサービスすべてに対して、アクティビティが返されます。これによって、ユーザーのホーム・ポータルから、およびユーザーのコネクションのストリームからアクティビティが返されます。
http://host:port/rest/api/activities?personal=true&connections=true&personGuid=@me&token=utoken
次のURIでは、ユーザーの個人プロファイルおよびコネクションのアクティビティのみが返されます。
http://host:port/rest/api/activities?serviceIds=oracle.webcenter.peopleconn ections.profile,oracle.webcenter.peopleconnections.connections&personal= true&personGuid=@me&token=utoken
この次の例では、advancedQueryパラメータの使用方法を示します。前述のとおり、EL式をadvancedQueryに渡すことはできません。REST APIクライアントは、最初に実際のデータ・オブジェクト値を取得する必要があり、そして、その値をadvancedQueryに渡すことができます。たとえば、特定のポータルのアクティビティをフィルタ処理するには、そのポータルの範囲のGUIDをadvancedQueryに渡します。
http://host:port/rest/api/activities?personGuid=@me&advancedQuery=AE.SCOPE_ID%20%3D%20\%27s8bba98ff_4cbb_40b8_beee_296c916a23ed\%27&ttoken=token
ここでs8bba98ff_4cbb_40b8_beee_296c916a23edはそのポータルのGUIDです。問合せ文字列は、適切なエスケープ・コードでエンコードする必要があります。advancedQueryの値を取得するために使用できるEL式のリストは、第39.4項「アクティビティ・ストリームの詳細な問合せオプションについて」を参照してください。
レスポンス-本体: 0個以上のアクティビティ
|
注意: streamリソースにはアクティビティ・アイテムが含まれているため、そのレスポンスでは、そのアクティビティで参照されているオブジェクトのリソース・リンクも返されることがあります。 |
streamからリンクされるリソース・タイプ
表42-2は、クライアントがstreamリソースからリンクできるリソース・タイプを示しています。
表42-2 streamに関連するリソース・タイプ
| rel | リソース・タイプ |
|---|---|
|
self urn:oracle:webcenter:activities:stream:person |
urn:oracle:webcenter:activities:stream |
|
urn:oracle:webcenter:activities:activity |
urn:oracle:webcenter:activities:activity
activityレスポンスには、アクティビティに関するデータと、アクティビティ・ストリームに含まれているアクティビティから必要とするデータをすべて取得する際に使用するURIが含まれます。
activityへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してactivityリソースにアクセスする方法を示します。
resourceIndex
stream
activity
resourceIndex
person
stream
activity
resourceIndex
space
stream
activity
activityでサポートされるメソッド
activityでサポートされているメソッドはありません。アクティビティは、現在、streamリソース・タイプからのみ使用できます。
activityからリンクされるリソース・タイプ
表42-3は、クライアントがこのリソースからリンクできるリソース・タイプを示しています。
表42-3 urn:oracle:webcenter:activities:activityに関連するリソース・タイプ
| rel | リソース・タイプ |
|---|---|
|
self |
|
|
icon |
|
activityの読取り専用要素
表42-4は、activityリソースの読取り専用要素を示しています。
|
注意: アイコンが使用可能である場合は、activityによって、レスポンスのリンク・セクションのアクティビティ・アイコンへのリンクが返されます。「urn:oracle:webcenter:activities:activity:icon」を参照してください。 |
表42-4 activityの読取り専用要素
| 要素 | タイプ | 説明 |
|---|---|---|
|
|
String |
アクティビティ・タイプ サービス内で一意です。たとえば、ディスカッションは |
|
|
String |
dataパラメータに |
|
|
Date (String)脚注 1 |
アクティビティが作成された日付。 |
|
|
String |
アクティビティの説明。 |
|
|
String |
アクティビティの詳細情報(使用可能な場合)。 たとえば、これによって、メッセージのコンテンツ、ドキュメントのファイル名、お気に入り登録が返されます。
|
|
|
String |
detailURLは、ポータルでWikiおよびブログを作成する際に使用可能です。WebベースのWebCenter Portalでは、このURLをクリックし、ポータルでWikiまたはブログのページを開くことができます。
|
|
|
String |
事前に書式設定された国際化された説明。 |
|
|
String |
事前に書式設定された国際化されたメッセージ(テンプレート情報は含まれません)。 |
|
|
|
アクティビティが実行されたポータルに関する情報 注意: この参照は、ポータル内で発生しなかったアクティビティ(たとえば、ホーム・ポータルで発生したアクティビティ)では存在しません。また、ポータルの作成はホーム・ポータルで発生するため、そのアクティビティにもこの要素はありません。 |
|
|
String |
メッセージの一意のID |
|
|
trueまたはfalse |
このアクティビティが他のアクティビティのサマリーであるのかどうかを示します。 |
|
|
String |
dataパラメータに |
|
|
String |
このアクティビティのローカライズ済文字列 これは、中カッコ({})内に置換文字列が含まれている場合があります。 |
|
|
PRIVATE SHARED PUBLIC |
このアクティビティの権限レベル |
|
|
String |
アクティビティの範囲 これは、ホーム・ポータルなどのポータルを返すことがあります。 たとえば、ポータルの場合は、次のような文字列が返されます。 s8bba98ff_4cbb_40b8_beee_296c916a23ed |
|
|
String |
アクティビティを作成したサービスの一意のID 注意: WebCenter PortalのツールとサービスのIDのリストは、表G-7「サービスとツールのID」を参照してください。 |
|
|
String |
次の例で示すように、RESTクライアントによるナビゲーション・リンクをレンダリングするために使用できます。 <param resourceType="urn:oracle:webcenter:activities:parameter"> <links> <link href="http://www.google.com" /> </links> <displayName>http://www.google.com</displayName> <key>_sharedLink_url</key> <type>custom</type> </param> " このパラメータはメッセージ・テンプレートで使用できないことに注意してください(例: |
|
|
urn:oracle:webcenter:activities:parameter |
アクティビティに関連するデータを取得する |
|
|
Param |
カスタム・パラメータには、 |
脚注 1 DATEやBOOLEANなどのデータ型は、STRINGとしてAPIに格納されます。DATEデータ型は、Java標準の日付書式、たとえば、2009-08-21T14:43:11.0013-0700を返します。ここで、0700はタイム・ゾーンを表します。
templateParams要素の理解
Carlという名前のユーザーの最新のメッセージを表示するとします。「CarlはポータルCustomer Feedbackを作成した」のような情報を表示したいと考えています。templateParams要素が、この問題の解決に役立ちます。
templateParams要素は、タイプoracle:webcenter:activities:activityのオブジェクトで返されます。この要素は、アクティビティに関連する大量のデータを取得します。たとえば、ユーザーが新しいポータルを作成する場合、そのアクティビティのtemplateParams要素が、ユーザーに関する情報およびポータルに関する情報を取得します。そのアクティビティに関連するパラメータ化されたメッセージ文字列内での文字列の置換の実行を可能にするキーが提供されています。
たとえば、ユーザーがポータルを作成する場合、返されるアクティビティ・オブジェクトには、次のようにパラメータ化されている<message>アイテムが含まれています。
<message>{actor[0]} has created the portal {object[0]}</message>
そのアクティビティのtemplateParams要素を解析することで、文字列の置換の実行を可能にする使用可能なキーおよび、ユーザー名やアクティビティなど、表示に適したデータを見つけることができます。
アクティビティに関する情報を表示するためのtemplateParamsを使用したUIのコーディング方法の詳細な例は、第53.13.2項「アクティビティ・ストリーム・データの表示」を参照してください。
templateParams要素は、comments、likes、commentsSummaryおよびlikesSummaryオブジェクトへのリンクも提供します(それらがdataパラメータを使用してリクエストされている場合)。これらのリンクによって、オブジェクトに関するすべてのコメントまたはお気に入り登録などを問い合せたり、新しいコメントまたはお気に入り登録を投稿できます。サマリー・リンクによって、コメントまたはお気に入り登録カウントおよびいくつかの最近のコメントまたはお気に入り登録が返されます。「コメントとお気に入り登録の理解」も参照してください。
templateParams要素で返されるリンクは、ユーザー、ドキュメント、ポータル、カスタム・オブジェクトなど、どのような種類のオブジェクトが返されるのかによって異なります。詳細は、「urn:oracle:webcenter:activities:parameter」を参照してください。
|
注意: templateParams要素には、場合によっては、メッセージ内で直接参照されない要素が含まれることがあります。 |
relリンクがviaとマークされている場合、それは基盤となるRESTオブジェクト(たとえば、パラメータではなくドキュメント)へのリンクです。relリンクがalternateおよびタイプtext/htmlとマークされている場合、それはそのオブジェクトのHTMLページへのリンクです。ポータル・オブジェクトには、ポータルのためのアクティビティ・ストリーム・リンクが含まれています。ユーザーには、アイコンおよびアクティビティ・ストリーム・リンクがあります。他のオブジェクトには、タグ付けしたアイテムおよび関連するタグ付けしたアイテムのリストへのaltリンクを含めることができます(そのオブジェクトに対してタグ付けが有効化されている場合)。標準オブジェクトで、コメントまたはお気に入り登録がサポートされている場合、前述のとおり、それには、comments/commentsSummaryおよびlikes/likesSummaryを含めることができます。
コメントとお気に入り登録の理解
comments、commentsSummary、likesおよびlikesSummaryへのハイパーリンクがデフォルトで含まれます(data=data,commentsSummary,likesSummaryを指定してcommentsSummaryおよびlikesSummaryを開くことができます)。コメントおよびお気に入り登録は、アクティビティによって参照されるオブジェクトまたはアクティビティ自体と関連付けることができます。たとえば、ドキュメントを編集する場合、そのコメントはそのドキュメントと関連付けられます。アクティビティ・ストリーム・ページのドキュメント編集アクティビティにコメントを追加する場合、そのコメントは、そのドキュメント編集アクティビティと関連付けられます。
コメントおよびお気に入り登録と関連付けられているリンクは、次のとおりです。
comments: commentsリンクにより、1つのオブジェクトに対するすべてのコメントを問い合せることができます。このリンクで新しいコメントをPOSTすることもできます。comments POSTの場合、textフィールドが必要です。たとえば、本体データには次のように使用します。
JSON:
{
"text" : "REST Comment"
}
XML:
<text>REST Comment</text>
commentsSummary: commentsSummaryリンクによって、コメント・カウントおよびいくつかの最近のコメントが返されます。
likes - likesリンクによって、1つのオブジェクトのすべてのお気に入り登録を問い合せることができます。このリンクで新しいお気に入り登録をPOSTすることもできます。likes POSTに必要なフィールドはありません。
likesSummary: likesSummaryリンクによって、お気に入り登録カウントおよび現在のユーザーのお気に入り(使用可能な場合)が返されます。
|
注意: Likeオブジェクト自体では、DELETEのみがサポートされ、GETはサポートされません。likesCountおよびcommentsCountアイテムによって、現在のオブジェクトのお気に入り登録またはコメントの数が返されます。 |
次のURLは、ドキュメント・オブジェクトのcomments、commentSummary、likesおよびlikesSummaryに対するGETリクエストの例を示しています。
"http://example.com:8892/rest/api/activities/services/oracle.webcenter.doclib/objectTypes/document/objects/(<document_object_id>)/comments?startIndex=0&itemsPerPage=10&utoken=FCvY3qQSBh0eAByLdxugV-lUgFO3_w**" "http://example.com:8892/rest/api/activities/services/oracle.webcenter.doclib/objectTypes/document/objects/(<document_object_id>)/commentsSummary?utoken=FCvY3qQSBh0eAByLdxugV-lUgFO3_w**" "http://example.com:8892/rest/api/activities/services/oracle.webcenter.doclib/objectTypes/document/objects/(<document_object_id>)/likes?startIndex=0&itemsPerPage=10&utoken=FCvY3qQSBh0eAByLdxugV-lUgFO3_w**" "http://example.com:8892/rest/api/activities/services/oracle.webcenter.doclib/objectTypes/document/objects/(<document_object_id>)/likesSummary?utoken=FCvY3qQSBh0eAByLdxugV-lUgFO3_w**"
ここで<document_object_id>はドキュメント・オブジェクトIDです。
次のURLは、ドキュメント作成アクティビティのcomments、commentSummary、likesおよびlikesSummaryに対するGETリクエストの例を示しています。
"http://example.com:8892/rest/api/activities/ffa9a9f0-d02f-4e30-8c58-8a41b7a6e8a3/comments?startIndex=0&itemsPerPage=10&utoken=FCvY3qQSBh0eAByLdxugV-lUgFO3_w**"
"http://example.com:8892/rest/api/activities/ffa9a9f0-d02f-4e30-8c58-8a41b7a6e8a3/commentsSummary?utoken=FCvY3qQSBh0eAByLdxugV-lUgFO3_w**"
"http://example.com:8892/rest/api/activities/ffa9a9f0-d02f-4e30-8c58-8a41b7a6e8a3/likes?startIndex=0&itemsPerPage=10&utoken=FCvY3qQSBh0eAByLdxugV-lUgFO3_w**"
"http://example.com:8892/rest/api/activities/ffa9a9f0-d02f-4e30-8c58-8a41b7a6e8a3/likesSummary?utoken=FCvY3qQSBh0eAByLdxugV-lUgFO3_w**"
urn:oracle:webcenter:activities:parameter
templateParams要素によって、一連のparam要素が返されます。param要素によって、返されるアクティビティ・オブジェクトのタイプに固有のデータが返されます。param要素の使用可能なタイプには、次のものがあります。
user: displayName、guid、id、key、primaryIdおよびtypeを返します。
document: displayName、iconUrl、id、key、primaryIdおよびtypeを返します。
custom: displayName、keyおよびtypeを返し、URLを持つ場合と持たない場合があります。
paramは、変数の参照または一般的な形式{prefix[index].variable}のキーである場合もあります。
urn:oracle:webcenter:activities:activity:icon
このリソース・タイプを使用して、アクティビティのアイコンを取得します(使用可能な場合) (GET)。
activities:activity:iconへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してこのリソースにアクセスする方法を示します:
resourceindex
activities
activity
icon
iconでサポートされるメソッド
次のメソッドは、このリソースによりサポートされています:
GET: 指定したアクティビティに使用されるアイコンを返します。
iconからリンクされるリソース・タイプ
表42-5は、クライアントがこのリソースからリンクできるリソース・タイプを示しています。
表42-5 urn:oracle:webcenter:activities:activity:iconに関連するリソース・タイプ
| rel | リソース・タイプ |
|---|---|
|
self |
|
|
urn:oracle:webcenter:parent |
|
コネクションおよびプロファイルREST APIを使用して、プロファイルまたはコネクション・リストの参照、コネクション・リストの管理、コネクションの追加または削除、コネクションの招待の送信およびプロファイル・ステータス・メッセージの更新を行います。この項では、これらのアクションを実行するために使用するREST APIメソッドの情報を提供します。
この項には次のサブセクションが含まれます:
各RESTサービスは、そのサービスのエントリ・ポイントを提供するリソース索引内にリンク要素を持っています。ピープル・コネクションでは、各機能に独自のリンク要素があります。たとえば、ピープル・コネクションのコネクションとプロファイル機能のエントリ・ポイントを見つけるには、次のresourceTypeを持つリンク要素を見つけます。
urn:oracle:webcenter:people (現在のユーザーのプロファイルを返します)
urn:oracle:webcenter:people:person (ユーザーに対する問合せを可能にします)
urn:oracle:webcenter:people:invitations (現在のユーザーによって送信または受信された招待を返します)
|
注意: people:personおよびpeople:invitationsリソース・タイプには、templateはありますが、hrefはありません。 |
対応するhrefまたはtemplate要素によって、URIエントリ・ポイントが提供され、それによって人々のリスト(people)または個々のユーザー(people:person)が返されます。クライアントは、このエントリ・ポイントにHTTPリクエストを送信し、ピープル・コネクションのコネクションとプロファイル機能を使用します。
クライアントがエントリ・ポイントを識別すると、リソース・タイプの分類によりナビゲートして、必要な操作を実行できます。個々のリソース・タイプの詳細は、第42.2.4項「コネクションおよびプロファイル・リソース・タイプ」の該当の項を参照してください。
ピープル・コネクションのコネクションおよびプロファイル機能のリソース・タイプの分類は、次のとおりです。
urn:oracle:webcenter:people
urn:oracle:webcenter:people:person
urn:oracle:webcenter:people:icon
urn:oracle:webcenter:people:person:list
urn:oracle:webcenter:people:person:listNames
urn:oracle:webcenter:people:person:listName
urn:oracle:webcenter:people:person:list:member
urn:oracle:webcenter:people:person:status
urn:oracle:webcenter:people:invitations
urn:oracle:webcenter:people:invitation
ピープル・コネクションREST APIのいずれかにアクセスするには、RESTサービスにログインする必要があります。その後、基礎となるサービスにより、権限の確認などが処理されます。
この項では、各リソース・タイプについて知っておく必要があるすべての情報を提供します。次のサブセクションが含まれます:
urn:oracle:webcenter:people
peopleレスポンスには、1人以上のユーザーのプロファイルの取得に使用するURIが含まれます。
peopleへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してpeopleリソースにアクセスする方法を示します。
resourceIndex people
peopleでサポートされるメソッド
次のメソッドは、peopleでサポートされています。
GET
リクエスト-パラメータ:
startIndex - 「共通のリクエスト問合せパラメータ」を参照してください。
itemsPerPage - 「共通のリクエスト問合せパラメータ」を参照してください。
projection - 「共通のリクエスト問合せパラメータ」を参照してください。
data: dataパラメータは、レスポンスで返されるデータを制御するカンマ区切りのリストです。事前定義済セットのbasicは、data=guid,id,displayNameと同等です。事前定義済セットのdataは、ユーザーのすべてのデータを返す標準セットですが、status、manager、reporteesまたはphotosは含まれていません。設定可能な値のフル・リストには、事前定義済セットのbasicとdata、さらに個々のデータ値としてguid、id、displayName、birthday、language、timeZone、name、addresses、organizations、workEmail、phoneNumbers、manager、reportees、photosおよびstatusが含まれます。
dataパラメータとして定数'data'を指定すると、リソースに対してすべての基本情報が返されます。projectionとdataの両方の問合せ文字列パラメータが存在する場合は、dataパラメータを使用して返すデータを決定します。
dataパラメータは、次の値のカンマ区切りリスト値を取って、対応するデータを返すこともできます。guid、id、displayName、birthday、language、timeZone、name、addresses、organizations、workEmail、phoneNumbers、manager、reportees、photosまたはstatus、あるいはその任意の組合せ。
|
注意: dataパラメータは、事前定義済セット、値のコレクションまたはセットと値の組合せを受け入れることができます。たとえば、基本データおよびユーザーの生年月日を入手するには、data=basic,birthdayと指定します。 |
links: linksパラメータは、レスポンスでどのリンクが返されるのかを制御するカンマ区切りリストです。このパラメータは、事前定義済セット、個々のデータ値または事前定義済セットと個々のデータ値の組合せを受け入れることができます。事前定義済セットは、basic、data、activitiesSet、connectionsSetおよびfeedbackSetです。これらの事前定義済セットについては、「linksパラメータの事前定義済セット」を参照してください。
linksパラメータの個々の値は、person、profile、icon、status、messageBoard、activities、personActivities、connectionActivities、connections、listNames、invitation、givenFeedback、receivedFeedback、userGivenFeedback、manager、reportees、memberです。
projectionとlinksの両方の問合せ文字列パラメータが存在する場合は、linksパラメータを使用して返すリンクを決定します。
レスポンス-本体: 0個以上の個人オブジェクト。
linksパラメータの事前定義済セット
次のアイテムは、linksパラメータで返すことができる事前定義済セットです。たとえば、links=basicを指定する場合、それはdata=person,profile,iconを指定することと同等です。必要に応じて、追加のパラメータを指定することもできます。たとえば、data=basic,birthdayと指定できます。
|
注意: 現在使用できないリンクは、それらがlinksパラメータで指定されている場合でも返されません。 |
basic: プロファイルの基本情報を返し、person、profileおよびiconを含む標準セット。
data: レスポンスに対してすべての基本リンクと、コネクション・リスト、ステータスおよびアクティビティ・ストリーム・テンプレートを返す標準セット。
activitiesSet: activities、personActivitiesおよびconnectionActivitiesが含まれます。
connectionsSet: connections、listNamesおよびinvitationが含まれます。
feedbackSet: givenFeedback、receivedFeedbackおよびuserGivenFeedbackが含まれます。
peopleからリンクされるリソース・タイプ
表42-6は、クライアントがpeopleリソースからリンクできるリソース・タイプを示しています。
表42-6 peopleに関連するリソース・タイプ
| rel | リソース・タイプ |
|---|---|
|
urn:oracle:webcenter:people:icon |
urn:oracle:webcenter:people:person |
|
urn:oracle:webcenter:people:person:list:connections |
urn:oracle:webcenter:people:person:list |
|
urn:oracle:webcenter:activities:stream:person |
urn:oracle:webcenter:activities:stream |
|
urn:oracle:webcenter:activities:stream:connections |
urn:oracle:webcenter:activities:stream |
|
urn:oracle:webcenter:activities:stream |
urn:oracle:webcenter:activities:stream |
|
urn:oracle:webcenter:feedback:all-received |
urn:oracle:webcenter:feedback |
|
urn:oracle:webcenter:feedback:all-given |
urn:oracle:webcenter:feedback |
|
self |
urn:oracle:webcenter:people:person:status |
|
urn:oracle:webcenter:people:person:list:list |
urn:oracle:webcenter:people:person:list |
|
self |
urn:oracle:webcenter:people:person:listName |
|
urn:oracle:webcenter:activities:stream:list |
urn:oracle:webcenter:activities:stream |
urn:oracle:webcenter:people:icon
このリソース・タイプを使用して、指定したプロファイルで使用されるアイコンを取得します(GET)。
people:iconへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してこのリソースにアクセスする方法を示します:
resourceindex
people
icon
iconでサポートされるメソッド
次のメソッドは、このリソースによりサポートされています:
GET: 指定したプロファイルに使用されるアイコンを返します。
|
注意: このリソースには、使用するプロファイル・アイコンのサイズを選択できるテンプレートが含まれています。sizeテンプレート・パラメータは、small、mediumまたはlargeに設定できます。 |
iconからリンクされるリソース・タイプ
表42-7は、クライアントがこのリソースからリンクできるリソース・タイプを示しています。
表42-7 urn:oracle:webcenter:people:iconに関連するリソース・タイプ
| rel | リソース・タイプ |
|---|---|
|
self |
|
|
urn:oracle:webcenter:parent |
|
urn:oracle:webcenter:people:person
personレスポンスには、プロファイル・データおよびユーザー・プロファイルの取得に使用するURIが含まれます。
personへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してpersonリソースにアクセスする方法を示します。
resourceIndex people
resourceIndex
people
person
resourceIndex person
author person
resourceIndex
activities:stream
person
personでサポートされるメソッド
次のメソッドは、personでサポートされています。
GET
リクエスト-パラメータ: q
指定した人を取得するためのqの形式は次のとおりです。
q=[loginid:equals:username] Or q=[guid:equals:guid] Or q=[email:equals:email]
|
注意: パラメータqは、personのresourceIndexテンプレート上のみです。 |
レスポンス-本体: message
personの読取り専用要素
表42-8は、personリソースの読取り専用要素を示しています。
|
注意: personレスポンス内に存在する要素は、ユーザー・リポジトリの構成方法およびそれによってサポートされている要素に応じて異なります。さらに、address、emails、photos、phoneNumbers、organizationなど表42-8に示すデータのいくつかは、複数のインスタンスを持つことができます。 |
表42-8 personの読取り専用要素
| 要素 | タイプ | 説明 |
|---|---|---|
|
|
String |
人の一意のGUID |
|
|
String |
人の一意のログインID(つまり、ユーザー名。たとえば、pat_coi) |
|
|
String |
人の表示名(ユーザーの名前、たとえば、Pat Coi)。これは、リポジトリ構成に応じて、 |
|
|
Date (String)脚注 1 |
人の生年月日 |
|
|
Boolean (String)1 |
この人が現在のユーザーにコネクションを持っているかどうか |
|
|
String |
人の優先言語 |
|
|
String |
人のタイムゾーン |
|
|
|
人の名前情報
|
|
|
|
人の住所情報 addressは、ポータブル連絡先タイプです。詳細は、第53.10.2.2項「addressポータブル連絡先タイプ」を参照してください。 |
|
|
|
人の電子メール
|
|
|
|
人のプロファイル写真
|
|
|
|
人の電話番号
|
|
|
|
人の組織情報 organizationは、ポータブル連絡先タイプです。詳細は、第53.10.2.3項「organizationポータブル連絡先タイプ」を参照してください。 |
|
|
|
この人の上司 |
|
|
|
この人の直属の部下 |
|
|
urn:oracle:webcenter:people:person:status |
人のプロファイル・ステータス・メッセージ |
脚注 1 DATEやBOOLEANなどのデータ型は、STRINGとしてAPIに格納されます。
personからリンクされるリソース・タイプ
表42-9は、クライアントがpersonリソースからリンクできるリソース・タイプを示しています。
表42-9 personに関連するリソース・タイプ
| rel | リソース・タイプ |
|---|---|
|
self |
urn:oracle:webcenter:people:person |
|
alternate |
urn:oracle:webcenter:spaces:profile (HTML) |
|
urn:oracle:webcenter:people:person:list:connections |
urn:oracle:webcenter:people:person:list |
|
urn:oracle:webcenter:people:person:listNames |
|
|
urn:oracle:webcenter:people:person:status |
|
|
urn:oracle:webcenter:activities:stream:person |
urn:oracle:webcenter:activities:stream |
|
urn:oracle:webcenter:activities:stream:connections |
urn:oracle:webcenter:activities:stream |
|
urn:oracle:webcenter:activities:stream |
urn:oracle:webcenter:activities:stream |
|
urn:oracle:webcenter:messageBoard |
|
|
urn:oracle:webcenter:feedback:all-given |
|
|
urn:oracle:webcenter:feedback:all-received |
|
urn:oracle:webcenter:people:person:list
listレスポンスには、コネクション・リスト上のすべてのプロファイルの取得(GET)、ユーザーへのコネクションの招待の送信またはコネクション・リストへのコネクションの追加(POST)、およびコネクション・リストの削除(DELETE)に使用するURIが含まれます。
listへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してlistリソースにアクセスする方法を示します。
resourceIndex
person
listNames
list
resourceIndex
person
list (rel="urn:oracle:webcenter:people:person:list:connections")
listでサポートされるメソッド
次のメソッドは、listリソースでサポートされています。
GET
リクエスト-パラメータ: startIndex、itemsPerPage、projection
レスポンス-本体: 0個以上のpersonアイテム
POST
リクエスト-本体: member
レスポンス-本体: member
DELETE
リクエスト
listからリンクされるリソース・タイプ
表42-10は、クライアントがlistリソースからリンクできるリソース・タイプを示しています。
表42-10 listに関連するリソース・タイプ
| rel | リソース・タイプ |
|---|---|
|
self urn:oracle:webcenter:people:person:list脚注 1 |
urn:oracle:webcenter:people:person:list |
|
urn:oracle:webcenter:activities:stream |
urn:oracle:webcenter:activities:stream |
脚注 1 self relには、現在、urn:oracle:webcenter:people:person:listのかわりにurn:oracle:webcenter:people:person:list:listが含まれます。@connectionsデフォルト・リストの場合、これには現在、urn:oracle:webcenter:people:person:list:connectionsが含まれます。
urn:oracle:webcenter:people:person:listNames
listNamesレスポンスには、既存のコネクション・リストの名前と、リストの取得(GET)およびコネクション・リストの作成(POST)に使用するURIが含まれます。
listNamesへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してlistNamesリソースにアクセスする方法を示します。
resourceIndex
person
listNames
listNamesでサポートされるメソッド
次のメソッドは、listNamesリソースでサポートされています。
GET
リクエスト
レスポンス: 本体: 0個以上のlistNameアイテム
POST
リクエスト-本体: listName
レスポンス-本体: listName
listNamesからリンクされるリソース・タイプ
表42-11は、クライアントがlistNamesリソースからリンクできるリソース・タイプを示しています。
urn:oracle:webcenter:people:person:listName
listNameレスポンスには、コネクション・リストの名前およびコネクション・リストへのアクセスに使用するURIが含まれます。「urn:oracle:webcenter:people:person:listNames」も参照してください。
listNameへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してlistNameリソースにアクセスする方法を示します。
resourceIndex
person
listNames
listName
listNameでサポートされるメソッド
次のメソッドは、listNameリソースでサポートされています。
DELETE
リクエスト
listNameの書込み可能要素
表42-12は、listNameリソースの書込み可能要素を示しています。
listNameからリンクされるリソース・タイプ
表42-13は、クライアントがlistNameリソースからリンクできるリソース・タイプを示しています。
表42-13 listNameに関連するリソース・タイプ
| rel | リソース・タイプ |
|---|---|
|
self urn:oracle:webcenter:people:person:list |
urn:oracle:webcenter:people:person:list |
|
urn:oracle:webcenter:activities:stream:list |
urn:oracle:webcenter:activities:stream |
urn:oracle:webcenter:people:person:list:member
memberレスポンスには、コネクション・リストからのコネクションの削除に使用するURIが含まれます。
memberへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してmemberリソースにアクセスする方法を示します。
resourceIndex
person
list
member
memberでサポートされるメソッド
次のメソッドは、memberでサポートされています。
DELETE
リクエスト
memberの書込み可能要素
表42-14は、memberリソースの書込み可能要素を示しています。memberの書込み可能要素は、コネクションをリストに追加したり、ユーザーにコネクションの招待を送信する場合に使用されます。memberリソース自体は、コネクションを削除するためのものであり、書込み可能要素を使用しません。
表42-14 memberの書込み可能要素
| 要素 | タイプ | 必須 | 制約 | 説明 |
|---|---|---|---|---|
|
|
String |
はい |
1文字以上の文字 |
ユーザーのGUID |
|
|
String |
いいえ |
0文字以上の文字 |
招待メッセージ これは、ユーザーにコネクションの招待を送信する場合(つまり、ユーザー作成のコネクション・リストではなく、 |
urn:oracle:webcenter:people:person:status
statusレスポンスには、指定したユーザーのプロファイル・ステータス・メッセージの取得(GET)および更新(PUT)に使用するURIが含まれます。
statusへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してstatusリソースにアクセスする方法を示します。
resourceIndex
people
person
status
statusでサポートされるメソッド
次のメソッドは、statusリソースでサポートされています。
GET
リクエスト
レスポンス-本体: status
PUT
リクエスト-本体: status
レスポンス-本体: status
statusの書込み可能要素
表42-15は、statusリソースの書込み可能要素を示しています。
statusからリンクされるリソース・タイプ
表42-16は、クライアントがstatusリソースからリンクできるリソース・タイプを示しています。
urn:oracle:webcenter:people:invitations
invitationsレスポンスには、招待の取得に使用するURIが含まれます(GET)。別のユーザーに招待を送信(POST)することもできます。
invitationsへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してinvitationsリソースにアクセスする方法を示します。
resourceIndex invitations
ユーザーに対してコネクションをまだ持っていない場合、彼らにコネクションの招待を送信するために、そのユーザーのプロファイルからinvitationsリソースにナビゲートすることもできます。このパスは、POSTに対してのみ使用されます。
resourceIndex
person
invitations
invitationsでサポートされるメソッド
次のメソッドは、invitationsリソースでサポートされています。
GET
リクエスト-パラメータ: q
現在のユーザーに送信された招待を取得するためのqの形式は次のとおりです。
q=[invitee:equals:@me]
現在のユーザーから送信された招待を取得するためのqの形式は次のとおりです。
q=[invitor:equals:@me]
レスポンス-本体: 0個以上の招待
POST
リクエスト-本体: invitation
レスポンス-本体: invitation
invitationsの書込み可能要素
表42-17は、invitationsリソースの書込み可能要素を示しています。
invitationsからリンクされるリソース・タイプ
表42-18は、クライアントがinvitationsリソースからリンクできるリソース・タイプを示しています。
urn:oracle:webcenter:people:invitation
invitationレスポンスには、送信した招待の削除(DELETE)、または受信した招待の削除(DELETE)または更新(PUT)に使用するURIが含まれます。
invitationへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してinvitationリソースにアクセスする方法を示します。
resourceIndex
invitations
invitation
invitationでサポートされるメソッド
次のメソッドは、invitationリソースでサポートされています。
PUT
リクエスト-本体: invitation
レスポンス-本体: invitation
DELETE
リクエスト
invitationの書込み可能要素
表42-19は、invitationリソースの書込み可能要素を示しています。
表42-19 invitationの書込み可能要素
| 要素 | タイプ | 必須 | 制約 | 説明 |
|---|---|---|---|---|
|
|
String |
はい(PUT) |
ACCEPTED IGNORED |
招待のステータス。 注意: 招待を受け入れるか無視するときに、それが自身の招待のリストから削除されます。 |
invitationの読取り専用要素
表42-20は、invitationリソースの読取り専用要素を示しています。
表42-20 invitationの読取り専用要素
| 要素 | タイプ | 説明 |
|---|---|---|
|
|
String |
招待の一意のID |
|
|
|
招待の送信先のユーザー |
|
|
|
招待の送信元のユーザー |
|
|
Date (String)脚注 1 |
招待が送信された日付 |
脚注 1 DATEやBOOLEANなどのデータ型は、STRINGとしてAPIに格納されます。
invitationからリンクされるリソース・タイプ
表42-21は、クライアントがinvitationリソースからリンクできるリソース・タイプを示しています。
フィードバックREST APIを使用して、フィードバックを読み取り、削除します。この項では、これらのアクションを実行するために使用するREST APIメソッドの情報を提供します。
この項には次のサブセクションが含まれます:
各RESTサービスは、そのサービスのエントリ・ポイントを提供するリソース索引内にリンク要素を持っています。ピープル・コネクションでは、各機能に独自のlink要素があります。ピープル・コネクションのフィードバック機能のエントリ・ポイントを見つけるには、次のresourceTypeを持つlink要素を見つけます。
urn:oracle:webcenter:feedback
対応するhrefまたはtemplate要素によって、URIエントリ・ポイントが提供され、それによって現在のユーザーの受信したフィードバックがすべて返されます。クライアントは、このエントリ・ポイントにHTTPリクエストを送信し、ピープル・コネクションのフィードバック機能を使用します。
クライアントがエントリ・ポイントを識別すると、リソース・タイプの分類によりナビゲートして、必要な操作を実行できます。個々のリソース・タイプの詳細は、第42.3.4項「フィードバック・リソース・タイプ」の該当の項を参照してください。
ピープル・コネクションのフィードバック機能のリソース・タイプの分類は、次のとおりです。
urn:oracle:webcenter:feedback urn:oracle:webcenter:feedback:message
ピープル・コネクションREST APIのいずれかにアクセスするには、RESTサービスにログインする必要があります。その後、基礎となるサービスにより、権限の確認などが処理されます。
この項では、各リソース・タイプについて知っておく必要があるすべての情報を提供します。次のサブセクションが含まれます:
urn:oracle:webcenter:feedback
feedbackレスポンスには、フィードバック・メッセージの読取りに使用するURIが含まれます。
feedbackへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してfeedbackリソースにアクセスする方法を示します。
resourceIndex feedback
resourceIndex
person
feedback
feedbackでサポートされるメソッド
次のメソッドは、feedbackリソースでサポートされています。
GET
リクエスト-パラメータ: startIndex、itemsPerPage
レスポンス-本体: message
POST: 許可されている場合は、ターゲット・ユーザーに対するフィードバックを追加できます。このメソッドは、現在のユーザーがターゲット・ユーザーへのコネクションを持っており、そのユーザーに対するフィードバックを追加する権限を持っている場合にのみ使用可能です。
リクエスト - 本体: feedback
<message resourceType="urn:oracle:webcenter:feedback:message">
<body>test from REST API</body>
<receivedUser>
<guid>4F16DD80393611DFBF895F177662C511</guid>
</receivedUser>
</message>
feedbackからリンクされるリソース・タイプ
表42-22は、クライアントがfeedbackリソースからリンクできるリソース・タイプを示しています。
表42-22 feedbackに関連するリソース・タイプ
| rel | リソース・タイプ |
|---|---|
|
self urn:oracle:webcenter:feedback:all-received |
urn:oracle:webcenter:feedback |
|
self urn:oracle:webcenter:feedback:all-given |
urn:oracle:webcenter:feedback |
|
urn:oracle:webcenter:feedback:message |
urn:oracle:webcenter:feedback:message
messageレスポンスには、フィードバック・メッセージ・データおよびフィードバック・メッセージの削除に使用するURIが含まれます。
messageへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してmessageリソースにアクセスする方法を示します。
resourceIndex
feedback
message
resourceIndex
person
feedback
message
messageでサポートされるメソッド
次のメソッドは、messageでサポートされています。
DELETE
リクエスト
messageの読取り専用要素
表42-23は、messageリソースの読取り専用要素を示しています。
表42-23 messageの読取り専用要素
| 要素 | タイプ | 説明 |
|---|---|---|
|
|
String |
メッセージ・コンテンツ |
|
|
String |
メッセージの一意のID |
|
|
|
メッセージを作成したユーザー |
|
|
Date (String)脚注 1 |
リストが作成された日付 |
|
receivedUser |
|
フィードバックを受信したユーザーへの人の参照 |
脚注 1 DATEやBOOLEANなどのデータ型は、STRINGとしてAPIに格納されます。
feedbackからリンクされるリソース・タイプ
表42-24は、クライアントがfeedbackリソースからリンクできるリソース・タイプを示しています。
メッセージ・ボードREST APIを使用して、ユーザーのメッセージ・ボードまたはポータル・メッセージ・ボードへのメッセージの投稿、読取りおよび削除を行います。この項では、これらのアクションを実行するために使用するREST APIメソッドの情報を提供します。
この項には次のサブセクションが含まれます:
各RESTサービスには、そのサービスのエントリ・ポイントを提供するリソース索引内にlink要素があります。ピープル・コネクションでは、各機能に独自のlink要素があります。ピープル・コネクションのメッセージ・ボード機能のエントリ・ポイントを見つけるには、次のresourceTypeを持つlink要素を見つけます。
urn:oracle:webcenter:messageBoard
|
注意: リソース索引からのエントリ・ポイントに加えて、個々のユーザーのメッセージ・ボードにナビゲートするために、メッセージ・ボード機能には、ポータル・メッセージ・ボードのポータル・レスポンスからのエントリ・ポイントもあります。 |
対応するhrefまたはtemplate要素によって、URIエントリ・ポイントが提供され、それによって現在のユーザーのメッセージ・ボードが返されます。クライアントは、このエントリ・ポイントにHTTPリクエストを送信し、ピープル・コネクションのメッセージ・ボード機能を使用します。
クライアントがエントリ・ポイントを識別すると、リソース・タイプの分類によりナビゲートして、必要な操作を実行できます。個々のリソース・タイプの詳細は、第42.4.4項「メッセージ・ボード・リソース・タイプ」の該当の項を参照してください。
ピープル・コネクションのメッセージ・ボード機能のリソース・タイプの分類は、次のとおりです。
urn:oracle:webcenter:messageBoard urn:oracle:webcenter:messageBoard:message
ピープル・コネクションREST APIのいずれかにアクセスするには、RESTサービスにログインする必要があります。その後、基礎となるサービスにより、権限の確認などが処理されます。
この項では、各リソース・タイプについて知っておく必要があるすべての情報を提供します。次のサブセクションが含まれます:
urn:oracle:webcenter:messageBoard
messageBoardレスポンスには、ポータルおよび個々のユーザーのメッセージ・ボード・メッセージの読取り(GET)および投稿(POST)に使用するURIが含まれます。
messageBoardへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してmessageBoardリソースにアクセスする方法を示します。
resourceIndex messageBoard
resourceIndex
person
messageBoard
resourceIndex
spaces
space
messageBoard
messageBoardでサポートされるメソッド
次のメソッドは、messageBoardリソースでサポートされています。
GET
リクエスト-パラメータ: startIndex、itemsPerPage
レスポンス-本体: message
|
注意: メッセージを読み取る(取得する)ためのRESTGETコマンドは、デフォルトで表示されているメッセージをすべて取得します。第42.4.5項「可視性に基づくメッセージのフィルタリング」で説明されるように、アプリケーション・ユーザー・インタフェースを介してプライベートまたは非表示のメッセージも取得できます。メッセージの非表示および表示の詳細は、『Oracle WebCenter Portalによるポータルの構築』の「ポータルへのメッセージおよびフィードバックの追加」を参照してください。 |
POST
リクエスト-本体: message
メッセージのPOSTでは、メッセージへのリンクURLの組込みがサポートされています。
messageBoardの読取り専用要素
表42-25は、messageBoardリソースの読取り専用要素を示しています。
表42-25 messageの読取り専用要素
| 要素 | タイプ | 説明 |
|---|---|---|
|
|
String |
メッセージにリンクがある場合、 |
|
|
String |
リンクとともにメッセージの次のリンク・データを含みます。 |
messageBoardからリンクされるリソース・タイプ
表42-26は、クライアントがmessageBoardリソースからリンクできるリソース・タイプを示しています。
表42-26 messageBoardに関連するリソース・タイプ
| rel | リソース・タイプ |
|---|---|
|
self |
urn:oracle:webcenter:messageBoard |
|
urn:oracle:webcenter:messageBoard:message |
urn:oracle:webcenter:messageBoard:message
messageレスポンスには、メッセージ・ボード・メッセージ・データと、ポータルまたは個々のユーザーのメッセージ・ボード・メッセージの読取り(GET)、改訂(PUT)および削除(DELETE)に使用するURIが含まれます。
messageへのナビゲーション・パス
この項では、クライアントがハイパーメディアを経由してmessageリソースにアクセスする方法を示します。
resourceIndex
messageBoard
message
resourceIndex
person
messageBoard
message
resourceIndex
spaces
space
messageBoard
message
messageでサポートされるメソッド
次のメソッドは、messageリソースでサポートされています。
GET
リクエスト
レスポンス-本体: message
PUT
リクエスト-本体: message
レスポンス-本体: message
DELETE
リクエスト
messageの書込み可能要素
表42-27は、messageリソースの書込み可能要素を示しています。
messageの読取り専用要素
表42-28は、messageリソースの読取り専用要素を示しています。
表42-28 messageの読取り専用要素
| 要素 | タイプ | 説明 |
|---|---|---|
|
|
String |
メッセージの一意のID |
|
|
|
メッセージを作成したユーザー |
|
|
Date (String)脚注 1 |
リストが作成された日付 |
脚注 1 DATEやBOOLEANなどのデータ型は、STRINGとしてAPIに格納されます。
messageからリンクされるリソース・タイプ
表42-29は、クライアントがmessageリソースからリンクできるリソース・タイプを示しています。
メッセージを取得するREST GETコマンドでデフォルトにより、表示されるすべてのメッセージを取得しても、一連の可視性フィルタを使用するアプリケーション・ユーザー・インタフェースを介して、プライベートまたは非表示のメッセージも取得できます。
メッセージ・ボードに投稿されたメッセージは次の可視性条件を持つことができます。
パブリック
プライベート
非表示
パブリックかつ非表示
プライベートかつ非表示
デフォルトでは、メッセージはパブリックです。
プライベート・メッセージ:
メッセージ・ボードの所有者は、任意のメッセージをプライベートとしてマークできます。メッセージがプライベートとしてマークされると、そのメッセージは、メッセージの所有者がプライベート・メッセージを選択して他の人に送信しないかぎり、所有者以外には表示されません。そうでない場合、他のユーザーがプライベート・メッセージを含むメッセージ・ボードを表示しても、パブリック・メッセージのみが表示されます。
非表示のメッセージ:
メッセージ・ボードの所有者は、任意のメッセージを非表示としてマークできます。メッセージが非表示としてマークされると、そのメッセージはメッセージ・ボードの所有者には表示されませんが、メッセージ・ボードを表示する他のユーザーには表示されたままになります。
メッセージ・ボードのREST URL:
メッセージ・ボードURLフィルタのコンテキストは次のとおりです。
rest/api/messageBoards/<BOARD-TYPE>/<GUID>/<FILTER-TYPE>
ここで:
<BOARD-TYPE>はpersonまたはspaceのいずれか
<GUID >は@me、person <GUID> (<BOARD-TYPE>がpersonの場合)またはspace <GUID> (<BOARD-TYPE>がportalの場合)のいずれか
<FILTER-TYPE>はperson <BOARD-TYPE>の場合にのみ適用され、次のうちのいずれかです。
null: (デフォルト)すべてのメッセージを表示
private: プライベート・メッセージを表示
public: パブリック・メッセージを表示
hidden: 非表示かつパブリックのメッセージを表示
private_hidden: プライベートかつ非表示のメッセージを表示
適用されるHTMLメソッドのコンテキストで、使用可能なフィルタを次に示します。
GET
@me
すべて
rest/api/messageBoards/person/@me
プライベート
rest/api/messageBoards/person/@me/private
パブリック
rest/api/messageBoards/person/@me/public
非表示かつパブリック
rest/api/messageBoards/person/@me/hidden
プライベートかつ非表示
rest/api/messageBoards/person/@me/private_hidden
person
rest/api/messageBoards/person/<GUID>
GUIDがログイン・ユーザーのGUIDと一致する場合は、@meと同じフィルタ操作が適用されます。GUIDが異なる場合は、使用可能なフィルタ操作はありません。
space
rest/api/messageBoards/space/<GUID>
可視性に基づくフィルタ操作は使用できません。
POST
@me
すべて
rest/api/messageBoards/person/@me
プライベート
{"body" : "<BODY_CONTENT>",
"visibilityType" : "private"}
パブリック
{"body" : "<BODY_CONTENT>",
"visibilityType" : "public"}
非表示かつパブリック
{"body" : "<BODY_CONTENT>",
"visibilityType" : "hidden"}
プライベートかつ非表示
{"body" : "<BODY_CONTENT>",
"visibilityType" : "private_hidden"}
person
rest/api/messageBoards/person/<GUID>GUIDがログイン・ユーザーのGUIDと同じ場合は、GETのフィルタが適用されます。ユーザーが異なる場合は、次のフィルタが適用されます。
パブリック
{"body" : "<BODY_CONTENT>",
"visibilityType" : "public"}
プライベート
{"body" : "<BODY_CONTENT>",
"visibilityType" : "private"}
space
rest/api/messageBoards/space/<GUID>
可視性に基づくフィルタ操作は使用できません。
PUT
@me
すべて
est/api/messageBoards/person/@me/messages/<msg guid>
プライベート
{"body" : "<BODY_CONTENT>",
"visibilityType" : "private"}
パブリック
{"body" : "<BODY_CONTENT>",
"visibilityType" : "public"}
非表示かつパブリック
{"body" : "<BODY_CONTENT>",
"visibilityType" : "hidden"}
プライベートかつ非表示
{"body" : "<BODY_CONTENT>",
"visibilityType" : "private_hidden"}
person
rest/api/messageBoards/person/<GUID>/messages/<msg guid>GUIDがログイン・ユーザーのGUIDと同じ場合は、GETのフィルタが適用されます。ユーザーが異なる場合は、次のフィルタが適用されます。
パブリック
{"body" : "<BODY_CONTENT>",
"visibilityType" : "public"}
プライベート
{"body" : "<BODY_CONTENT>",
"visibilityType" : "private"}
space
rest/api/messageBoards/space/<GUID>/messages/<msg guid>
可視性に基づくフィルタ操作は使用できません。
この項では、ピープル・コネクション・サービスREST APIを使用して別のユーザーを招待してコネクション・リストに追加する方法を示します。招待が作成された後、招待を受けた人は、受け入れるか拒否するかを選択できます。この例では、招待の削除方法も示します。
この項には次のサブセクションが含まれます:
最初の手順は、REST APIメソッドでの通常の場合と同様に、リソース索引を取得することです。
GET http://<host:port>/rest/api/resourceIndex
次に、コネクションを持ちたい人を見つけます。これを行うには:
リソース索引リストで、次のリソース・タイプを持つリンクについてスキャンします。
urn:oracle:webcenter:people:person
招待したいユーザーの検索を実行します。この例では、ユーザーの名前はMontyです。
GET http://<host:port>/rest/api/people?q=loginid:equals:monty&utoken=ASDF
図42-1に示すようにレスポンスでMontyのGUIDを見つけます。
GUIDを保存し、それを使用してそのユーザーとコネクションを持てるようにします。
招待を受ける人のGUIDを把握したら、その人を追加するリソースを見つける必要があります。この場合は、自身のconnectionsにその人を追加します。
自身のconnectionsリストを見つけるには、connectionsについてピープル・コネクションのドキュメント(この章)をスキャンします。表42-9「personに関連するリソース・タイプ」で、personリソースからconnectionsにリンクしていることがわかります。便宜のために、この表を図42-2に示します。
connectionsがpersonリソースからリンクしていることがわかったので、personリソースを見つける必要があります。URNが示すように、次の手順に従ってpeopleリソースからpersonリソースにナビゲートします。
次のように、リソース索引に戻ります(または、前回表示したresourceIndexのキャッシュされたバージョンを使用します)。
GET http://<host:port>/rest/api/resourceIndex
peopleリソースについてスキャンして、次のものを見つけます。
urn:oracle:webcenter:people
peopleリソースのリンクを使用して自身のリストにアクセスします。
GET http://<host:port>/rest/api/people/@me/lists/@self?utoken=ASDF
表42-9に示されているresourceTypeおよびrelについて、返されたリンクをスキャンします。
resourceType="urn:oracle:webcenter:people:person:list rel="urn:oracle:webcenter:people:person:list:connections
自身のconnectionsリストのURIを使用して招待を作成し、次のようにPOSTを実行します。
POST http://<host:port>/rest/api/people/@me/lists/@connections?utoken=ASDF
Headers -- Accept:application/json, Content-Type:application/json
Body -- {"message":"Monty, do you want to join my connections list?","guid":"1AE5AF102E2611E09F062B573E287934"}
これで、Montyのアカウントにログインしたときに、図42-3のように、招待が追加されていることを確認できるようになります。
招待が送信された後、次のステップでは、招待を受けた人(Monty)が招待を受け入れます。
2番目のRESTクライアントを使用して、次のようにリソース索引を取得します。
GET http://<host:port>/rest/api/resourceIndex
Montyとしてログインします。
次のリクエストを実行して、Montyに送信されたすべての招待をリストします。
GET http://<host:port>/rest/api/people/invitations?q=invitee:equals:@me&utoken=ASDF
レスポンスにリストされている各招待要素には、UPDATE操作をサポートするリンクが含まれており、それは次のようなものになります。
<links> <link capabilities="urn:oracle:webcenter:delete urn:oracle:webcenter:update" href="http://<host:port>/rest/api/people/invitations/<invitationid>?utoken=ASDF" rel="self" resourceType="urn:oracle:webcenter:people:invitation"/> </links> <id><invitationid></id>
招待を受け入れるには、次のリクエストを実行します。
PUT http://<host:port>/rest/api/people/invitations/<invitationid>?utoken=ASDF
Headers
Accept -> application/xml
Content-Type -> application/xml
Body
<invitation>
<id><invitationid></id>
<status>accepted</status>
</invitation>
招待を開始した後、invitor:equals:@meを指定することで、自身のアカウントからその招待を表示できます。例:
GET http://<host:port>/rest/api/people/invitations?q=invitor:equals:@me&utoken=ASDF
レスポンスにリストされている各招待要素には、DELETE操作をサポートするリンクが含まれており、それは次のようなものになります。
<links>
<link resourceType="urn:oracle:webcenter:people:invitation"
rel="self"
href="http://host_name:port_name/rest/api/people/invitations/
e9073cdb-56ab-423d-8b1f-1220c802bdd4?
utoken="FN0SEFwX42OCntwtx9a1dSbhqocO_w**"
capabilities="urn:oracle:webcenter:delete"/>
</links>
招待を受けた人は、自身のアカウントから招待を削除することもできます。招待を受けた人は、次のように指定することで自身の招待のリストを取得できます。
GET http://<host:port>/rest/api/people/invitations?q=invitee:equals:@me&utoken=ASDF
DELETEからのレスポンスは、単に204のステータス・コードです。
