11.5.29 作業の返却
作業者を割り当てて着手した作業の状態を，「作業者実行」状態から「実行開始可能」状態に変更し，作業者をレーン名に戻します。このAPIを実行すると，BPMN連携ライブラリ Java APIのCIWBPMNLib.freeWIインタフェースが呼び出されます。作業が返却済みだった場合，リクエストは成功します（何もしないでステータスコード200が返されます）。詳細については，「5.3 Java API利用時の注意事項」の「べき等性について」の説明を参照してください。
メソッドとURL
PUT /v1/work-item/<案件ID>/<作業ID>/free
<案件ID>：返却する作業の案件ID（必須）
<作業ID>：返却する作業のID（必須）
リクエストボディ
|
項番 |
名前 |
型 |
指定要否 |
内容 |
|---|---|---|---|---|
|
1 |
UserDescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。 |
リクエストボディの構造を次に示します。UserDescriptionを省略する場合は，リクエストボディを省略できます。リクエストボディを省略するときは，HTTPヘッダのContent-Typeを指定しないでください。
|
項番 |
名前 |
出現回数 |
|
|---|---|---|---|
|
1 |
Parameter |
1 |
|
|
2 |
UserDescription |
0または1 |
|
リクエスト例
リクエストURL
PUT http://restserver/csciwws/v1/work-item/5004/10005/free
レスポンス
返却した作業を返します。作業のプロパティを次に示します。
|
項番 |
名前 |
型 |
内容 |
|---|---|---|---|
|
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:54:55+09:00</CreationDate> <Deadline></Deadline> <ID>10005</ID> <Name></Name> <Participant>MyLane1</Participant> <Priority>0</Priority> <ProcessDefinitionID>3001</ProcessDefinitionID> <ProcessInstanceID>5004</ProcessInstanceID> <ProcessInstanceName>案件20160609103256259</ProcessInstanceName> <StartDate>2016-12-09T15:58:52+09:00</StartDate> <StateCode>j</StateCode> <WorkDefinitionID>3001</WorkDefinitionID> <WorkDefinitionName>QuotationHandling_UTask1</WorkDefinitionName> <WorkTypeCode>0</WorkTypeCode> </WorkItem>
レスポンス（JSONの場合）
{
"ActivityInstanceID" : "10005",
"ClosedDate" : "",
"CreationDate" : "2016-12-09T15:54:55+09:00",
"Deadline" : "",
"ID" : "10005",
"Name" : "",
"Participant" : " MyLane1",
"Priority" : "0",
"ProcessDefinitionID" : "3001",
"ProcessInstanceID" : "5004",
"ProcessInstanceName" : "案件20160609103256259",
"StartDate" : "2016-12-09T15:58:52+09:00",
"StateCode" : "j",
"WorkDefinitionID" : "3001",
"WorkDefinitionName" : "QuotationHandling_UTask1",
"WorkTypeCode" : "0"
}