11.5.46 フローノード定義の一覧取得
指定した条件を満たすフローノード定義の一覧を取得します。このAPIを実行すると,BPMN連携ライブラリ Java APIのCIWBPMNLib.getFlowNodeDefinitionsListインタフェースが呼び出されます。
メソッドとURL
GET /v1/flow-node-definition/queries
クエリパラメタ
項番 |
名前 |
型 |
指定要否 |
内容 |
---|---|---|---|---|
1 |
userdescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。 |
2 |
pdname |
文字列 |
必須 |
取得するフローノード定義のビジネスプロセス定義名を指定します。空文字列は指定できません。バージョンが複数登録されている場合は,すべてのバージョンを検索します。 |
3 |
flownodeid |
文字列 |
省略可 |
取得するフローノード定義でのBPMN要素のid属性値を指定します。省略した場合,指定されたビジネスプロセス定義のすべてのフローノードIDを検索します。空文字列は指定できません。 |
4 |
flownodename |
文字列 |
省略可 |
取得するフローノード定義でのBPMN要素のname属性値を指定します。省略した場合,指定されたビジネスプロセス定義のすべてのフローノード名を検索します。 |
リクエスト例
リクエストURL
GET http://restserver/csciwws/v1/flow-node-definition/queries?pdname=OrderProcess&flownodeid=UTask1&flownodename=UserTask
レスポンス
フローノード定義一覧を返します。個々のフローノード定義のプロパティを次に示します。
項番 |
名前 |
型 |
内容 |
---|---|---|---|
1 |
FlowNodeCalledElement |
文字列 |
フローノード定義でのBPMN要素のcalledElement属性値 |
2 |
FlowNodeID |
文字列 |
フローノード定義でのBPMN要素のid属性値 |
3 |
FlowNodeName |
文字列 |
フローノード定義でのBPMN要素のname属性値 |
4 |
FlowNodeRefID |
文字列 |
フローノード定義でのBPMN要素のref識別子属性値 |
5 |
FlowNodeType |
文字列 |
フローノード定義でのBPMN要素の種類 |
6 |
IsMultiInstance |
文字列 |
フローノード定義がマルチインスタンスかどうか |
7 |
ProcessDefinitionID |
数値 |
フローノード定義に対応するCSCIWの作業定義が所属するビジネスプロセス定義のID |
8 |
ProcessDefinitionName |
文字列 |
フローノード定義に対応するCSCIWの作業定義が所属するビジネスプロセス定義の名称 |
9 |
WorkDefinitionID |
数値 |
フローノード定義に対応するCSCIWの作業定義のID |
10 |
WorkDefinitionName |
文字列 |
フローノード定義に対応するCSCIWの作業定義の名称 |
レスポンスの構造を次に示します。
項番 |
名前 |
出現回数 |
||
---|---|---|---|---|
1 |
FlowNodeDefinitions |
1 |
||
2 |
FlowNodeDefinition |
0または1以上 |
||
3 |
FlowNodeCalledElement |
1 |
||
4 |
FlowNodeID |
1 |
||
5 |
FlowNodeName |
1 |
||
6 |
FlowNodeRefID |
1 |
||
7 |
FlowNodeType |
1 |
||
8 |
IsMultiInstance |
1 |
||
9 |
ProcessDefinitionID |
1 |
||
10 |
ProcessDefinitionName |
1 |
||
11 |
WorkDefinitionID |
1 |
||
12 |
WorkDefinitionName |
1 |
ステータスコード
項番 |
ステータスコード |
内容 |
---|---|---|
1 |
200 |
成功(データが0件の場合も成功) |
2 |
400 |
リクエストパラメタの不正 |
3 |
500 |
内部処理エラー |
レスポンス例
レスポンス(XMLの場合)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <FlowNodeDefinitions> <FlowNodeDefinition> <FlowNodeCalledElement></FlowNodeCalledElement> <FlowNodeID>UTask1</FlowNodeID> <FlowNodeName>UserTask</FlowNodeName> <FlowNodeRefID></FlowNodeRefID> <FlowNodeType>USER_TASK</FlowNodeType> <IsMultiInstance>false</IsMultiInstance> <ProcessDefinitionID>5</ProcessDefinitionID> <ProcessDefinitionName>OrderProcess</ProcessDefinitionName> <WorkDefinitionID>178</WorkDefinitionID> <WorkDefinitionName>UserTask_UTask1</WorkDefinitionName> </FlowNodeDefinition> </FlowNodeDefinitions>
レスポンス(JSONの場合)
{ "FlowNodeDefinition" : [ { "FlowNodeCalledElement" : "", "FlowNodeID" : "UTask1", "FlowNodeName" : "UserTask", "FlowNodeRefID" : "", "FlowNodeType" : "USER_TASK", "IsMultiInstance" : "false", "ProcessDefinitionID" : "5", "ProcessDefinitionName" : "OrderProcess", "WorkDefinitionID" : "178", "WorkDefinitionName" : "UserTask_UTask1" } ] }