QualityForward Logo
API docs by Redocly

QualityForward API (v2025021401)

Download OpenAPI specification:

QualityForward ヘルプページ

API仕様

API のエンドポイントは下記のドメインを利用します。

https://cloud.veriserve.co.jp/api/v2/

利用規約

本サービスでは、REST API がご利用いただけます。
API経由でのリクエストについて、1日約3000リクエスト、月間（30日間）で、 約10万リクエストまで、かつ、同一APIキーからは1秒あたり1リクエストの制限の中で ご利用をいただくよう、お願い申し上げます。

制限を超えるリクエストが確認された場合、APIのご利用を制限させていただく場合がございます。

リクエスト数はお客様開発のプログラムのつくりに大きく依存いたしますため、恐れながら、月間リクエスト数のお見積りはお客様ご自身にてお願いいたします。

※目安として1日1時間、1秒に1回のリクエストで3600リクエスト、平日22日間実行されたとすると、月間79200リクエストとなります。

APIキーの発行手順

(1) 対象のプロジェクトから「設定」を開きます。

project-settings

(2) 設定下部にあるAPIキー項目の「＋生成」ボタンを押します。

api-key-generate

発行されたキーがプロジェクトのAPIキーです。

リクエスト制限

高頻度なリクエスト送信が行われた際に、動作が不安定になる事象を回避するためAPIサーバへ送信できるリクエスト数が1秒間1リクエストに制限されております。
リクエスト数が上限を超えた場合、APIサーバは429 Too many requestsを返します。

レスポンスヘッダ

リクエスト数エラー時には以下のヘッダが含まれます。

ヘッダ名 ヘッダ内容
ratelimit-limit 1秒間に受付可能な最大リクエスト数
ratelimit-remaining retelimit-resetの時刻までに受付可能な残りリクエスト数
ratelimit-reset リクエスト数の計測がリセットされる時刻（UNIX時刻）

ページネーション

複数のデータを返す一部のAPIは、一度にすべてのデータを返却せず、ページネーションが適用されます。

{
  "total_pages": 2,
  "current_page": 1,
  "next_url": "http://www.example.com/api/v2/users?api_key=api_key_69&page=2",
  "users": [
    {
      "id": 87503,
      "current_tenant_id": 25883,
      "email": "user_171@example.com",
      "name": "user_171",
      "confirmed": true
    },
    {
      "id": 87503,
      "current_tenant_id": 25883,
      "email": "user_170@example.com",
      "name": "user_170",
      "confirmed": true
    }
  ]
}
項目 型 説明
total_pages integer ページの総数
current_page integer 現在のページ数
next_url string データの次ページを返すための値。エンドポイントにnext_urlを指定する。

プロジェクト

プロジェクト情報の取得

プロジェクトの情報を取得します。

query Parameters
api_key
required
string

プロジェクトのAPIキー

Responses

Request samples 

curl --get \
  --data "api_key=[生成したAPIキー]" \
  "https://cloud.veriserve.co.jp/api/v2/current_project"

Response samples

Content type
application/json
{
  • "id": 77570,
  • "tenant": {
    },
  • "name": "project_1",
  • "description": "description_1",
  • "label_pass": "pass",
  • "label_fail": "fail",
  • "label_skip": "skip",
  • "label_cut": "cut",
  • "label_block": "block",
  • "label_na": "na",
  • "label_qa": "qa",
  • "excluded_from_progress_pass": false,
  • "excluded_from_progress_fail": false,
  • "excluded_from_progress_skip": false,
  • "excluded_from_progress_cut": false,
  • "excluded_from_progress_block": false,
  • "excluded_from_progress_na": false,
  • "excluded_from_progress_qa": false,
  • "supplement_pass": null,
  • "supplement_fail": null,
  • "supplement_skip": null,
  • "supplement_cut": null,
  • "supplement_block": null,
  • "supplement_na": null,
  • "supplement_qa": null,
  • "default_label_category1": "項目1",
  • "default_label_category2": "項目2",
  • "default_label_category3": "項目3",
  • "default_label_category4": "項目4",
  • "default_label_category5": "項目5",
  • "default_label_category6": "項目6",
  • "default_label_category7": "項目7",
  • "default_label_category8": "項目8",
  • "default_label_category9": "項目9",
  • "default_label_category10": "項目10",
  • "default_label_category11": "項目11",
  • "default_label_category12": "項目12",
  • "default_label_category13": "項目13",
  • "default_label_category14": "項目14",
  • "default_label_category15": "項目15",
  • "default_label_category16": "項目16",
  • "default_label_category17": "項目17",
  • "default_label_category18": "項目18",
  • "default_label_category19": "項目19",
  • "default_label_category20": "項目20",
  • "default_label_category21": "項目21",
  • "default_label_category22": "項目22",
  • "default_label_category23": "項目23",
  • "default_label_category24": "項目24",
  • "default_label_category25": "項目25",
  • "default_label_content1": "環境",
  • "default_label_content2": "バグID",
  • "default_label_content3": "備考",
  • "default_label_content4": "content4",
  • "default_label_content5": "content5",
  • "default_label_content6": "content6",
  • "default_label_content7": "content7",
  • "default_label_content8": "content8",
  • "default_label_content9": "content9",
  • "default_label_content10": "content10",
  • "archived": false,
  • "created_at": "2020-02-27T14:27:38.415+09:00",
  • "updated_at": "2020-02-27T14:27:38.415+0"
}

