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