11.5.31　子案件の取得

子案件を取得します。具体的には，指定したコールアクティビティが投入した案件を取得します。このAPIを実行すると，BPMN連携ライブラリ Java APIのCIWBPMNLib.getCallActivityChildPIインタフェースが呼び出されます。

メソッドとURL

GET /v1/work-item/<案件ID>/<作業ID>/call-activity-child/process-instance

<案件ID>：コールアクティビティの案件のID（必須）

<作業ID>：コールアクティビティの作業のID（必須）

クエリパラメタ

項番	名前	型	指定要否	内容
1	userdescription	文字列	省略可	ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。

リクエスト例

リクエストURL

GET http://restserver/csciwws/v1/work-item/5005/32001/call-activity-child/process-instance

レスポンス

子案件を返します。子案件のプロパティを次に示します。

項番	名前	型	内容
1	ClosedDate	日付	子案件の終了日時
2	Creator	文字列	子案件の投入者
3	Deadline	日付	子案件の処理期限の絶対日時
4	ID	数値	子案件のID
5	MovedDate	日付	子案件の乗せ替え日時
6	Name	文字列	子案件の名称（案件キー）
7	Priority	数値	子案件の優先度
8	ProcessDefinitionID	数値	子案件が所属するビジネスプロセス定義のID
9	ProcessDefinitionName	文字列	子案件が所属するビジネスプロセス定義の名称
10	StartDate	日付	子案件の開始日時
11	StateCode	文字列	子案件の状態

レスポンスの構造を次に示します。

項番	名前		出現回数
1	ProcessInstance		1
2		ClosedDate	1
3		Creator	1
4		Deadline	1
5		ID	1
6		MovedDate	1
7		Name	1
8		Priority	1
9		ProcessDefinitionID	1
10		ProcessDefinitionName	1
11		StartDate	1
12		StateCode	1

ステータスコード

項番	ステータスコード	内容
1	200	成功
2	400	リクエストパラメタの不正
3	404	データが見つからなかった
4	500	内部処理エラー

レスポンス例

レスポンス（XMLの場合）

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ProcessInstance>
  <ClosedDate></ClosedDate>
  <Creator>csciwws</Creator>
  <Deadline></Deadline>
  <ID>105</ID>
  <MovedDate></MovedDate>
  <Name></Name>
  <Priority>0</Priority>
  <ProcessDefinitionID>3001</ProcessDefinitionID>
  <ProcessDefinitionName>販売業務</ProcessDefinitionName>
  <StartDate>2016-12-06T15:31:34+09:00</StartDate>
  <StateCode>d</StateCode>
</ProcessInstance>

レスポンス（JSONの場合）

{
  "ClosedDate" : "",
  "Creator" : "csciwws",
  "Deadline" : "",
  "ID" : "105",
  "MovedDate" : "",
  "Name" : "",
  "Priority" : "0",
  "ProcessDefinitionID" : "3001",
  "ProcessDefinitionName" : "販売業務",
  "StartDate" : "2016-12-06T15:31:34+09:00",
  "StateCode" : "d"
}

ページの先頭へ

11.5.31 子案件の取得

11.5.31　子案件の取得