11.2 REST API一覧
RESTサービスが対応するリソースの操作と，それに対応するURLの一覧を示します。
REST APIの一覧
REST APIを使用したリソースの操作とURLの対応を次の表に示します。
|
項番 |
リソースの操作 |
URL※ |
|
|---|---|---|---|
|
－ |
案件 |
||
|
1 |
案件の一覧を取得する |
GET /v1/process-instance |
|
|
2 |
指定したプロセスデータを含む案件の一覧を取得する |
POST /v1/process-instance/process-data |
|
|
3 |
案件数を取得する |
GET /v1/process-instance/count |
|
|
4 |
案件を取得する |
GET /v1/process-instance/(PIID) |
|
|
5 |
ビジネスプロセス定義名から案件を取得する |
GET /v1/process-instance/queries |
|
|
6 |
案件を生成して開始する |
POST /v1/process-instance/create-and-start |
|
|
7 |
案件（メッセージ）を生成して開始する |
POST /v1/process-instance/create-and-start-message |
|
|
8 |
案件（タイマー）を生成して開始する |
POST /v1/process-instance/create-and-start-timer |
|
|
9 |
案件を削除する |
DELETE /v1/process-instance/(PIID) |
|
|
10 |
案件を強制終了する |
PUT /v1/process-instance/(PIID)/terminate |
|
|
11 |
親案件を取得する |
GET /v1/process-instance/(PIID)/call-activity-parent/process-instance |
|
|
12 |
コールアクティビティを取得する |
GET /v1/process-instance/(PIID)/call-activity-parent/work-item |
|
|
－ |
業務ステップ |
||
|
13 |
業務ステップの一覧を取得する |
GET /v1/activity-instance |
|
|
14 |
業務ステップ数を取得する |
GET /v1/activity-instance/count |
|
|
15 |
業務ステップを取得する |
GET /v1/activity-instance/(PIID)/(AIID) |
|
|
16 |
業務ステップを差し戻すまたは引き戻す |
PUT /v1/activity-instance/(PIID)/(AIID)/make-backward-transition |
|
|
17 |
業務ステップを強制遷移する |
PUT /v1/activity-instance/(PIID)/(AIID)/adhoc-create-and-make-transition |
|
|
18 |
業務ステップの状態を変更する |
PUT /v1/activity-instance/(PIID)/(AIID)/change-state |
|
|
－ |
作業 |
||
|
19 |
作業の一覧を取得する |
GET /v1/work-item |
|
|
20 |
作業数を取得する |
GET /v1/work-item/count |
|
|
21 |
作業を取得する |
GET /v1/work-item/(PIID)/(WIID) |
|
|
22 |
作業に着手する |
PUT /v1/work-item/(PIID)/(WIID)/perform |
|
|
23 |
作業を完了する |
PUT /v1/work-item/(PIID)/(WIID)/complete |
|
|
24 |
作業者を変更する |
PUT /v1/work-item/(PIID)/(WIID)/reassign |
|
|
25 |
作業者を変更して着手する |
PUT /v1/work-item/(PIID)/(WIID)/reassign-and-perform |
|
|
26 |
作業を着手して完了する |
PUT /v1/work-item/(PIID)/(WIID)/perform-and-complete |
|
|
27 |
作業の状態を変更する |
PUT /v1/work-item/(PIID)/(WIID)/change-state |
|
|
28 |
条件に一致する作業の作業者割り当てと着手をする |
PUT /v1/work-item/allocate |
|
|
29 |
着手した作業を返却する |
PUT /v1/work-item/(PIID)/(WIID)/free |
|
|
30 |
タイマーの処理期限を変更する |
PUT /v1/work-item/(PIID)/(WIID)/timer/set-deadline |
|
|
31 |
子案件を取得する |
GET /v1/work-item/(PIID)/(WIID)/call-activity-child/process-instance |
|
|
－ |
ビジネスプロセス定義 |
||
|
32 |
ビジネスプロセス定義の一覧を取得する |
GET /v1/process-definition |
|
|
33 |
ビジネスプロセス定義数を取得する |
GET /v1/process-definition/count |
|
|
34 |
ビジネスプロセス定義を取得する |
GET /v1/process-definition/(PDID) |
|
|
35 |
ビジネスプロセス定義内の案件の一覧を取得する |
GET /v1/process-definition/(PDID)/process-instance |
|
|
－ |
作業定義 |
||
|
36 |
作業定義の一覧を取得する |
GET /v1/work-definition |
|
|
37 |
作業定義数を取得する |
GET /v1/work-definition/count |
|
|
38 |
作業定義を取得する |
GET /v1/work-definition/(PDID)/(WDID) |
|
|
－ |
BPMNビジネスプロセス定義ファイル |
||
|
39 |
BPMNビジネスプロセス定義ファイルを取得する |
GET /v1/bpmn/(PIID) |
|
|
－ |
イベント |
||
|
40 |
イベント（メッセージ）を送信する |
POST /v1/event/send-message/(PIID) |
|
|
－ |
プロセスデータ |
||
|
41 |
プロセスデータを取得する |
POST /v1/process-data |
|
|
42 |
プロセスデータを登録する |
POST /v1/process-data/set-process-data |
|
|
43 |
リスト型プロセスデータのインデクスを取得する |
POST /v1/process-data/list-index |
|
|
－ |
フローノード |
||
|
44 |
フローノード一覧を取得する |
GET /v1/flow-node-instance/queries |
|
|
45 |
アドホック・サブプロセスのフローノードを生成する |
POST /v1/flow-node-instance/create |
|
|
－ |
フローノード定義 |
||
|
46 |
フローノード定義一覧を取得する |
GET /v1/flow-node-definition/queries |
|
|
－ |
アドホック・サブプロセス |
||
|
47 |
アドホック・サブプロセスの状態を変更する |
PUT /v1/adhoc-sub-process/change-state |
|
|
－ |
業務ステップ定義 |
||
|
48 |
業務ステップ定義一覧を取得する |
GET /v1/activity-definition |
|
|
49 |
業務ステップ定義数を取得する |
GET /v1/activity-definition/count |
|
|
50 |
業務ステップ定義を取得する |
GET /v1/activity-definition/(PDID)/(ADID) |
|
- 注※ 括弧内の文字列は，次のIDを表します。
-
(PIID)：案件ID
(AIID)：業務ステップのID
(WIID)：作業ID
(PDID)：ビジネスプロセス定義のID
(WDID)：作業定義のID
(ADID)：業務ステップ定義のID