ユーザ

ユーザ情報の取得

ユーザの情報を取得します。
ユーザ数が特定以下の場合は"next_url"がnullのJSONを取得します。

query Parameters
api_key
required
string

プロジェクトのAPIキー

Responses

Request samples 

curl --get \
  --data "api_key=[生成したAPIキー]" \
  "https://cloud.veriserve.co.jp/api/v2/users"

Response samples

Content type
application/json
{
  • "users": [
    ]
}

テストスイート

テストスイート情報の取得

テストスイートの情報を取得します。
テストスイートが存在しない場合は”next_url”がnullのJSONを取得します。

query Parameters
api_key
required
string

プロジェクトのAPIキー

Responses

Request samples 

curl --get \
  --data "api_key=[生成したAPIキー]" \
  "https://cloud.veriserve.co.jp/api/v2/test_suites"

Response samples

Content type
application/json
Example
{
  • "test_suites": [
    ]
}

テストスイートの作成

テストスイートを作成します。

テストスイートの名前（test_suite["name"]）がない場合、カバレッジパネルの集計に利用するテスト定義項目の番号（coverage_panel_column）またはテストブロッカーの集計に利用するテスト定義項目の番号（test_blocker_column）に不正な値が入力されている場合はエラーが返ります。

テスト定義項目ラベル（test_suite["label_category"]）、テスト結果ラベル（test_suite["label_content1"]）の上限はお申込内容に応じて異なります。

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "test_suite": {
    }
}

Response samples

Content type
application/json
{
  • "id": 87503,
  • "project_id": 25883,
  • "name": "test_suite_363",
  • "label_category1": "category1",
  • "use_category1": true,
  • "label_category2": "category2",
  • "use_category2": true,
  • "label_category3": "category3",
  • "use_category3": true,
  • "label_category4": "category4",
  • "use_category4": true,
  • "label_category5": "category5",
  • "use_category5": true,
  • "label_category6": "category6",
  • "use_category6": true,
  • "label_category7": "category7",
  • "use_category7": true,
  • "label_category8": "category8",
  • "use_category8": true,
  • "label_category9": "category9",
  • "use_category9": true,
  • "label_category10": "category10",
  • "use_category10": true,
  • "label_category11": "category11",
  • "use_category11": true,
  • "label_category12": "category12",
  • "use_category12": true,
  • "label_category13": "category13",
  • "use_category13": true,
  • "label_category14": "category14",
  • "use_category14": true,
  • "label_category15": "category15",
  • "use_category15": true,
  • "label_category16": "category16",
  • "use_category16": true,
  • "label_category17": "category17",
  • "use_category17": true,
  • "label_category18": "category18",
  • "use_category18": true,
  • "label_category19": "category19",
  • "use_category19": true,
  • "label_category20": "category20",
  • "use_category20": true,
  • "label_category21": "category21",
  • "use_category21": true,
  • "label_category22": "category22",
  • "use_category22": true,
  • "label_category23": "category23",
  • "use_category23": true,
  • "label_category24": "category24",
  • "use_category24": true,
  • "label_category25": "category25",
  • "use_category25": true,
  • "label_content1": "content1",
  • "use_content1": true,
  • "label_content2": "content2",
  • "use_content2": true,
  • "label_content3": "content3",
  • "use_content3": true,
  • "label_content4": "content4",
  • "use_content4": true,
  • "label_content5": "content5",
  • "use_content5": true,
  • "label_content6": "content6",
  • "use_content6": true,
  • "label_content7": "content7",
  • "use_content7": true,
  • "label_content8": "content8",
  • "use_content8": true,
  • "label_content9": "content9",
  • "use_content9": true,
  • "label_content10": "content10",
  • "use_content10": true,
  • "coverage_panel_column": null,
  • "archived": false,
  • "test_blocker_column": null,
  • "created_at": "2020-10-28T15:57:37.924+09:00",
  • "updated_at": "2020-10-28T15:57:37.924+09:00"
}

テストスイートの更新

テストスイートの情報を更新します。

テストスイート名（test_suite["name"]）を更新する場合、値が入力されないリクエストはエラーが返ります。

