11.4 XMLスキーマファイル
REST APIのリクエスト，レスポンスで使用するXMLスキーマのファイルの一覧を示します。
XMLスキーマファイルの一覧
REST APIのリクエストパラメタ，レスポンスデータをXML形式で定義した，XMLスキーマをファイル形式で提供します。
REST APIとXMLスキーマファイルの対応を次に示します。XMLスキーマファイルの格納先は，<CSCIWのインストールディレクトリ>/bpmn/schemaです。
|
項番 |
REST API |
XMLスキーマファイル |
|
|---|---|---|---|
|
－ |
案件 |
||
|
1 |
案件の一覧を取得する |
getProcessInstanceListResponse.xsd |
|
|
2 |
指定したプロセスデータを含む案件の一覧を取得する |
getProcessInstanceListWithProcessDataRequest.xsd getProcessInstanceListResponse.xsd |
|
|
3 |
案件数を取得する |
getResourceCountResponse.xsd |
|
|
4 |
案件を取得する |
getProcessInstanceResponse.xsd |
|
|
5 |
ビジネスプロセス定義名から案件を取得する |
getProcessInstanceListResponse.xsd |
|
|
6 |
案件を生成して開始する |
createAndStartProcessInstanceRequest.xsd getProcessInstanceResponse.xsd |
|
|
7 |
案件（メッセージ）を生成して開始する |
createAndStartMessageProcessInstanceRequest.xsd getProcessInstanceResponse.xsd |
|
|
8 |
案件（タイマー）を生成して開始する |
createAndStartTimerProcessInstanceRequest.xsd getProcessInstanceResponse.xsd |
|
|
9 |
案件を削除する |
－ |
|
|
10 |
案件を強制終了する |
terminateProcessInstanceRequest.xsd getProcessInstanceResponse.xsd |
|
|
11 |
親案件を取得する |
getProcessInstanceResponse.xsd |
|
|
12 |
コールアクティビティを取得する |
getWorkItemResponse.xsd |
|
|
－ |
業務ステップ |
||
|
13 |
業務ステップの一覧を取得する |
getActivityInstanceListResponse.xsd |
|
|
14 |
業務ステップ数を取得する |
getResourceCountResponse.xsd |
|
|
15 |
業務ステップを取得する |
getActivityInstanceResponse.xsd |
|
|
16 |
業務ステップを差し戻すまたは引き戻す |
makeBackwardTransitionActivityInstanceRequest.xsd getActivityInstanceResponse.xsd |
|
|
17 |
業務ステップを強制遷移する |
adhocCreateAndMakeTransitionRequest.xsd getActivityInstanceResponse.xsd |
|
|
18 |
業務ステップの状態を変更する |
changeActivityInstanceStateRequest.xsd getActivityInstanceResponse.xsd |
|
|
－ |
作業 |
||
|
19 |
作業の一覧を取得する |
getWorkItemListResponse.xsd |
|
|
20 |
作業数を取得する |
getResourceCountResponse.xsd |
|
|
21 |
作業を取得する |
getWorkItemResponse.xsd |
|
|
22 |
作業に着手する |
performWorkItemRequest.xsd getWorkItemResponse.xsd |
|
|
23 |
作業を完了する |
completeWorkItemRequest.xsd getWorkItemResponse.xsd |
|
|
24 |
作業者を変更する |
reassignWorkItemRequest.xsd getWorkItemResponse.xsd |
|
|
25 |
作業者を変更して着手する |
reassignAndPerformWorkItemRequest.xsd getWorkItemResponse.xsd |
|
|
26 |
作業を着手して完了する |
performAndCompleteWorkItemRequest.xsd getWorkItemResponse.xsd |
|
|
27 |
作業の状態を変更する |
changeWorkItemStateRequest.xsd getWorkItemResponse.xsd |
|
|
28 |
条件に一致する作業の作業者割り当てと着手をする |
allocateWorkItemRequest.xsd getWorkItemResponse.xsd |
|
|
29 |
着手した作業を返却する |
freeWorkItemRequest.xsd getWorkItemResponse.xsd |
|
|
30 |
タイマーの処理期限を変更する |
setWorkItemDeadlineRequest.xsd getWorkItemResponse.xsd |
|
|
31 |
子案件を取得する |
getProcessInstanceResponse.xsd |
|
|
－ |
ビジネスプロセス定義 |
||
|
32 |
ビジネスプロセス定義の一覧を取得する |
getProcessDefinitionListResponse.xsd |
|
|
33 |
ビジネスプロセス定義数を取得する |
getResourceCountResponse.xsd |
|
|
34 |
ビジネスプロセス定義を取得する |
getProcessDefinitionResponse.xsd |
|
|
35 |
ビジネスプロセス定義内の案件の一覧を取得する |
getProcessInstanceListResponse.xsd |
|
|
－ |
作業定義 |
||
|
36 |
作業定義の一覧を取得する |
getWorkDefinitionListResponse.xsd |
|
|
37 |
作業定義数を取得する |
getResourceCountResponse.xsd |
|
|
38 |
作業定義を取得する |
getWorkDefinitionResponse.xsd |
|
|
－ |
BPMNビジネスプロセス定義ファイル |
||
|
39 |
BPMNビジネスプロセス定義ファイルを取得する |
－ |
|
|
－ |
イベント |
||
|
40 |
イベント（メッセージ）を送信する |
sendMessageRequest.xsd |
|
|
－ |
プロセスデータ |
||
|
41 |
プロセスデータを取得する |
getProcessDataRequest.xsd getProcessDataResponse.xsd |
|
|
42 |
プロセスデータを登録する |
setProcessDataRequest.xsd |
|
|
43 |
リスト型プロセスデータのインデクスを取得する |
getListProcessDataIndexRequest.xsd getListProcessDataIndexResponse.xsd |
|
|
－ |
フローノード |
||
|
44 |
フローノード一覧を取得する |
getFlowNodeInstanceListResponse.xsd |
|
|
45 |
アドホック・サブプロセスのフローノードを生成する |
createFlowNodeInstanceRequest.xsd getFlowNodeInstanceListResponse.xsd |
|
|
－ |
フローノード定義 |
||
|
46 |
フローノード定義一覧を取得する |
getFlowNodeDefinitionListResponse.xsd |
|
|
－ |
アドホック・サブプロセス |
||
|
47 |
アドホック・サブプロセスの状態を変更する |
changeAdHocSubProcessStateRequest.xsd |
|
|
－ |
業務ステップ定義 |
||
|
48 |
業務ステップ定義の一覧を取得する |
getActivityDefinitionListResponse.xsd |
|
|
49 |
業務ステップ定義数を取得する |
getResourceCountResponse.xsd |
|
|
50 |
業務ステップ定義を取得する |
getActivityDefinitionResponse.xsd |
|
- （凡例）
-
－：該当なし