11.5.12 コールアクティビティの取得
案件を投入した作業を取得します。具体的には，指定した案件を投入したコールアクティビティを取得します。このAPIを実行すると，BPMN連携ライブラリ Java APIのCIWBPMNLib.getCallActivityParentWIインタフェースが呼び出されます。
メソッドとURL
GET /v1/process-instance/<案件ID>/call-activity-parent/work-item
<案件ID>：コールアクティビティが投入した案件ID（必須）
クエリパラメタ
|
項番 |
名前 |
型 |
指定要否 |
内容 |
|---|---|---|---|---|
|
1 |
userdescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。 |
リクエスト例
リクエストURL
GET http://restserver/csciwws/v1/process-instance/5004/call-activity-parent/work-item
レスポンス
コールアクティビティの作業を返します。レスポンスとして返される作業のプロパティを次に示します。
|
項番 |
名前 |
型 |
内容 |
|---|---|---|---|
|
1 |
ActivityInstanceID |
数値 |
作業が所属する業務ステップのID |
|
2 |
ClosedDate |
日付 |
作業の終了日時 |
|
3 |
CreationDate |
日付 |
作業の発生日時 |
|
4 |
Deadline |
日付 |
作業の処理期限の絶対日時 |
|
5 |
ID |
数値 |
作業のID |
|
6 |
Name |
文字列 |
作業の名称（作業キー） |
|
7 |
Participant |
文字列 |
作業の作業者ID |
|
8 |
Priority |
数値 |
作業の優先度 |
|
9 |
ProcessDefinitionID |
数値 |
作業が所属するビジネスプロセス定義のID |
|
10 |
ProcessInstanceID |
数値 |
作業が所属する案件のID |
|
11 |
ProcessInstanceName |
文字列 |
作業の案件名（案件キー） |
|
12 |
StartDate |
日付 |
作業の開始日時 |
|
13 |
StateCode |
文字列 |
作業の状態 |
|
14 |
WorkDefinitionID |
数値 |
作業定義のID |
|
15 |
WorkDefinitionName |
文字列 |
作業定義の名称 |
|
16 |
WorkTypeCode |
文字列 |
作業の種類 |
レスポンスの構造を次に示します。
|
項番 |
名前 |
出現回数 |
|
|---|---|---|---|
|
1 |
WorkItem |
1 |
|
|
2 |
ActivityInstanceID |
1 |
|
|
3 |
ClosedDate |
1 |
|
|
4 |
CreationDate |
1 |
|
|
5 |
Deadline |
1 |
|
|
6 |
ID |
1 |
|
|
7 |
Name |
1 |
|
|
8 |
Participant |
1 |
|
|
9 |
Priority |
1 |
|
|
10 |
ProcessDefinitionID |
1 |
|
|
11 |
ProcessInstanceID |
1 |
|
|
12 |
ProcessInstanceName |
1 |
|
|
13 |
StartDate |
1 |
|
|
14 |
StateCode |
1 |
|
|
15 |
WorkDefinitionID |
1 |
|
|
16 |
WorkDefinitionName |
1 |
|
|
17 |
WorkTypeCode |
1 |
|
ステータスコード
|
項番 |
ステータスコード |
内容 |
|---|---|---|
|
1 |
200 |
成功 |
|
2 |
400 |
リクエストパラメタの不正 |
|
3 |
404 |
データが見つからなかった |
|
4 |
500 |
内部処理エラー |
レスポンス例
レスポンス（XMLの場合）
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <WorkItem> <ActivityInstanceID>10005</ActivityInstanceID> <ClosedDate></ClosedDate> <CreationDate>2016-12-09T15:00:40+09:00</CreationDate> <Deadline></Deadline> <ID>10005</ID> <Name></Name> <Participant>IWCALL_GLOBALBP</Participant> <Priority></Priority> <ProcessDefinitionID>3001</ProcessDefinitionID> <ProcessInstanceID>5003</ProcessInstanceID> <ProcessInstanceName></ProcessInstanceName> <StartDate></StartDate> <StateCode>j</StateCode> <WorkDefinitionID>3003</WorkDefinitionID> <WorkDefinitionName>CheckCredit_callactivity1</WorkDefinitionName> <WorkTypeCode>0</WorkTypeCode> </WorkItem>
レスポンス（JSONの場合）
{
"ActivityInstanceID" : "10005",
"ClosedDate" : "",
"CreationDate" : "2016-12-09T15:00:40+09:00",
"Deadline" : "",
"ID" : "10005",
"Name" : "",
"Participant" : "IWCALL_GLOBALBP",
"Priority" : "",
"ProcessDefinitionID" : "3001",
"ProcessInstanceID" : "5003",
"ProcessInstanceName" : "",
"StartDate" : "",
"StateCode" : "j",
"WorkDefinitionID" : "3003",
"WorkDefinitionName" : "CheckCredit_callactivity1",
"WorkTypeCode" : "0"
}