テスト定義項目ラベル（test_suite["label_category"]）、テスト結果ラベル（test_suite["label_content1"]）の上限はお申込内容に応じて異なります。

path Parameters
test_suite[id]
required
integer

テストスイートID

例）テストスイート設定画面のURLが以下の場合、test_suite[id]=2

https://cloud.veriserve.co.jp/projects/1/test_suites/2/edit

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "test_suite": {
    }
}

Response samples

Content type
application/json
{
  • "id": 87503,
  • "project_id": 25883,
  • "name": "test_suite_363",
  • "label_category1": "category1",
  • "use_category1": true,
  • "label_category2": "category2",
  • "use_category2": true,
  • "label_category3": "category3",
  • "use_category3": true,
  • "label_category4": "category4",
  • "use_category4": true,
  • "label_category5": "category5",
  • "use_category5": true,
  • "label_category6": "category6",
  • "use_category6": true,
  • "label_category7": "category7",
  • "use_category7": true,
  • "label_category8": "category8",
  • "use_category8": true,
  • "label_category9": "category9",
  • "use_category9": true,
  • "label_category10": "category10",
  • "use_category10": true,
  • "label_category11": "category11",
  • "use_category11": true,
  • "label_category12": "category12",
  • "use_category12": true,
  • "label_category13": "category13",
  • "use_category13": true,
  • "label_category14": "category14",
  • "use_category14": true,
  • "label_category15": "category15",
  • "use_category15": true,
  • "label_category16": "category16",
  • "use_category16": true,
  • "label_category17": "category17",
  • "use_category17": true,
  • "label_category18": "category18",
  • "use_category18": true,
  • "label_category19": "category19",
  • "use_category19": true,
  • "label_category20": "category20",
  • "use_category20": true,
  • "label_category21": "category21",
  • "use_category21": true,
  • "label_category22": "category22",
  • "use_category22": true,
  • "label_category23": "category23",
  • "use_category23": true,
  • "label_category24": "category24",
  • "use_category24": true,
  • "label_category25": "category25",
  • "use_category25": true,
  • "label_content1": "content1",
  • "use_content1": true,
  • "label_content2": "content2",
  • "use_content2": true,
  • "label_content3": "content3",
  • "use_content3": true,
  • "label_content4": "content4",
  • "use_content4": true,
  • "label_content5": "content5",
  • "use_content5": true,
  • "label_content6": "content6",
  • "use_content6": true,
  • "label_content7": "content7",
  • "use_content7": true,
  • "label_content8": "content8",
  • "use_content8": true,
  • "label_content9": "content9",
  • "use_content9": true,
  • "label_content10": "content10",
  • "use_content10": true,
  • "coverage_panel_column": null,
  • "archived": false,
  • "test_blocker_column": null,
  • "created_at": "2020-10-28T15:57:37.924+09:00",
  • "updated_at": "2020-10-28T15:57:37.924+09:00"
}

テストスイートの削除

テストスイートを削除します。
レスポンスボディは返りません。

path Parameters
test_suite[id]
required
integer

テストスイートID

例）テストスイート設定画面のURLが以下の場合、test_suite[id]=2

https://cloud.veriserve.co.jp/projects/1/test_suites/2/edit

query Parameters
api_key
required
string

プロジェクトのAPIキー

Responses

Request samples 

curl --request DELETE \
  "https://cloud.veriserve.co.jp/api/v2/test_suites/[対象のテストスイートid]?api_key=[生成したAPIキー]"

Response samples

Content type
application/json
null

テストスイートバージョン

テストスイートバージョン情報の取得

テストスイートバージョンの情報を取得します。
テストスイートが存在しない場合、"next_url"がnullのJSONを取得します。

path Parameters
test_suite[id]
required
integer

テストスイートID

例）テストスイート設定画面のURLが以下の場合、test_suite[id]=2

https://cloud.veriserve.co.jp/projects/1/test_suites/2/edit

query Parameters
api_key
required
string

プロジェクトのAPIキー

Responses

Request samples 

curl --get \
  --data "api_key=[生成したAPIキー]" \
  "https://cloud.veriserve.co.jp/api/v2/test_suites/[対象のテストスイートid]/test_suite_versions"

Response samples

Content type
application/json
Example
{
  • "test_suite_versions": [
    ]
}

テストスイートバージョンの作成

テストスイートバージョンを作成します。

テストスイートバージョン名（test_suite_version["name"]）の値がない場合、エラーが返ります。

テスト定義項目ラベル（test_suite_version["label_category1"]）、テスト結果ラベル（test_suite_version["label_content1"]）の上限はお申込内容に応じて異なります。

path Parameters
test_suite[id]
required
integer

テストスイートID

例）テストスイート設定画面のURLが以下の場合、test_suite[id]=2

