11.5.38 作業定義の取得
指定したIDの作業定義を取得します。このAPIを実行すると，CSCIW Java APIのCIWServer.getWorkDefinitionインタフェースが呼び出されます。
メソッドとURL
GET /v1/work-definition/<ビジネスプロセス定義のID>/<作業定義のID>
<ビジネスプロセス定義のID>：取得する作業定義のビジネスプロセス定義のID（必須）
<作業定義のID>：取得する作業定義のID（必須）
クエリパラメタ
|
項番 |
名前 |
型 |
指定要否 |
内容 |
|---|---|---|---|---|
|
1 |
userdescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。 |
リクエスト例
リクエストURL
GET http://restserver/csciwws/v1/work-definition/1/5
レスポンス
作業定義を返します。作業定義のプロパティを次に示します。
|
項番 |
名前 |
型 |
内容 |
|---|---|---|---|
|
1 |
ActivityDefinitionID |
数値 |
作業定義が所属する業務ステップ定義のID |
|
2 |
CastingRuleName |
文字列 |
作業定義の振り分けルール名 |
|
3 |
Description |
文字列 |
作業の説明 |
|
4 |
ID |
数値 |
作業定義のID |
|
5 |
Name |
文字列 |
作業定義の名称 |
|
6 |
ProcessDefinitionID |
数値 |
作業定義が所属するビジネスプロセス定義のID |
|
7 |
WorkTypeCode |
文字列 |
作業の種類 |
レスポンスの構造を次に示します。
|
項番 |
名前 |
出現回数 |
|
|---|---|---|---|
|
1 |
WorkDefinition |
1 |
|
|
2 |
ActivityDefinitionID |
1 |
|
|
3 |
CastingRuleName |
1 |
|
|
4 |
Description |
1 |
|
|
5 |
ID |
1 |
|
|
6 |
Name |
1 |
|
|
7 |
ProcessDefinitionID |
1 |
|
|
8 |
WorkTypeCode |
1 |
|
ステータスコード
|
項番 |
ステータスコード |
内容 |
|---|---|---|
|
1 |
200 |
成功 |
|
2 |
400 |
リクエストパラメタの不正 |
|
3 |
404 |
データが見つからなかった |
|
4 |
500 |
内部処理エラー |
レスポンス例
レスポンス（XMLの場合）
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <WorkDefinition> <ActivityDefinitionID>3</ActivityDefinitionID> <CastingRuleName></CastingRuleName> <Description>USER_TASK</Description> <ID>5</ID> <Name>QuotationHandling_UTask1</Name> <ProcessDefinitionID>1</ProcessDefinitionID> <WorkTypeCode>0</WorkTypeCode> </WorkDefinition>
レスポンス（JSONの場合）
{
"ActivityDefinitionID" : "3",
"CastingRuleName" : "",
"Description" : "USER_TASK",
"ID" : "5",
"Name" : "QuotationHandling_UTask1",
"ProcessDefinitionID" : "1",
"WorkTypeCode" : "0"
}