プライマリ・コンテンツに移動
Oracle® Fusion Middleware Oracle WebCenter Sites REST APIリソース・リファレンス
12c (12.2.1.1)
E79302-01
  ドキュメント・ライブラリへ移動
ライブラリ		 製品リストへ移動
製品		 目次へ移動
目次
前
前 		  

1 REST API

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

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

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 Oracle WebCenter Sitesでの開発』および『Oracle Fusion Middleware Oracle WebCenter Sitesの管理』を参照してください。

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

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

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

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 アセットが存在しない場合

409 サーバーにPOSTしようとしているアセットが、現在サーバー上にあるアセットよりも古い場合。

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 Oracle 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 Oracle 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 Oracle 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 予想外のエラーが発生した場合

  前
前 
  ドキュメント・ライブラリへ移動
ライブラリ		 製品リストへ移動
製品		 目次へ移動
目次