https://cloud.veriserve.co.jp/projects/1/test_suites/2/edit

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "test_suite_version": {
    }
}

Response samples

Content type
application/json
{
  • "id": 90704,
  • "test_suite_id": 91208,
  • "name": "test_suite_version_413",
  • "status": "available",
  • "note": "note_413",
  • "latest_test_cycle_duration_sec": 0,
  • "lock": false,
  • "lock_memo": null,
  • "created_at": "2020-02-27T14:29:56.852+09:00",
  • "updated_at": "2020-02-27T14:29:56.852+09:00"
}

テストスイートバージョンの更新

テストスイートの情報を更新します。

テストスイートバージョン名（test_suite_version["name"]）を更新する場合、値が入力されていないリクエストはエラーが返ります。

テスト定義項目（test_suite_version["label_category1"]）、テスト結果ラベル（test_suite_version["label_content1"]）の上限はお申込内容に応じて異なります。

path Parameters
test_suite[id]
required
integer

テストスイートID

例）テストスイート設定画面のURLが以下の場合、test_suite[id]=2

https://cloud.veriserve.co.jp/projects/1/test_suites/2/edit

test_suite_version[id]
required
integer

テストスイートバージョンID

例）テストスイートバージョン設定のURLが以下の場合、test_suite_version[id]=3 https://cloud.veriserve.co.jp/projects/1/test_suites/2/test_suite_versions/3/edit

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "test_suite_version": {
    }
}

Response samples

Content type
application/json
{
  • "id": 90704,
  • "test_suite_id": 91208,
  • "name": "test_suite_version_516",
  • "status": "available",
  • "user": {
    },
  • "note": "note_516",
  • "latest_test_cycle_duration_sec": 0,
  • "lock": false,
  • "lock_memo": null,
  • "created_at": "2020-02-27T14:29:56.852+09:00",
  • "updated_at": "2020-02-27T14:29:56.852+09:00"
}

テストスイートバージョン削除

テストスイートバージョンを削除します。
レスポンスボディは返りません。
テストスイートバージョンが１つしか存在しない場合はエラーが返ります。

path Parameters
test_suite[id]
required
integer

テストスイートID

例）テストスイート設定画面のURLが以下の場合、test_suite[id]=2

https://cloud.veriserve.co.jp/projects/1/test_suites/2/edit

test_suite_version[id]
required
integer

テストスイートバージョンID

例）テストスイートバージョン設定のURLが以下の場合、test_suite_version[id]=3 https://cloud.veriserve.co.jp/projects/1/test_suites/2/test_suite_versions/3/edit

query Parameters
api_key
required
string

プロジェクトのAPIキー

Responses

Request samples 

curl --request DELETE \
  "https://cloud.veriserve.co.jp/api/v2/test_suites/[対象のテストスイートバージョン]/test_suite_versions/[対象のテストスイートバージョンid]?api_key=[生成したAPIキー]"

Response samples

Content type
application/json
null

テストケース

テストケース情報の取得

テストケースの情報を取得します。
テストケースの数が一定以下の場合は"next_url"がnullのJSONを取得します。

path Parameters
test_suite[id]
required
integer

テストスイートID

例）テストスイート設定画面のURLが以下の場合、test_suite[id]=2

https://cloud.veriserve.co.jp/projects/1/test_suites/2/edit

test_suite_version[id]
required
integer

テストスイートバージョンID

例）テストスイートバージョン設定のURLが以下の場合、test_suite_version[id]=3 https://cloud.veriserve.co.jp/projects/1/test_suites/2/test_suite_versions/3/edit

query Parameters
api_key
required
string

プロジェクトのAPIキー

Responses

Request samples 

curl --get \
  --data "api_key=[生成したAPIキー]" \
  "https://cloud.veriserve.co.jp/api/v2/test_suites/[対象のテストスイートid]/test_suite_versions/[対象のテストスイートバージョンid]/test_cases"

Response samples

Content type
application/json
Example
{
  • "test_cases": [
    ]
}

テストケースの作成

任意のテストスイート内にテストケースを作成します。

必須項目の値が不正な場合はエラーが返ります。
テスト定義項目（test_case["category"]）の数はお申込内容に応じて異なります(通常25、最大150まで)。

path Parameters
test_suite[id]
required
integer

テストスイートID

例）テストスイート設定画面のURLが以下の場合、test_suite[id]=2

https://cloud.veriserve.co.jp/projects/1/test_suites/2/edit

test_suite_version[id]
required
integer

テストスイートバージョンID

