11.5.45 アドホック・サブプロセスのフローノードを生成
指定されたアドホック・サブプロセス内のフローノードを生成します。このAPIを実行すると,BPMN連携ライブラリ Java APIのCIWBPMNLib.createFlowNodeInstanceForAdHocSubProcessインタフェースが呼び出されます。指定したアドホック・サブプロセスのフローノードが生成済みの場合は,リクエストは成功します(何もしないでステータスコード201を返します)。詳細については,「5.3 Java API利用時の注意事項」の「べき等性について」の説明を参照してください。
メソッドとURL
POST /v1/flow-node-instance/create
リクエストボディ
項番 |
名前 |
型 |
指定要否 |
内容 |
---|---|---|---|---|
1 |
UserDescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。 |
2 |
ProcessInstanceID |
数値 |
必須 |
対象であるアドホック・サブプロセスが所属する案件IDを指定します。 |
3 |
FlowNodeID |
文字列 |
省略可(FlowNodeNameを省略した場合は必須) |
生成するフローノードのフローノードIDを指定します。省略した場合,フローノードIDは指定されません。空文字列は指定できません。 |
4 |
FlowNodeName |
文字列 |
省略可(FlowNodeIDを省略した場合は必須) |
生成するフローノードのフローノード名を指定します。省略した場合,フローノード名は指定されません。 |
5 |
MIIndex |
数値 |
省略可 |
生成するフローノードがあるアドホック・サブプロセスのマルチインスタンスインデクスを指定します。省略した場合,マルチインスタンスインデクスは指定されません。 |
6 |
ProcessDataList |
配列 |
省略可 |
プロセスデータ一覧を指定します。省略した場合,プロセスデータは更新されません。 |
7 |
ProcessData |
オブジェクト |
必須 |
プロセスデータオブジェクトを指定します。次の2つの要素(KeyおよびValue)から構成されています。 |
8 |
Key |
文字列 |
必須 |
プロセスデータのキー名を指定します。空文字列は指定できません。 |
9 |
Value |
文字列 |
省略可 |
プロセスデータ値を指定します。省略した場合,キーに対応する値は設定されません。空文字列は指定できません。 |
リクエストボディの構造を次に示します。
項番 |
名前 |
出現回数 |
|||
---|---|---|---|---|---|
1 |
Parameter |
1 |
|||
2 |
UserDescription |
0または1 |
|||
3 |
ProcessInstanceID |
1 |
|||
4 |
FlowNodeID |
0または1 |
|||
5 |
FlowNodeName |
0または1 |
|||
6 |
MIIndex |
0または1 |
|||
7 |
ProcessDataList |
0または1 |
|||
8 |
ProcessData |
1以上 |
|||
9 |
Key |
1 |
|||
10 |
Value |
0または1 |
リクエスト例
リクエストURL
POST http://restserver/csciwws/v1/flow-node-instance/create
リクエストボディ(XMLの場合)
<?xml version="1.0" encoding="UTF-8" ?> <Parameter> <UserDescription>csciwuser</UserDescription> <ProcessInstanceID>3315</ProcessInstanceID> <FlowNodeID>UTask1</FlowNodeID> <FlowNodeName>UserTask</FlowNodeName> </Parameter>
リクエストボディ(JSONの場合)
{ "UserDescription" : "csciwuser", "ProcessInstanceID" : "3315", "FlowNodeID" : "UTask1", "FlowNodeName" : "UserTask" }
レスポンス
作成したフローノードの一覧を返します。個々のフローノードのプロパティを次に示します。
項番 |
名前 |
型 |
内容 |
---|---|---|---|
1 |
ActivityInstanceID |
数値 |
フローノードに対応するCSCIWの作業が所属する業務ステップのID |
2 |
FlowNodeID |
数値 |
フローノードでのBPMN要素のid属性値 |
3 |
FlowNodeMIIndex |
数値 |
フローノードでのマルチインスタンスインデクス |
4 |
FlowNodeName |
文字列 |
フローノードでのBPMN要素のname属性値 |
5 |
FlowNodeType |
文字列 |
フローノードでのBPMN要素の種類 |
6 |
IsMultiInstance |
文字列 |
フローノードがマルチインスタンスかどうか |
7 |
ProcessDefinitionID |
数値 |
フローノードに対応するCSCIWの作業が所属するビジネスプロセス定義のID |
8 |
ProcessDefinitionName |
文字列 |
フローノードに対応するCSCIWの作業が所属するビジネスプロセス定義の名称 |
9 |
ProcessInstanceID |
数値 |
フローノードに対応するCSCIWの作業が所属する案件のID |
10 |
ProcessInstanceName |
文字列 |
フローノードに対応するCSCIWの作業の案件名(案件キー) |
11 |
WorkItemClosedDate |
日付 |
フローノードに対応するCSCIWの作業の終了日時 |
12 |
WorkItemCreationDate |
日付 |
フローノードに対応するCSCIWの作業の発生日時 |
13 |
WorkItemDeadline |
日付 |
フローノードに対応するCSCIWの作業の処理期限の絶対日時 |
14 |
WorkItemID |
数値 |
フローノードに対応するCSCIWの作業のID |
15 |
WorkItemParticipant |
文字列 |
フローノードに対応するCSCIWの作業の作業者ID |
16 |
WorkItemStartDate |
日付 |
フローノードに対応するCSCIWの作業の開始日時 |
17 |
WorkItemState |
文字列 |
フローノードに対応するCSCIWの作業の状態 |
レスポンスの構造を次に示します。
項番 |
名前 |
出現回数 |
||
---|---|---|---|---|
1 |
FlowNodeInstances |
1 |
||
2 |
FlowNodeInstance |
0または1以上 |
||
3 |
ActivityInstanceID |
1 |
||
4 |
FlowNodeID |
1 |
||
5 |
FlowNodeMIIndex |
1 |
||
6 |
FlowNodeName |
1 |
||
7 |
FlowNodeType |
1 |
||
8 |
IsMultiInstance |
1 |
||
9 |
ProcessDefinitionID |
1 |
||
10 |
ProcessDefinitionName |
1 |
||
11 |
ProcessInstanceID |
1 |
||
12 |
ProcessInstanceName |
1 |
||
13 |
WorkItemClosedDate |
1 |
||
14 |
WorkItemCreationDate |
1 |
||
15 |
WorkItemDeadline |
1 |
||
16 |
WorkItemID |
1 |
||
17 |
WorkItemParticipant |
1 |
||
18 |
WorkItemStartDate |
1 |
||
19 |
WorkItemState |
1 |
ステータスコード
項番 |
ステータスコード |
内容 |
---|---|---|
1 |
201 |
成功 |
2 |
400 |
リクエストパラメタの不正 |
3 |
404 |
データが見つからなかった |
4 |
500 |
内部処理エラー |
レスポンス例
レスポンス(XMLの場合)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <FlowNodeInstances> <FlowNodeInstance> <ActivityInstanceID>13508</ActivityInstanceID> <FlowNodeID>UTask1</FlowNodeID> <FlowNodeMIIndex></FlowNodeMIIndex> <FlowNodeName>UserTask</FlowNodeName> <FlowNodeType>USER_TASK</FlowNodeType> <IsMultiInstance>false</IsMultiInstance> <ProcessDefinitionID>4</ProcessDefinitionID> <ProcessDefinitionName>販売業務</ProcessDefinitionName> <ProcessInstanceID>3315</ProcessInstanceID> <ProcessInstanceName>案件43496</ProcessInstanceName> <WorkItemClosedDate></WorkItemClosedDate> <WorkItemCreationDate>2016-12-03T17:31:12+09:00</WorkItemCreationDate> <WorkItemDeadline></WorkItemDeadline> <WorkItemID>16422</WorkItemID> <WorkItemParticipant></WorkItemParticipant> <WorkItemStartDate>2016-12-03T17:33:00+09:00</WorkItemStartDate> <WorkItemState>d</WorkItemState> </FlowNodeInstance> </FlowNodeInstances>
レスポンス(JSONの場合)
{ "FlowNodeInstance" : [ { "ActivityInstanceID" : "13508", "FlowNodeID" : "UTask1", "FlowNodeMIIndex" : "", "FlowNodeName" : "UserTask", "FlowNodeType" : "USER_TASK", "IsMultiInstance" : "false", "ProcessDefinitionID" : "4", "ProcessDefinitionName" : "販売業務", "ProcessInstanceID" : "3315", "ProcessInstanceName" : "案件43496", "WorkItemClosedDate" : "", "WorkItemCreationDate" : "2016-12-03T17:31:12+09:00", "WorkItemDeadline" : "", "WorkItemID" : "16422", "WorkItemParticipant" : "", "WorkItemStartDate" : "2016-12-03T17:33:00+09:00", "WorkItemState" : "d" } ] }