11.5.44 フローノードの一覧取得
指定された条件を満たすフローノードの一覧を取得します。このAPIを実行すると,BPMN連携ライブラリ Java APIのCIWBPMNLib.getFlowNodeInstancesListByPDNameインタフェース,またはCIWBPMNLib.getFlowNodeInstancesListByPIIDインタフェースが呼び出されます。
メソッドとURL
GET /v1/flow-node-instance/queries
クエリパラメタ
項番 |
名前 |
型 |
指定要否 |
内容 |
---|---|---|---|---|
1 |
userdescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。 |
2 |
pdname |
文字列 |
次のどちらかが必須
|
取得するフローノードのビジネスプロセス定義名を指定します。バージョンが複数登録されている場合,すべてのバージョンを検索します。piidと同時には指定できません。 |
3 |
piid |
数値 |
次のどちらかが必須
|
取得するフローノードの案件のIDを指定します。pdnameと同時には指定できません。 |
4 |
flownodeid |
文字列 |
省略可 |
取得するフローノードIDを指定します。省略した場合,指定された案件のすべてのフローノードIDを検索します。空文字列は指定できません。 |
5 |
flownodename |
文字列 |
省略可 |
取得するフローノード名を指定します。省略した場合,指定された案件のすべてのフローノード名を検索します。 |
6 |
statecode |
文字列 |
|
取得するフローノードに対応するCSCIWの作業の状態を指定します。空文字列は指定できません。複数の状態を指定する場合は,状態コードを同時に指定します。例えば,「実行開始可能」と「実行済」の状態を取得する場合は"jr"と指定します。 |
7 |
miindex |
数値 |
省略可 |
取得するフローノードのマルチインスタンスインデクスを指定します。省略した場合,マルチインスタンスインデクスを指定しません。 |
リクエスト例
リクエストURL
GET http://restserver/csciwws/v1/flow-node-instance/queries?pdname=販売業務&flownodeid=UTask1&flownodename=UserTask&statecode=j GET http://restserver/csciwws/v1/flow-node-instance/queries?piid=2215&flownodeid=UTask1&flownodename=UserTask&statecode=j
レスポンス
フローノード一覧を返します。個々のフローノードのプロパティを次に示します。
項番 |
名前 |
型 |
内容 |
---|---|---|---|
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 |
200 |
成功(データが0件の場合も成功) |
2 |
400 |
リクエストパラメタの不正 |
3 |
500 |
内部処理エラー |
レスポンス例
レスポンス(XMLの場合)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <FlowNodeInstances> <FlowNodeInstance> <ActivityInstanceID>13006</ActivityInstanceID> <FlowNodeID>UTask1</FlowNodeID> <FlowNodeMIIndex></FlowNodeMIIndex> <FlowNodeName>UserTask</FlowNodeName> <FlowNodeType>USER_TASK</FlowNodeType> <IsMultiInstance>false</IsMultiInstance> <ProcessDefinitionID>3</ProcessDefinitionID> <ProcessDefinitionName>販売業務</ProcessDefinitionName> <ProcessInstanceID>2215</ProcessInstanceID> <ProcessInstanceName>案件43466</ProcessInstanceName> <WorkItemClosedDate></WorkItemClosedDate> <WorkItemCreationDate>2016-12-03T15:31:12+09:00</WorkItemCreationDate> <WorkItemDeadline></WorkItemDeadline> <WorkItemID>15220</WorkItemID> <WorkItemParticipant></WorkItemParticipant> <WorkItemStartDate>2016-12-03T15:33:00+09:00</WorkItemStartDate> <WorkItemState>j</WorkItemState> </FlowNodeInstance> </FlowNodeInstances>
レスポンス(JSONの場合)
{ "FlowNodeInstance" : [ { "ActivityInstanceID" : "13006", "FlowNodeID" : "UTask1", "FlowNodeMIIndex" : "", "FlowNodeName" : "UserTask", "FlowNodeType" : "USER_TASK", "IsMultiInstance" : "false", "ProcessDefinitionID" : "3", "ProcessDefinitionName" : "販売業務", "ProcessInstanceID" : "2215", "ProcessInstanceName" : "案件43466", "WorkItemClosedDate" : "", "WorkItemCreationDate" : "2016-12-03T15:31:12+09:00", "WorkItemDeadline" : "", "WorkItemID" : "15220", "WorkItemParticipant" : "", "WorkItemStartDate" : "2016-12-03T15:33:00+09:00", "WorkItemState" : "j" } ] }