リクエストの送信
Oracle Business Process ManagementのREST APIを使用してリクエストを送信する場合は、次のガイドラインを使用します。
URLの構造
https://example.com/bpm/api/3.0/
-
example.com
- Oracle Business Process Managementが実行しているホスト。Oracle Business Process Management自体にはアクセスしないため、同じホストを使用してOracle Business Process ManagementのREST APIにアクセスします。
このドキュメントのすべての例では、簡潔になるように
example.com
をホストとして使用しています。 -
/bpm/api/3.0/
- Oracle Business Process ManagementのRESTリソースの修正済接頭辞。リソースの一覧については、「RESTエンドポイント」を参照してください。
リクエスト・データ形式
リクエストの本文パラメータの形式は次のとおりです。
{ "name1":"value1", "name2":"value2", "name3":"value3" }
パラメータにサブパラメータがある場合、角カッコで囲みます。
{ "name1":[{"subname1":"subvalue1"},{"subname2":"subvalue2"}] }
たとえば、ここでは、To Doタスク作成操作のリクエストの本文パラメータについて説明します。
本文パラメータは、dueDate、priority、startDate、title、assigneesです。assigneesのパラメータは、idとtypeです。ここでは、To Doタスク作成操作のリクエスト・データの例を示します。
{ "dueDate":"2015-07-26 11:58:59", "priority":"1", "startDate":"2015-05-26 11:58:59", "title":"myTodoTaskTesting5", "assignees":[{"id":"jlondon","type":"user"}] }
共通の問合せパラメータ
リストを取得するGET操作で、次の表に示す問合せパラメータを使用します。
名前 | 説明 |
limit |
1から100の間のページ当たりのリスト項目の最大数、デフォルトは25。たとえば、ページ当たりの項目を15に設定します。
|
offset |
リスト項目のページにある最初の項目の索引、デフォルトは1。たとえば、ページ当たりの項目が15の場合、これは2ページ目で開始します。
|
サポートされているメソッド
次の表に概要を示すように、標準HTTPメソッド・リクエストを使用して、Oracle Business Process Managementリソースに対して基本的なCRUD操作(作成、読取り、更新、削除)を実行できます。
HTTPメソッド | 説明 |
GET |
リソースに関する情報を取得します。 |
POST |
リソースを作成します。 |
PUT |
リソースを更新します。 |
DELETE |
リソースを削除します。 |
メディア・タイプ
Oracle Business Process ManagementのREST APIでサポートされるメディア・タイプはapplication/json
のみです。
サポートされているヘッダー
Oracle Business Process ManagementのREST APIでは、HTTPリクエストまたはレスポンスのヘッダー部に渡される次のヘッダーをサポートしています。
ヘッダー | 説明 | 例 |
Content-Type |
リクエストの本文のメディア・タイプ。POSTリクエストの場合に必須です。 | Content-Type: application/json |
Accept |
レスポンスの本文のメディア・タイプ。 | Accept: application/json |