11.5.15 業務ステップの取得
指定したIDの業務ステップを取得します。このAPIを実行すると,CSCIW Java APIのCIWServer.getActivityInstanceインタフェースが呼び出されます。
メソッドとURL
GET /v1/activity-instance/<案件ID>/<業務ステップID>
<案件ID>:取得する業務ステップの案件ID(必須)
<業務ステップID>:取得する業務ステップのID(必須)
クエリパラメタ
項番 |
名前 |
型 |
指定要否 |
内容 |
---|---|---|---|---|
1 |
userdescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。 |
リクエスト例
リクエストURL
GET http://restserver/csciwws/v1/activity-instance/5002/10002
レスポンス
業務ステップを返します。業務ステップのプロパティを次に示します。
項番 |
名前 |
型 |
内容 |
---|---|---|---|
1 |
ActivityDefinitionID |
数値 |
業務ステップ定義のID |
2 |
ActivityDefinitionName |
文字列 |
業務ステップ定義の名称 |
3 |
ActivityTypeCode |
文字列 |
業務ステップの種類 |
4 |
ClosedDate |
日付 |
業務ステップの終了日時 |
5 |
Deadline |
日付 |
業務ステップの処理期限の絶対日時 |
6 |
ID |
数値 |
業務ステップのID |
7 |
Name |
文字列 |
業務ステップの名称(業務ステップキー) |
8 |
Priority |
数値 |
業務ステップの優先度 |
9 |
ProcessDefinitionID |
数値 |
業務ステップが所属するビジネスプロセス定義のID |
10 |
ProcessInstanceID |
数値 |
業務ステップが所属する案件のID |
11 |
ProcessInstanceName |
文字列 |
業務ステップの案件名(案件キー) |
12 |
StartDate |
日付 |
業務ステップの開始日時 |
13 |
StateCode |
文字列 |
業務ステップの状態 |
レスポンスの構造を次に示します。
項番 |
名前 |
出現回数 |
|
---|---|---|---|
1 |
ActivityInstance |
1 |
|
2 |
ActivityDefinitionID |
1 |
|
3 |
ActivityDefinitionName |
1 |
|
4 |
ActivityTypeCode |
1 |
|
5 |
ClosedDate |
1 |
|
6 |
Deadline |
1 |
|
7 |
ID |
1 |
|
8 |
Name |
1 |
|
9 |
Priority |
1 |
|
10 |
ProcessDefinitionID |
1 |
|
11 |
ProcessInstanceID |
1 |
|
12 |
ProcessInstanceName |
1 |
|
13 |
StartDate |
1 |
|
14 |
StateCode |
1 |
ステータスコード
項番 |
ステータスコード |
内容 |
---|---|---|
1 |
200 |
成功 |
2 |
400 |
リクエストパラメタの不正 |
3 |
404 |
データが見つからなかった |
4 |
500 |
内部処理エラー |
レスポンス例
レスポンス(XMLの場合)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ActivityInstance> <ActivityDefinitionID>3001</ActivityDefinitionID> <ActivityDefinitionName>QuotationHandling_UTask1</ActivityDefinitionName> <ActivityTypeCode>0</ActivityTypeCode> <ClosedDate></ClosedDate> <Deadline></Deadline> <ID>10002</ID> <Name></Name> <Priority></Priority> <ProcessDefinitionID>3001</ProcessDefinitionID> <ProcessInstanceID>5002</ProcessInstanceID> <ProcessInstanceName>案件20160609103241625</ProcessInstanceName> <StartDate>2016-12-09T15:00:42+09:00</StartDate> <StateCode>d</StateCode> <ActivityInstance>
レスポンス(JSONの場合)
{ "ActivityDefinitionID" : "3001", "ActivityDefinitionName" : "QuotationHandling_UTask1", "ActivityTypeCode" : "0", "ClosedDate" : "", "Deadline" : "", "ID" : "10002", "Name" : "", "Priority" : "", "ProcessDefinitionID" : "3001", "ProcessInstanceID" : "5002", "ProcessInstanceName" : "案件20160609103241625", "StartDate" : "2016-12-09T15:00:42+09:00", "StateCode" : "d" }