リクエストの送信

Oracle WebCenter Portal REST APIを使用してリクエストを送信する場合、次のガイドラインを使用します。

URLの構造

次のURL構造を使用してOracle WebCenter Portal REST APIリソースにアクセスします。

https://hostname:port.com:/rest/api/

変数の意味は次のとおりです。

• hostname - WebCenter Portalを実行しているホストの名前です。

• port - WebCenter Portalを実行しているIPポートです。

• /rest/api/ - WebCenter Portal RESTリソースの修正済接頭辞です。リソースの完全なリストの詳細は、「WebCenter Portal REST APIの使用」を参照してください。

リクエスト・データ形式

リクエストの本文パラメータの形式は次のとおりです。

{"name1":"value1", "name2":"value2", "name3":"value3" }

パラメータにサブパラメータがある場合、パラメータを角カッコで囲みます。

{"name1":[{"subname1":"subvalue1"},{"subname2":"subvalue2"}] }

共通の問合せパラメータ

リストを取得するGET操作で、次の表に示す問合せパラメータを使用します。

HTTPメソッド	説明
limit	1から100の間のページ当たりのリスト項目の最大数。デフォルトは25です。 たとえば、ページ当たりの項目を15に設定します。 ?limit=15
offset	リスト項目のページにある最初の項目の索引。デフォルトは1です。 たとえば、ページ当たりの項目が15の場合、これは2ページ目で開始します。 ?offset=16
utoken	Oracle WebCenter Portalから受け取ったAPIトークンです。 APIトークンは、リソース索引ページ(http://hostname:port/rest/api)が認証付きでアクセスされた場合に受け取られます。

サポートされているメソッド

次の表にまとめているように、標準HTTPメソッド・リクエストを使用して、Oracle WebCenter Portalに対して基本的なCRUD操作(作成、読取り、更新、削除)を実行できます。

HTTPメソッド	説明
GET	リソースに関する情報を取得します。
POST	リソースの作成または更新
DELETE	リソースを削除します。
PUT	リソースを更新します。

メディア・タイプ

WebCenter Portal REST APIによってサポートされる唯一のメディア・タイプはapplication/jsonです。

サポートされているヘッダー

Oracle WebCenter Portal REST APIでは、HTTPリクエストまたはレスポンスのヘッダー・セクションで渡される可能性のある次のヘッダーをサポートしています。

ヘッダー	説明	例
Content-Type	リクエストの本文のメディア・タイプ。POSTリクエストの場合に必須です。	Content-Type: application/json
Accept	レスポンスの本文のメディア・タイプ。	Accept: application/json