例）テストスイートバージョン設定のURLが以下の場合、test_suite_version[id]=3 https://cloud.veriserve.co.jp/projects/1/test_suites/2/test_suite_versions/3/edit

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "test_case": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1160373,
  • "test_suite_version_id": 90599,
  • "no": 304,
  • "priority": null,
  • "category1": null,
  • "category2": null,
  • "category3": null,
  • "category4": null,
  • "category5": null,
  • "category6": null,
  • "category7": null,
  • "category8": null,
  • "category9": null,
  • "category10": null,
  • "created_at": "2020-02-27T14:29:56.852+09:00",
  • "updated_at": "2020-02-27T14:29:56.852+09:00"
}

複数テストケースの作成

任意のテストスイート内にテストケースを複数作成します。

必須項目の値が不正な場合はエラーが返ります。
テスト定義項目（test_case["category"]）の数はお申込内容に応じて異なります(通常25、最大150まで)。

path Parameters
test_suite[id]
required
integer

テストスイートID

例）テストスイート設定画面のURLが以下の場合、test_suite[id]=2

https://cloud.veriserve.co.jp/projects/1/test_suites/2/edit

test_suite_version[id]
required
integer

テストスイートバージョンID

例）テストスイートバージョン設定のURLが以下の場合、test_suite_version[id]=3 https://cloud.veriserve.co.jp/projects/1/test_suites/2/test_suite_versions/3/edit

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "test_cases": [
    ]
}

Response samples

Content type
application/json
{
  • "test_cases": [
    ]
}

テストケースの更新

任意のテストスイート内のテストケースの情報を更新します。

必須項目の値が不正な場合はエラーが返ります。
テスト定義項目（test_case["category"]）の上限はお申込内容に応じて異なります(通常25、最大150まで)。

path Parameters
test_suite[id]
required
integer

テストスイートID

例）テストスイート設定画面のURLが以下の場合、test_suite[id]=2

https://cloud.veriserve.co.jp/projects/1/test_suites/2/edit

test_suite_version[id]
required
integer

テストスイートバージョンID

例）テストスイートバージョン設定のURLが以下の場合、test_suite_version[id]=3 https://cloud.veriserve.co.jp/projects/1/test_suites/2/test_suite_versions/3/edit

test_case[id]
required
string

テストケース固有ID
[Get]テストケース情報の取得で取得可能です。

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "test_case": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1160373,
  • "test_suite_version_id": 90599,
  • "no": 304,
  • "priority": "A",
  • "category1": null,
  • "category2": null,
  • "category3": null,
  • "category4": null,
  • "category5": null,
  • "category6": null,
  • "category7": null,
  • "category8": null,
  • "category9": null,
  • "category10": null,
  • "created_at": "2020-02-27T14:29:56.852+09:00",
  • "updated_at": "2020-02-27T14:29:56.852+09:00"
}

テストケースの削除

任意のテストスイート内のテストケースを削除します。
レスポンスボディは返りません。

path Parameters
test_suite[id]
required
integer

テストスイートID

例）テストスイート設定画面のURLが以下の場合、test_suite[id]=2

https://cloud.veriserve.co.jp/projects/1/test_suites/2/edit

test_suite_version[id]
required
integer

テストスイートバージョンID

例）テストスイートバージョン設定のURLが以下の場合、test_suite_version[id]=3 https://cloud.veriserve.co.jp/projects/1/test_suites/2/test_suite_versions/3/edit

test_case[id]
required
string

テストケース固有ID
[Get]テストケース情報の取得で取得可能です。

query Parameters
api_key
required
string

プロジェクトのAPIキー

Responses

Request samples 

curl --request DELETE \
  "https://cloud.veriserve.co.jp/api/v2/test_suites/[対象のテストスイートid]/test_suite_versions/[対象のテストスイートバージョンid]/test_cases/[対象のテストケースid]?api_key=[生成したAPIキー]"

Response samples

Content type
application/json
null

テストフェーズ

テストフェーズ情報の取得

テストフェーズの情報を取得します。
テストフェーズの数が一定以下の場合は”next_url”がnullのJSONを取得します。

query Parameters
api_key
required
string

プロジェクトのAPIキー

Responses

Request samples 

curl --get \
  --data "api_key=生成したAPIキー" \
  "https://cloud.veriserve.co.jp/api/v2/test_phases"

Response samples

Content type
application/json
Example
{
  • "test_phases": [
    ]
}

テストフェーズの作成

テストフェーズを作成します。
必須項目の値が不正な場合はエラーが返ります。

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "test_phase": {
    }
}

Response samples

Content type
application/json
{
  • "id": 54628,
  • "project_id": 77591,
  • "name": "test_phase_344",
  • "start_on": "2020-02-26",
  • "end_on": "2020-02-29",
  • "redmine_issues_url": null,
  • "test_suite_assignments": [
    ],
  • "archived": false,
  • "created_at": "2020-02-27T14:28:59.174+09:00",
  • "updated_at": "2020-02-27T14:28:59.174+09:00"
}

テストフェーズの更新

テストフェーズを更新します。

