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