11.5.32 ビジネスプロセス定義の一覧取得
指定したフィルター条件を満たす,ビジネスプロセス定義の一覧を取得します。このAPIを実行すると,CSCIW Java APIのCIWServer.getProcessDefinitionsListインタフェースが呼び出されます。
メソッドとURL
GET /v1/process-definition
クエリパラメタ
項番 |
名前 |
型 |
指定要否 |
内容 |
---|---|---|---|---|
1 |
userdescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。 |
2 |
filter |
文字列 |
省略可 |
ビジネスプロセス定義一覧を取得する場合のフィルター条件を指定します。省略した場合はフィルター条件を指定しません。空文字列は指定できません。 |
3 |
sort |
文字列 |
省略可 |
取得したビジネスプロセス定義一覧をソートする場合の条件を指定します。省略した場合はソート条件を指定しません。空文字列は指定できません。 |
4 |
offset |
数値 |
省略可 |
ビジネスプロセス定義一覧を取得する場合のオフセットを指定します。先頭は0になります。省略した場合は0が指定されます。0未満の値は指定できません。 |
5 |
maxcount |
数値 |
省略可 |
ビジネスプロセス定義一覧を取得する場合の最大取得数を指定します。省略した場合はデフォルト値が指定されます。すべてを取得する場合は,-1を指定します。-1未満の値は指定できません。 |
リクエスト例
リクエストURL
GET http://restserver/csciwws/v1/process-definition?filter=ID%3D1%20OR%20ID%3D3
レスポンス
ビジネスプロセス定義一覧を返します。個々のビジネスプロセス定義のプロパティを次に示します。
項番 |
名前 |
型 |
内容 |
---|---|---|---|
1 |
Author |
文字列 |
ビジネスプロセス定義の作成者 |
2 |
CreationDate |
日付 |
ビジネスプロセス定義の作成日 |
3 |
Description |
文字列 |
ビジネスプロセス定義の説明 |
4 |
ID |
数値 |
ビジネスプロセス定義のID |
5 |
Name |
文字列 |
ビジネスプロセス定義の名称 |
6 |
Responsible |
文字列 |
ビジネスプロセス定義の管理者ID |
7 |
StateCode |
文字列 |
ビジネスプロセス定義の状態 |
8 |
ValidFromDate |
日付 |
ビジネスプロセス定義の有効となる日 |
9 |
ValidToDate |
日付 |
ビジネスプロセス定義の無効となる日 |
10 |
Version |
数値 |
ビジネスプロセス定義のバージョン |
レスポンスの構造を次に示します。
項番 |
名前 |
出現回数 |
||
---|---|---|---|---|
1 |
ProcessDefinitions |
1 |
||
2 |
ProcessDefinition |
0または1以上 |
||
3 |
Author |
1 |
||
4 |
CreationDate |
1 |
||
5 |
Description |
1 |
||
6 |
ID |
1 |
||
7 |
Name |
1 |
||
8 |
Responsible |
1 |
||
9 |
StateCode |
1 |
||
10 |
ValidFromDate |
1 |
||
11 |
ValidToDate |
1 |
||
12 |
Version |
1 |
ステータスコード
項番 |
ステータスコード |
内容 |
---|---|---|
1 |
200 |
成功(データが0件の場合も成功) |
2 |
400 |
リクエストパラメタの不正 |
3 |
500 |
内部処理エラー |
レスポンス例
レスポンス(XMLの場合)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ProcessDefinitions> <ProcessDefinition> <Author>user1</Author> <CreationDate>2016-12-06T15:18:34+09:00</CreationDate> <Description></Description> <ID>1</ID> <Name>販売業務</Name> <Responsible>user1</Responsible> <StateCode>b</StateCode> <ValidFromDate>ORIGIN</ValidFromDate> <ValidToDate>BEYOND</ValidToDate> <Version>1</Version> </ProcessDefinition> <ProcessDefinition> <Author>user1</Author> <CreationDate>2016-12-06T15:18:35+09:00</CreationDate> <Description></Description> <ID>3</ID> <Name>販売業務</Name> <Responsible>user1</Responsible> <StateCode>b</StateCode> <ValidFromDate>ORIGIN</ValidFromDate> <ValidToDate>BEYOND</ValidToDate> <Version>2</Version> </ProcessDefinition> </ProcessDefinitions>
レスポンス(JSONの場合)
{ "ProcessDefinition" : [ { "Author" : "user1", "CreationDate" : "2016-12-06T15:18:34+09:00", "Description" : "", "ID" : "1", "Name" : "販売業務", "Responsible" : "user1", "StateCode" : "b", "ValidFromDate" : "ORIGIN", "ValidToDate" : "BEYOND", "Version" : "1" }, { "Author" : "user1", "CreationDate" : "2016-12-06T15:18:35+09:00", "Description" : "", "ID" : "3", "Name" : "販売業務", "Responsible" : "user1", "StateCode" : "b", "ValidFromDate" : "ORIGIN", "ValidToDate" : "BEYOND", "Version" : "2" } ] }