リクエストの送信
Oracle WebCenter Portal REST APIを使用してリクエストを送信する場合、次のガイドラインを使用します。
URLの構造
https://hostname:port/rest/api/v1/resource-path?utoken=sampletoken
-
hostname
- WebCenter Portalを実行しているホストの名前です。 -
port
- WebCenter Portalを実行しているIPポートです。 -
/rest/api/v1
- WebCenter Portal RESTリソースの修正済接頭辞です。リソースの完全なリストの詳細は、「WebCenter Portal REST APIの使用」を参照してください。 -
resource-path
はRESTエンドポイントを定義する相対パスです。例:/portal/portals
。RESTエンドポイントの完全なリストは、「すべてのRESTエンドポイント」を参照してください。 -
utoken
は、ポータルAPIにアクセスするためのAPIトークンです。「認証」を参照してください。
リクエスト・データ形式
リクエストの本文パラメータの形式は次のとおりです。
{"name1":"value1", "name2":"value2", "name3":"value3" }
パラメータにサブパラメータがある場合、パラメータを角カッコで囲みます。
{"name1":[{"subname1":"subvalue1"},{"subname2":"subvalue2"}] }
共通の問合せパラメータ
リストを取得するGET
操作で、次の表に示す問合せパラメータを使用します。
HTTPメソッド | 説明 |
limit |
1から100の間のページ当たりのリスト項目の最大数。デフォルトは25です。 たとえば、ページ当たりの項目を15に設定します。
|
offset |
リスト項目のページにある最初の項目の索引。デフォルトは1です。 たとえば、ページ当たりの項目が15の場合、これは2ページ目で開始します。
|
utoken |
Oracle WebCenter Portalから受け取ったAPIトークンです。 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 |