テストフェーズ名（test_phase["name"]）,フェーズ開始日（test_phase["start_on"]）,フェーズ終了日（test_phase["end_on"]）を更新する場合、値のないリクエストはエラーが返ります。

path Parameters
test_phase[id]
required
integer

テストフェーズID

例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_phase[id]=2

https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "test_phase": {
    }
}

Response samples

Content type
application/json
{
  • "id": 54628,
  • "project_id": 77591,
  • "name": "test_phase_344",
  • "start_on": "2020-02-26",
  • "end_on": "2020-02-29",
  • "redmine_issues_url": null,
  • "test_suite_assignments": [
    ],
  • "archived": false,
  • "created_at": "2020-02-27T14:28:59.174+09:00",
  • "updated_at": "2020-02-27T14:28:59.174+09:00"
}

テストフェーズの削除

任意のテストフェーズを削除します。
レスポンスボディは返りません。

path Parameters
test_phase[id]
required
integer

テストフェーズID

例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_phase[id]=2

https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/

query Parameters
api_key
required
string

プロジェクトのAPIキー

Responses

Request samples 

curl --request DELETE \
  "https://cloud.veriserve.co.jp/api/v2/test_phases/[対象のテストフェーズid]?api_key=[生成したAPIキー]"

Response samples

Content type
application/json
null

テストサイクル

テストサイクル情報の取得

テストサイクルの情報を取得します。
テストサイクルの数が一定以下の場合は”next_url”がnullのJSONを取得します。

path Parameters
test_phase[id]
required
integer

テストフェーズID

例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_phase[id]=2

https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/

test_suite_assignments[id]
required
integer

テストフェーズに紐づけられたテストスイートID
例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_suite_assignments[id]=3 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles

query Parameters
api_key
required
string

プロジェクトのAPIキー

Responses

Request samples 

curl --get \
  --data "api_key=[生成したAPIキー]" \
  "https://cloud.veriserve.co.jp/api/v2/test_phases/[対象のテストフェーズid]/test_suite_assignments/[対象のテストフェーズに紐づけられたテストスイートバージョンid]/test_cycles"

Response samples

Content type
application/json
Example
{
  • "test_cycles": [
    ]
}

テストサイクルの作成

テストサイクルを作成します。
必須項目の値が不正な場合はエラーが返ります。

path Parameters
test_phase[id]
required
integer

テストフェーズID

例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_phase[id]=2

https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/

test_suite_assignments[id]
required
integer

テストフェーズに紐づけられたテストスイートID
例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_suite_assignments[id]=3 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "test_cycle": {
    }
}

Response samples

Content type
application/json
{
  • "id": 4914,
  • "status": "unexecuted",
  • "name": "testtest",
  • "target_priorities": [
    ],
  • "target_results": [
    ],
  • "target_test_case_no_list": [
    ],
  • "test_suite_assignment_id": 3681,
  • "start_on": "2020-08-26",
  • "end_on": "2020-08-29",
  • "tester_id": null,
  • "created_at": "2020-08-27T14:27:36.376+09:00",
  • "updated_at": "2020-08-27T14:27:36.376+09:00"
}

テストサイクルのCSV出力

テストサイクルの情報をCSV形式で出力します。

path Parameters
test_phase[id]
required
integer

テストフェーズID

例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_phase[id]=2

https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/

test_suite_assignments[id]
required
integer

テストフェーズに紐づけられたテストスイートID
例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_suite_assignments[id]=3 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles

test_cycle[id]
required
integer

テストサイクルID

例）テストサイクル設定画面のURLが以下の場合、test_cycle[id]=4 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles/4

query Parameters
api_key
required
string

プロジェクトのAPIキー

Responses

Request samples 

curl --get 
  --data "api_key=[生成したAPIキー]" \
  "https://cloud.veriserve.co.jp/api/v2/test_phases/[対象のテストフェーズid]/test_suite_assignments/[対象のテストフェーズに紐づけられたテストスイートバージョンid]/test_cycles/[対象のテストサイクルid].csv"

Response samples

Content type
text/csv
識別ID,優先度,category1,category2,category3,category4,category5,category6,category7,category8,category9,category10,category11,category12,category13,category14,category15,category16,category17,category18,category19,category20,category21,category22,category23,category24,category25,テスト実施者,テスト実施日,テスト結果,content1,content2,content3,content4,content5,content6,content7,content8,content9,content10 1,A,1,,,,,,,,,,,,,,,,,,,,,,,,,user_5,2016/01/01,pass,,,,,,,,,,

テストサイクルの更新

テストサイクルの情報を更新します。

path Parameters
test_phase[id]
required
integer

テストフェーズID

例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_phase[id]=2

https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/

test_suite_assignments[id]
required
integer

テストフェーズに紐づけられたテストスイートID
例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_suite_assignments[id]=3 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles

