付録I.14 投入するジョブの機能ごとの指定値と戻り値
ここでは，ジョブの機能ごとに，リクエストパラメタのファンクション名と引数データに指定する値，およびレスポンスボディの結果データとリターンコードに設定される値の詳細を説明します。
- 〈この項の構成〉
(1) 案件一括削除の場合
指定された条件に該当する案件を一括削除する場合は，ファンクション名（FunctionName）に「delpi」を指定します。案件一括削除は，ciwdelpiコマンドと同様の処理を実行します。ciwdelpiコマンドについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow コマンド」の「ciwdelpi（案件の削除）」を参照してください
(a) 案件一括削除の引数データの指定値
引数データ（ArgumentDataList）のKeyとValueに指定する値は，ciwdelpiコマンドのオプションとオプション引数に対応しています。
引数データのKeyとValueに指定する値と，それに対応するciwdelpiコマンドのオプションの対応を次の表に示します。
|
項番 |
Keyに指定する値 |
型 |
Keyの指定要否 |
Valueに指定する値 |
対応するciwdelpiコマンドのオプション |
|---|---|---|---|---|---|
|
1 |
DaysFromClosedDate |
数値 |
次のどちらかが必須
DaysFromStartDateと同時には指定できません。 |
削除対象の案件の終了日時からの経過日数を指定します。 |
-dfc |
|
2 |
DaysFromStartDate |
数値 |
次のどちらかが必須
DaysFromClosedDateと同時には指定できません。 |
削除対象の案件の開始日時からの経過日数を指定します。 |
-dfs |
|
3 |
UseTimeOffset |
文字列 |
省略可 |
経過日数の区切りを，trueまたはfalseで指定します。
省略した場合は，falseが指定されます。 |
-ofs |
|
4 |
IsAll |
文字列 |
省略可 |
「完了」状態以外の案件を削除する場合に指定します。
省略した場合は，falseが指定されます。 |
-all |
|
5 |
ProcessDefinitionName |
文字列 |
省略可 |
ビジネスプロセス定義名を指定します。 指定したビジネスプロセス定義名を使用して生成したすべての案件が削除対象になります。 |
-bpn |
|
6 |
ProcessDefinitionVersion |
数値 |
省略可 ProcessDefinitionNameを指定した場合にだけ指定できます。 |
ビジネスプロセス定義のバージョンを指定します。 指定したビジネスプロセス定義の，指定したバージョンのビジネスプロセス定義を使用して生成した，すべての案件が削除対象になります。 |
-bpv |
|
7 |
Name |
文字列 |
省略可 |
案件名を指定します。 指定した案件名を使用して生成したすべての案件が削除対象になります。案件名が設定されていない案件を削除対象にする場合には，値を指定しないでください。また，案件名はワイルドカードが指定できます。 例：案件A% |
-pin |
|
8 |
Escape |
文字列 |
省略可 Nameを指定した場合にだけ指定できます。 |
Nameを指定した場合に案件名で使用するエスケープ文字を指定します。 |
-esc |
|
9 |
Unit |
文字列 |
省略可 |
削除処理のトランザクションの処理単位を指定します。 省略した場合は，デフォルト値の100が指定されます。 |
-unt |
(b) 案件一括削除のジョブの取得時のリターンコード
案件の一括削除のジョブが完了すると，ciwdelpiコマンドの戻り値と同じ値がジョブレコードのリターンコード（ReturnCode）に設定されます。また，リターンコードの値に対応してジョブレコードの状態（StateCode）も設定されます。
リターンコードと状態の対応を次の表に示します。
|
リターンコード |
状態 |
|---|---|
|
0（正常終了） |
o（正常終了） |
|
20（条件に指定した案件が１件も存在しない） |
o（正常終了） |
|
それ以外 |
v（異常終了） |
(c) 案件一括削除の結果データに設定される値
案件の一括削除が完了すると，ジョブレコードの結果データ（ResultData）のKeyとValueに次の表に示す内容が設定されます。
|
項番 |
Keyの内容 |
Valueの内容 |
|---|---|---|
|
1 |
NumOfDeletedPI |
削除した案件の数 |
|
2 |
NumOfDeletedChildPI |
削除した子案件の数 BPMN連携機能を使用しない場合は0になります。 |