11.5.37 作業定義数の取得
指定した条件を満たす作業定義の数を取得します。このAPIを実行すると,CSCIW Java APIのCIWServer.getListCountインタフェースが呼び出されます。
メソッドとURL
GET /v1/work-definition/count
クエリパラメタ
項番 |
名前 |
型 |
指定要否 |
内容 |
---|---|---|---|---|
1 |
userdescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。 |
2 |
filter |
文字列 |
省略可 |
作業定義数を取得する場合のフィルター条件を指定します。省略した場合はフィルター条件は指定されません。空文字列は指定できません。 |
リクエスト例
リクエストURL
GET http://restserver/csciwws/v1/work-definition/count
レスポンス
作業定義数を返します。レスポンスとして返されるプロパティを次に示します。
項番 |
名前 |
型 |
内容 |
---|---|---|---|
1 |
Count |
数値 |
作業定義の数 |
レスポンスの構造を次に示します。
項番 |
名前 |
出現回数 |
||
---|---|---|---|---|
1 |
Resources |
1 |
||
2 |
Count |
1 |
ステータスコード
項番 |
ステータスコード |
内容 |
---|---|---|
1 |
200 |
成功(データが0件の場合も成功) |
2 |
400 |
リクエストパラメタの不正 |
3 |
500 |
内部処理エラー |
レスポンス例
レスポンス(XMLの場合)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Resources> <Count>15</Count> </Resources>
レスポンス(JSONの場合)
{ "Count" : "15" }