test_cycle[id]
required
integer

テストサイクルID

例）テストサイクル設定画面のURLが以下の場合、test_cycle[id]=4 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles/4

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "test_cycle": {
    }
}

Response samples

Content type
application/json
{
  • "id": 4914,
  • "status": "unexecuted",
  • "name": "testtest",
  • "target_priorities": [
    ],
  • "target_results": [
    ],
  • "target_test_case_no_list": [
    ],
  • "test_suite_assignment_id": 3681,
  • "start_on": "2020-08-26",
  • "end_on": "2020-08-29",
  • "tester_id": null,
  • "created_at": "2020-08-27T14:27:36.376+09:00",
  • "updated_at": "2020-08-27T14:27:36.376+09:00"
}

テストサイクルの削除

任意のテストサイクルを削除します。
レスポンスボディは返りません。

path Parameters
test_phase[id]
required
integer

テストフェーズID

例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_phase[id]=2

https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/

test_suite_assignments[id]
required
integer

テストフェーズに紐づけられたテストスイートID
例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_suite_assignments[id]=3 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles

test_cycle[id]
required
integer

テストサイクルID

例）テストサイクル設定画面のURLが以下の場合、test_cycle[id]=4 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles/4

query Parameters
api_key
required
string

プロジェクトのAPIキー

Responses

Request samples 

curl --request DELETE \
  "https://cloud.veriserve.co.jp/api/v2/test_phases/[対象のテストフェーズid]/test_suite_assignments/[対象のテストフェーズに紐づけられたテストスイートバージョンid]/test_cycles/[対象のテストサイクルid]?api_key=[生成したAPIキー]"

Response samples

Content type
application/json
null

テスト結果

テスト結果の取得

テスト結果を取得します。
テスト結果が存在しない場合、"next_url"がnullのJSONを取得します。

path Parameters
test_phase[id]
required
integer

テストフェーズID

例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_phase[id]=2

https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/

test_suite_assignments[id]
required
integer

テストフェーズに紐づけられたテストスイートID
例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_suite_assignments[id]=3 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles

test_cycle[id]
required
integer

テストサイクルID

例）テストサイクル設定画面のURLが以下の場合、test_cycle[id]=4 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles/4

query Parameters
api_key
required
string

プロジェクトのAPIキー

Responses

Request samples 

curl --get\
  --data "api_key=[生成したAPIキー]" \
  "https://cloud.veriserve.co.jp/api/v2/test_phases/[対象のテストフェーズid]/test_suite_assignments/[対象のテストフェーズに紐づけられたテストスイートバージョンid]/test_cycles/[対象のテストサイクルid]/test_results"

Response samples

Content type
application/json
Example
{
  • "test_cycle": {
    },
  • "test_suite": {
    },
  • "test_results": [
    ]
}

テスト結果入力・上書き

任意のテストサイクルにテスト結果を入力します。
すでに結果がある項目に対しては上書きを行います。
必須項目の値が不正な場合はエラーが返ります。
テスト結果自由項目（test_result["content"]）の数は契約内容に応じて異なります。

path Parameters
test_phase[id]
required
integer

テストフェーズID

例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_phase[id]=2

https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/

test_suite_assignments[id]
required
integer

テストフェーズに紐づけられたテストスイートID
例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_suite_assignments[id]=3 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles

test_cycle[id]
required
integer

テストサイクルID

例）テストサイクル設定画面のURLが以下の場合、test_cycle[id]=4 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles/4

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "test_result": {
    }
}

Response samples

Content type
application/json
{
  • "id": 220205,
  • "user": {
    },
  • "test_case_id": 1161206,
  • "test_case_no": 102,
  • "test_cycle_id": 38987,
  • "result": "pass",
  • "result_supplemet": null,
  • "executed_at": "2023-05-15T11:37:33.265+09:00",
  • "content1": null,
  • "content2": null,
  • "content3": null,
  • "created_at": "2023-05-15T11:37:33.289+09:00",
  • "updated_at": "2023-05-15T11:37:33.289+09:00"
}

複数テスト結果入力・上書き

任意のテストサイクルにテスト結果を入力します。
すでに結果がある項目に対しては上書きを行います。
必須項目の値が不正な場合はエラーが返ります。
テスト結果自由項目（test_result["content"]）の数は契約内容に応じて異なります。

path Parameters
test_phase[id]
required
integer

テストフェーズID

例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_phase[id]=2

https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/

test_suite_assignments[id]
required
integer

テストフェーズに紐づけられたテストスイートID
例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_suite_assignments[id]=3 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles

test_cycle[id]
required
integer

テストサイクルID

例）テストサイクル設定画面のURLが以下の場合、test_cycle[id]=4 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles/4

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "test_results": [
    ]
}

Response samples

