11.5.48 業務ステップ定義の一覧取得
指定されたフィルター条件を満たす,業務ステップ定義の一覧を取得します。このAPIを実行すると,CSCIW Java APIのCIWServer.getActivityDefinitionsListインタフェースが呼び出されます。
メソッドとURL
GET /v1/activity-definition
クエリパラメタ
項番 |
名前 |
型 |
指定要否 |
内容 |
---|---|---|---|---|
1 |
userdescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合,デフォルト値が指定されます。空文字列は指定できません。 |
2 |
filter |
文字列 |
省略可 |
業務ステップ定義一覧を取得する場合のフィルター条件を指定します。省略した場合,フィルター条件は指定されません。空文字列は指定できません。 |
3 |
sort |
文字列 |
省略可 |
取得した業務ステップ定義一覧をソートする場合の条件を指定します。省略した場合,ソート条件は指定されません。空文字列は指定できません。 |
4 |
offset |
数値 |
省略可 |
業務ステップ定義一覧を取得する場合のオフセットを指定します。先頭は0になります。省略した場合は0が指定されます。0未満の値は指定できません。 |
5 |
maxcount |
数値 |
省略可 |
業務ステップ定義一覧を取得する場合の最大取得数を指定します。省略した場合,デフォルト値が指定されます。すべてを取得する場合は,-1を指定します。-1未満の値は指定できません。 |
リクエスト例
リクエストURL
GET http://restserver/csciwws/v1/activity-definition?filter=ProcessDefinitionID%3D1001
レスポンス
業務ステップ定義一覧を返します。個々の業務ステップ定義のプロパティを次に示します。
項番 |
名前 |
型 |
内容 |
---|---|---|---|
1 |
ID |
数値 |
業務ステップ定義のID |
2 |
Name |
文字列 |
業務ステップ定義の名称 |
3 |
ProcessDefinitionID |
数値 |
業務ステップ定義が所属するビジネスプロセス定義のID |
4 |
Description |
文字列 |
業務ステップ定義の説明 |
レスポンスの構造を次に示します。
項番 |
名前 |
出現回数 |
||
---|---|---|---|---|
1 |
ActivityDefinitions |
1 |
||
2 |
ActivityDefinition |
0または1以上 |
||
3 |
ID |
1 |
||
4 |
Name |
1 |
||
5 |
ProcessDefinitionID |
1 |
||
6 |
Description |
1 |
ステータスコード
項番 |
ステータスコード |
内容 |
---|---|---|
1 |
200 |
成功(データが0件の場合も成功) |
2 |
400 |
リクエストパラメタの不正 |
3 |
500 |
内部処理エラー |
レスポンス例
レスポンス(XMLの場合)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ActivityDefinitions>
<ActivityDefinition>
<ID>1</ID>
<Name>USER_TASK1</Name>
<ProcessDefinitionID>1001</ProcessDefinitionID>
<Description></Description>
</ActivityDefinition>
<ActivityDefinition>
<ID>2</ID>
<Name>USER_TASK2</Name>
<ProcessDefinitionID>1001</ProcessDefinitionID>
<Description>ABCDEFG</Description>
</ActivityDefinition>
</ActivityDefinitions>
レスポンス(JSONの場合)
{
"ActivityDefinition" : [
{
"ID" : "1",
"Name" : "USER_TASK1",
"ProcessDefinitionID" : "1001",
"Description" : ""
},
{
"ID" : "2",
"Name" : "USER_TASK2",
"ProcessDefinitionID" : "1001",
"Description" : "ABCDEFG"
}
]
}