Content type
application/json
{
  • "test_results": [
    ]
}

テスト結果の更新

任意のテスト結果内容を更新します。
必須項目の更新は値が入力されていない場合、エラーが返ります。

path Parameters
test_phase[id]
required
integer

テストフェーズID

例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_phase[id]=2

https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/

test_suite_assignments[id]
required
integer

テストフェーズに紐づけられたテストスイートID
例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_suite_assignments[id]=3 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles

test_cycle[id]
required
integer

テストサイクルID

例）テストサイクル設定画面のURLが以下の場合、test_cycle[id]=4 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles/4

test_result[test_case_no]
required
integer

テストケースの識別ID

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "test_result": {
    }
}

Response samples

Content type
application/json
{
  • "id": 220205,
  • "user": {
    },
  • "test_case_id": 1161206,
  • "test_case_no": 102,
  • "test_cycle_id": 38987,
  • "result": "pass",
  • "result_supplemet": null,
  • "executed_at": "2023-05-15T11:37:33.265+09:00",
  • "content1": null,
  • "content2": null,
  • "content3": null,
  • "created_at": "2023-05-15T11:37:33.289+09:00",
  • "updated_at": "2023-05-15T11:37:33.289+09:00"
}

テスト結果の削除

任意のテストケースに入力されたテスト結果を削除します。
レスポンスボディは返りません。

path Parameters
test_phase[id]
required
integer

テストフェーズID

例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_phase[id]=2

https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/

test_suite_assignments[id]
required
integer

テストフェーズに紐づけられたテストスイートID
例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_suite_assignments[id]=3 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles

test_cycle[id]
required
integer

テストサイクルID

例）テストサイクル設定画面のURLが以下の場合、test_cycle[id]=4 https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/3/test_cycles/4

test_result[test_case_no]
required
integer

テストケースの識別ID

query Parameters
api_key
required
string

プロジェクトのAPIキー

Responses

Request samples 

curl --request DELETE \
  --header "Content-Type: application/json" \
  "https://cloud.veriserve.co.jp/api/v2/test_phases/[対象のテストフェーズid]/test_suite_assignments/[対象のテストフェーズに紐づけられたテストスイートバージョンid]/test_cycles/[対象のテストサイクルid]/test_results/[対象のテストケースNo]?api_key=[生成したAPIキー]"

Response samples

Content type
application/json
null

自動テスト結果

自動テスト結果入力

自動テストの安定性を分析するために、複数の自動テストケースの実行結果をまとめて入力します。
必須項目の値が不正な場合や、auto_test_resultsが空の場合、また、auto_test_results内で一意であるべきauto_test_case_external_keyの重複がある際はエラーが返ります。

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
auto_test_suite_external_key
required
string

自動テストツール・システム側にて、複数のテストケースがまとめられたテスト実行単位に付与しているIDや名前

auto_test_suite_name
string

自動テストスイート名
未設定の場合、自動テスト安定性レポート-自動テストスイートにはauto_test_suite_external_keyの値が表示

auto_test_cycle_name
required
string

レポート表示時に、当該テスト実行回に付与する名前
定期実行の場合は、タイムスタンプなどの指定を推奨

auto_execution_device_external_key
string

自動テスト実施環境のID

auto_execution_device_name
string

自動テスト実施環境名
auto_execution_device_external_keyとauto_execution_device_nameの設定によって、自動テスト安定性レポート-環境の表示名を制御します。

auto_execution_device_external_key auto_execution_device_name 自動テスト安定性レポート-環境
設定済み 設定済み auto_execution_device_nameの設定値
未設定 未設定 標準環境
設定済み 未設定 auto_execution_device_external_keyの設定値
未設定 設定済み 標準環境
Array of objects

Responses

Request samples

Content type
application/json
{
  • "auto_test_suite_external_key": "string",
  • "auto_test_suite_name": "string",
  • "auto_test_cycle_name": "string",
  • "auto_execution_device_external_key": "string",
  • "auto_execution_device_name": "string",
  • "auto_test_results": [
    ]
}

Response samples

Content type
application/json
null

バグカウント

バグカウントの登録

任意のテストフェーズごとチャートにバグカウントを登録します。
任意のテストスイート内にテストケースを作成します。
必須項目の値が不正な場合はエラーが返ります。

path Parameters
test_phase[id]
required
integer

テストフェーズID

例）テストフェーズの対象テストスイート一覧画面のURLが以下の場合、test_phase[id]=2

https://cloud.veriserve.co.jp/projects/1/test_phases/2/test_suite_assignments/

query Parameters
api_key
required
string

プロジェクトのAPIキー

Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "bug_count_snapshots": [
    ]
}

Response samples

Content type
application/json
{
  • "target_date": "2023-05-13",
  • "open_count": 6,
  • "close_count": 2
}