バージョン: DAI 25.2

API V2 Endpoints

Eggplant Public API

Version 2.0

パステーブル

メソッド	パス	説明
POST	/auth	クライアントIDとシークレットからアクセストークンを取得する
GET	/test_results	テスト結果の一覧表示
GET	/test_results/{test_result_id}	単一のテストの結果を取得する
GET	/test_results/{test_result_id}/logs	単一のテストのログを取得する
GET	/test_results/{test_result_id}/screenshots	テストに利用可能なスクリーンショットを一覧表示する
GET	/screenshots/{screenshot_id}	テスト結果のスクリーンショットをダウンロードする
GET	/test_results	テスト構成結果を取得する
GET	/test_config_results/{test_config_result_id}	テスト構成結果を取得する
GET	/test_config_results/{test_config_result_id}	テスト構成実行の結果をjunit形式で取得する

参照表

名前	タイプ	説明
AuthRequestBody	スキーマ
AuthResponseBody	スキーマ
HTTPValidationError	スキーマ
Problem	スキーマ
RunType	スキーマ	特定のテスト結果に対して可能な実行タイプ。
Screenshot	スキーマ	特定のテスト結果の利用可能なスクリーンショットの情報。
スクリーンショットのページ区切りリスト	スキーマ	利用可能な単一のテスト結果のスクリーンショットのページ分けされたリスト。
Severity	スキーマ	単一のテスト結果ログエントリの重大度レベル。
SortBy	スキーマ	テスト結果のリストを並べ替えるために使用できる並べ替えオプション。
SortDirection	スキーマ	ソート中に適用される可能性のある方向。
[Stage {#schemasstage)	スキーマ
Status	スキーマ	特定のテスト結果の可能なステータス。
[TestConfigResult {#schemastestconfigresult)	スキーマ
[テスト構成結果ソート {#schemastestconfigresultsortby)	スキーマ
[TestConfigResultsPaginatedList {#schemastestconfigresultspaginatedlist)	スキーマ
[TestConfigStatus {#schemastestconfigstatus)	スキーマ	特定のテスト結果の可能なステータス。
TestResult	スキーマ	単一の探索、再生、またはテストケース実行に関するすべての情報が含まれるテスト結果。
TestResultLogEntriesPaginatedList	スキーマ	単一のテスト結果のログエントリのページ分けされたリスト。
TestResultLogEntry	スキーマ	特定のテスト結果からの単一のログエントリ。
テスト結果ページ区切りリスト	スキーマ	テスト結果のページ分けされたリスト。
ValidationError	スキーマ

パスの詳細

[POST] /auth

まとめ:
クライアントIDとシークレットからアクセストークンを取得する

RequestBody

application/json

{
  client_id: string
  client_secret: string
}

レスポンス

200 OK

application/json

{
  access_token: string
  expires_in: integer
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

422 検証エラー

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

[GET] /test_results

まとめ:
テスト結果の一覧表示

説明:
適用されたフィルターに一致するテスト結果のページ区切りリストを取得します。

パラメータ (クエリ)

//
// 適用されたフィルターに一致するものの、返されるリストから除外される、先頭のテスト結果の数。
//
offset: integer

// 返されるテスト結果の最大数。
// 注: 制限の最大値は、システム環境変数の LIMIT_MAX_VALUE を設定することで変更できます。LIMIT_MAX_VALUE の許容範囲は 1000 から 2147483647 までです。
limit: integer // デフォルト: 1000

// 
// 返されるテスト結果項目の順序を決定するために使用されるキー。
// 
sort_by: SortBy

// 
// ソート時にテスト結果項目に適用される順序方向。
// 
sort_direction: SortDirection

//
// 特定の機能ファイルでテスト結果をフィルタリングします。
// デフォルト値: null
//
feature_file: string

//
// 特定のシナリオ名で Gherkin テスト結果をフィルタリングします。
// デフォルト値: null
//

// 特定の実行タイプでテスト結果をフィルタリングします。
run_type: RunType

// 
// 特定のテスト結果ステータスでテスト結果をフィルタリングします。
// 
status: Status

//
// 指定された時間以降に開始されたテスト結果をフィルタリングします。
// デフォルト値: null
//
start_time: string

//
// 指定された時間より前に終了したテスト結果をフィルタリングします。
// デフォルト値: null
//
end_time: string

//
// テスト結果をフィルタリングし、指定された model_id に一致するモデルを使用したテスト結果を取得します。
// デフォルト値: null
//
model_id: string

//
// テスト結果をフィルタリングし、指定された suite_id に一致するスイートを使用するスクリプト化されたテスト結果を取得します。
// デフォルト値: null
//
suite_id: string

//
// 指定された test_case_id のすべてのテスト結果を取得します。
// デフォルト値: null
//
test_case_id: string

//
// このexecution_environment_idを使用して実行されたすべてのテスト結果を取得します。
// デフォルト値: null
//
execution_environment_id: integer

//
// この sut_id に一致する sut を使用して実行されたすべてのテスト結果を取得します。
// デフォルト値: null
//
sut_id: string

//
// 指定された task_instance_id に一致するテスト構成実行に含まれるすべてのテスト結果を取得します。
// デフォルト値: null
//
test_config_result_id: string

//
// 指定された test_config_id のすべてのテスト結果を取得します。
// デフォルト値: null
//
test_config_id: string

ヘッダー

// POST /auth エンドポイントから返される access_token。
authorization: string

Responses

200 OK

application/json

// テスト結果のページネーション付きリスト。
{
  // 制限やオフセットが適用される前に、リクエストに一致するアイテムの総数。
  total_count: integer
  // このリクエストが行われた日時。
  date_as_of: string
  // 単一の探索実行、リプレイ、またはテストケース実行に関するすべての情報を含むテスト結果。
  items: {
    // テスト結果の ID。
    id: integer
    // 特定のテスト結果における可能なステータス。
    status: enum[RUNNING, PASSED, FAILED, ERROR, CANCELLED]
    // 特定のテスト結果における可能な実行タイプ。
    run_type: enum[SCRIPTED_TEST_CASE, MODEL_TEST_CASE, EXPLORATORY, REPLAY, GHERKIN]
    // このテスト結果がテスト構成で設定された再実行試行の一部であるかどうか。
    is_rerun: boolean
    // テスト実行の開始時刻。
    start_time: string
    // テスト実行の完了時刻。実行中の場合は null。
    end_time: Partial(string) & Partial(null)
    // テスト実行に使用されたモデル名。スクリプト化されたテストケース結果の場合は null。
    model_name: Partial(string) & Partial(null)
    // テスト実行に使用されたモデルの ID。スクリプト化されたテストケース結果の場合は null。
    model_id: Partial(string) & Partial(null)
    // テスト実行に使用されたスイート名。
    suite_name: Partial(string) & Partial(null)
    // テスト実行に使用されたスイートの ID。
    suite_id: Partial(string) & Partial(null)
    // 実行中のテストケース名。探索実行またはリプレイ実行の場合は null。
    test_case_name: Partial(string) & Partial(null)
    // 実行されたテストケースの ID。探索実行またはリプレイ実行の場合は null。
    test_case_id: Partial(string) & Partial(null)
    // テスト実行に使用された設計または実行エージェントの名前。
    execution_environment_name: Partial(string) & Partial(null)
    // テスト実行に使用された設計または実行エージェントの ID。
    execution_environment_id: Partial(integer) & Partial(null)
    // テスト実行に使用された SUT（System Under Test）の名前。
    sut_name: Partial(string) & Partial(null)
    // テスト実行に使用された SUT の ID。
    sut_id: Partial(string) & Partial(null)
    // このテスト結果が属するテスト構成結果の ID。ライブ実行の場合は null。
    test_config_result_id: Partial(string) & Partial(null)
    // このテスト結果が表すテスト構成ステップ。0 から始まるインデックスであり、ライブ実行結果の場合は null。
    test_config_step: Partial(integer) & Partial(null)
    // このシナリオテスト結果が属するフィーチャーファイル（gherkin テスト結果の場合のみ）。
    feature_file: Partial(string) & Partial(null)
  }[]
}

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

422 検証エラー

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

[GET] /test_results/{test_result_id}

まとめ:
単一のテストの結果を取得する

説明:
指定された test_result_id のテスト結果を取得します。

ヘッダー

// POST /auth エンドポイントから返される access_token。
authorization:string

レスポンス

200 テスト結果が正常に取得されました

application/json

// 単一の探索実行、リプレイ、またはテストケース実行に関するすべての情報を含むテスト結果。
{
  // テスト結果の ID。
  id: integer
  // 特定のテスト結果における可能なステータス。
  status: enum[RUNNING, PASSED, FAILED, ERROR, CANCELLED]
  // 特定のテスト結果における可能な実行タイプ。
  run_type: enum[SCRIPTED_TEST_CASE, MODEL_TEST_CASE, EXPLORATORY, REPLAY, GHERKIN]
  // このテスト結果がテスト構成で設定された再実行試行の一部であるかどうか。
  is_rerun: boolean
  // テスト実行の開始時刻。
  start_time: string
  // テスト実行の完了時刻。実行中の場合は null。
  end_time: Partial(string) & Partial(null)
  // テスト実行に使用されたモデル名。スクリプト化されたテストケース結果の場合は null。
  model_name: Partial(string) & Partial(null)
  // テスト実行に使用されたモデルの ID。スクリプト化されたテストケース結果の場合は null。
  model_id: Partial(string) & Partial(null)
  // テスト実行に使用されたスイート名。
  suite_name: Partial(string) & Partial(null)
  // テスト実行に使用されたスイートの ID。
  suite_id: Partial(string) & Partial(null)
  // 実行中のテストケース名。探索実行またはリプレイ実行の場合は null。
  test_case_name: Partial(string) & Partial(null)
  // 実行されたテストケースの ID。探索実行またはリプレイ実行の場合は null。
  test_case_id: Partial(string) & Partial(null)
  // テスト実行に使用された設計または実行エージェントの名前。
  execution_environment_name: Partial(string) & Partial(null)
  // テスト実行に使用された設計または実行エージェントの ID。
  execution_environment_id: Partial(integer) & Partial(null)
  // テスト実行に使用された SUT（System Under Test）の名前。
  sut_name: Partial(string) & Partial(null)
  // テスト実行に使用された SUT の ID。
  sut_id: Partial(string) & Partial(null)
  // このテスト結果が属するテスト構成結果の ID。ライブ実行の場合は null。
  test_config_result_id: Partial(string) & Partial(null)
  // このテスト結果が表すテスト構成ステップ。0 から始まるインデックスであり、ライブ実行結果の場合は null。
  test_config_step: Partial(integer) & Partial(null)
  // このシナリオテスト結果が属するフィーチャーファイル（gherkin テスト結果の場合のみ）。
  feature_file: Partial(string) & Partial(null)
}

400 不正なリクエスト

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

403 アクセスが拒否されました

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

404 テスト結果が見つかりません

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

422 検証エラー

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

[GET] /test_results/{test_result_id}/logs

まとめ:
単一のテストのログを取得する

説明:
単一のテスト結果のログのページ分割されたリストを取得します。

パラメータ (クエリ)

// 返されるリストから除外される、先頭のテスト結果ログエントリの数。
offset: integer

// 返されるテスト結果ログエントリの最大数。
// 注: 制限の最大値は、システム環境変数の LIMIT_MAX_VALUE を設定することで変更できます。LIMIT_MAX_VALUE の許容範囲は 1000 から 2147483647 までです。
limit: integer // デフォルト: 1000

ヘッダー

// POST /auth エンドポイントから返される access_token。
authorization: string

レスポンス

200 テスト結果ログが正常に取得されました。

application/json

// 単一のテスト結果に対応するログエントリのページネーション付きリスト。
{
  // 制限やオフセットが適用される前に、リクエストに一致するアイテムの総数。
  total_count: integer
  // このリクエストが行われた日時。
  date_as_of: string
  // 特定のテスト結果における単一のログエントリ。
  items: {
    // このログエントリが属するテスト結果の ID。
    test_result_id: integer
    // このログエントリが作成されたタイムスタンプ。
    timestamp: string
    // このテスト結果ログエントリで伝えられるメッセージ。
    message: string
    // 単一のテスト結果ログエントリの重大度レベル。
    severity: enum[CRITICAL, ERROR, WARNING, INFO, DEBUG]
    // EPF または DAI から出力されたログメッセージのステージ。
    stage: Stage
    // メッセージの種類。
    message_type: string
    // 画像の名前。
    image_name: string
    // 画像の ID。
    image_id: Partial(string) & Partial(null)
  }[]
}

400 不正なリクエスト

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

403 アクセスが拒否されました

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

404 テスト結果が見つかりません

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

422 検証エラー

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

[GET] /test_results/{test_result_id}/screenshots

まとめ:
テストに利用可能なスクリーンショットを一覧表示する

説明:
指定された test_result_id で指定されたテストで使用可能なスクリーンショットのページ区切りリストを取得します。

パラメータ (クエリ)

// 返されるリストから除外される、最初に利用可能なスクリーンショットの数。
offset: integer

// 返されるスクリーンショットの最大数。
// 注: 制限の最大値は、システム環境変数の LIMIT_MAX_VALUE を設定することで変更できます。LIMIT_MAX_VALUE の許容範囲は 1000 から 2147483647 までです。
limit: integer // デフォルト: 1000

ヘッダー

// POST /auth エンドポイントから返される access_token。
authorization: 文字列

レスポンス

利用可能なスクリーンショット 200 枚が正常に取得されました

application/json

// 単一のテスト結果で利用可能なスクリーンショットのページネーション付きリスト。
{
  // 制限やオフセットが適用される前に、リクエストに一致するアイテムの総数。
  total_count: integer
  // このリクエストが行われた日時。
  date_as_of: string
  // 特定のテスト結果における利用可能なスクリーンショットの情報。
  items: {
    // このスクリーンショットのアーティファクト ID。
    id: string
    // このスクリーンショットが作成されたタイムスタンプ。
    timestamp: string
    // このスクリーンショットの画像フォーマット。
    content_type: string
  }[]
}

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

403 アクセスが拒否されました

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

404 テスト結果が見つかりません

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

422 検証エラー

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

[GET] /screenshots/{screenshot_id}

まとめ:
テスト結果のスクリーンショットをダウンロードする

説明:
指定された screenshot_id のスクリーンショットをダウンロードします。

ヘッダー

// POST /auth エンドポイントから返される access_token。
authorization: string

レスポンス

200 対象のスクリーンショット（バイト単位）。

image/png image/tiff image/jpeg

400 不正なリクエスト

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

404 テスト結果が見つかりません

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

422 検証エラー

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

[GET] /test_config_results

まとめ:
テスト構成結果を取得する

説明:
適用されたフィルターに一致するテスト構成結果のページ区切りリストを取得します。

パラメータ (クエリ)

// 適用されたフィルターに一致するが、返されるリストから除外される、先頭のテスト構成結果の数。
offset: integer

// 返されるテスト結果の最大数。
// 注: 制限の最大値は、システム環境変数の LIMIT_MAX_VALUE を設定することで変更できます。LIMIT_MAX_VALUE の許容範囲は 1000 から 2147483647 までです。
limit: integer // デフォルト: 1000

//
// 返されるテスト構成結果項目の順序を決定するために使用されるキー。
//
sort_by: TestConfigResultSortBy

//
// ソート時にテスト構成結果項目に適用される順序方向。
//
sort_direction: SortDirection

// 
// 特定のステータスでテスト構成の結果をフィルタリングします。
// 
status: TestConfigStatus

//
// テスト構成の結果をフィルタリングし、指定された時間以降に開始されたものを取得します。
// デフォルト値: null
//
start_time: string

//
// テスト構成の結果をフィルタリングし、指定された時間より前に開始されたものを取得します。
// デフォルト値: null
//
end_time: string

// テスト構成の結果をフィルタリングし、指定された test_config_id に一致するテスト構成を使用した結果を取得します。
// デフォルト値: null
test_config_id: string

ヘッダー

// POST /auth エンドポイントから返される access_token。
authorization:string

レスポンス

200 OK

application/json

{
  // 制限やオフセットを適用する前に、リクエストに一致したアイテムの総数。
  total_count: integer
  // このリクエストが行われた日時。
  date_as_of: string
  items: {
    // テスト構成結果のID。
    id: string
    // テスト構成実行のステータス。
    status: TestConfigStatus
    // テスト構成実行の開始時刻。
    start_time: string
    // テスト構成実行の終了時刻。実行中の場合は null。
    end_time: Partial(string) & Partial(null)
    // テスト構成の名称。
    test_config_name: string
    // テスト構成のID。
    test_config_id: string
  }[]
}

400 不正なリクエスト

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

422 検証エラー

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

[GET] /test_config_results/{test_config_result_id}

まとめ:
テスト構成結果を取得する

説明:
指定された test_config_result_id のテスト構成結果を取得します。

ヘッダー

// POST /auth エンドポイントから返される access_token。
authorization: string

レスポンス

200 テスト構成結果が正常に取得されました

application/json

{
  // テスト構成結果の ID。
  id: string
  // テスト構成実行のステータス。
  status: TestConfigStatus
  // テスト構成実行の開始時刻。
  start_time: string
  // テスト構成実行の完了時刻。実行中の場合は null。
  end_time: Partial(string) & Partial(null)
  // テスト構成の名前。
  test_config_name: string
  // テスト構成の ID。
  test_config_id: string
}

400 不正なリクエスト

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

403 アクセスが拒否されました

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

404 テスト結果が見つかりません

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

422 検証エラー

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

[GET] /test_config_results/{test_config_result_id}/junit

まとめ:
テスト構成実行の結果をjunit形式で取得する

説明:
指定されたtest_config_result_idに対して、JUnit XML形式でレポートを生成します。

ヘッダー

// POST /auth エンドポイントから返される access_token。
authorization: 文字列

レスポンス

200 テスト構成結果レポートが正常に生成されました

application/json

{}

application/xml

400 不正なリクエスト

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

403 アクセスが拒否されました

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

404 テスト結果が見つかりません

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

422 検証エラー

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

参考文献

AuthRequestBody

{
  client_id: string
  client_secret: string
}

AuthResponseBody](#schemasauthresponsebody}

{
  access_token: string
  expires_in: integer
}

HTTPValidationError

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

問題

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

RunType

{
  "type": "string",
  "enum": [
    "SCRIPTED_TEST_CASE",
    "MODEL_TEST_CASE",
    "EXPLORATORY",
    "REPLAY",
    "GHERKIN"
  ],
  "title": "RunType",
  "description": "The possible run types for a particular test result."
}

Screenshot

// 特定のテスト結果における利用可能なスクリーンショットの情報。
{
  // このスクリーンショットのアーティファクトID。
  id: string
  // このスクリーンショットが作成されたタイムスタンプ。
  timestamp: string
  // このスクリーンショットの画像フォーマット。
  content_type: string
}

スクリーンショットページ区切りリスト

// 単一のテスト結果における利用可能なスクリーンショットのページネーション付きリスト。
{
  // 制限やオフセットを適用する前に、リクエストに一致したアイテムの総数。
  total_count: integer
  // このリクエストが行われた日時。
  date_as_of: string
  // 特定のテスト結果における利用可能なスクリーンショットの情報。
  items: {
    // このスクリーンショットのアーティファクトID。
    id: string
    // このスクリーンショットが作成されたタイムスタンプ。
    timestamp: string
    // このスクリーンショットの画像フォーマット。
    content_type: string
  }[]
}

Severity

{
  "type": "string",
  "enum": [
    "CRITICAL",
    "ERROR",
    "WARNING",
    "INFO",
    "DEBUG"
  ],
  "title": "Severity",
  "description": "The severity levels of a single test result log entry."
}

SortBy

{
  "type": "string",
  "enum": [
    "id",
    "model_or_suite_name",
    "start_time",
    "test_case_name",
    "test_config_name",
    "execution_environment_name",
    "sut_name"
  ],
  "title": "SortBy",
  "description": "The possible sorting options available for sorting a list of test results."
}

SortDirection

{
  "type": "string",
  "enum": [
    "asc",
    "desc"
  ],
  "title": "SortDirection",
  "description": "The possible direction applied during sorting."
}

Stage

{
  "type": "string",
  "enum": [
    "INITIALISING",
    "ENGINE",
    "SNIPPET"
  ],
  "title": "Stage"
}

Status

{
  "type": "string",
  "enum": [
    "RUNNING",
    "PASSED",
    "FAILED",
    "ERROR",
    "CANCELLED"
  ],
  "title": "Status",
  "description": "The possible statuses for a particular test result."
}

TestConfigResult

{
  // テスト構成結果のID。
  id: string
  // テスト構成実行のステータス。
  status: TestConfigStatus
  // テスト構成実行の開始時刻。
  start_time: string
  // テスト構成実行の終了時刻。実行中の場合は null。
  end_time: Partial(string) & Partial(null)
  // テスト構成の名称。
  test_config_name: string
  // テスト構成のID。
  test_config_id: string
}

テスト構成結果ソート

{
  "type": "string",
  "enum": [
    "start_time",
    "test_config_name"
  ],
  "title": "TestConfigResultSortBy"
}

TestConfigResultsPaginatedList

// テスト構成結果のページネーション付きリスト。
{
  // 制限やオフセットを適用する前に、リクエストに一致したアイテムの総数。
  total_count: integer
  // このリクエストが行われた日時。
  date_as_of: string
  items: {
    // テスト構成結果のID。
    id: string
    // テスト構成実行のステータス。
    status: TestConfigStatus
    // テスト構成実行の開始時刻。
    start_time: string
    // テスト構成実行の終了時刻。実行中の場合は null。
    end_time: Partial(string) & Partial(null)
    // テスト構成の名称。
    test_config_name: string
    // テスト構成のID。
    test_config_id: string
  }[]
}

TestConfigStatus

{
  "type": "string",
  "enum": [
    "PENDING",
    "RUNNING",
    "PASSED",
    "PASSED_AFTER_RERUN",
    "FAILED",
    "ERROR",
    "CANCELLING",
    "CANCELLED"
  ],
  "title": "TestConfigStatus",
  "description": "The possible statuses for a particular test config result."
}

TestResult

// 単一の探索テスト、リプレイテスト、またはテストケース実行に関するすべての情報を含むテスト結果。
{
  // テスト結果のID。
  id: integer
  // このテスト結果の可能なステータス。
  status: enum[RUNNING, PASSED, FAILED, ERROR, CANCELLED]
  // テスト実行の種類。
  run_type: enum[SCRIPTED_TEST_CASE, MODEL_TEST_CASE, EXPLORATORY, REPLAY, GHERKIN]
  // このテスト結果が、テスト設定内で再実行（rerun）された試行の一部かどうか。
  is_rerun: boolean
  // テスト実行の開始時刻。
  start_time: string
  // テスト実行の終了時刻。実行中の場合は null。
  end_time: Partial(string) & Partial(null)
  // 実行時に使用されたモデル名。スクリプト化テストケースの場合は null。
  model_name: Partial(string) & Partial(null)
  // 実行時に使用されたモデルID。スクリプト化テストケースの場合は null。
  model_id: Partial(string) & Partial(null)
  // テスト実行に使用されたスイート名。
  suite_name: Partial(string) & Partial(null)
  // テスト実行に使用されたスイートID。
  suite_id: Partial(string) & Partial(null)
  // 実行中のテストケース名。探索またはリプレイテストの場合は null。
  test_case_name: Partial(string) & Partial(null)
  // 実行されたテストケースのID。探索またはリプレイテストの場合は null。
  test_case_id: Partial(string) & Partial(null)
  // テスト実行に使用された設計エージェントまたは実行エージェントの名前。
  execution_environment_name: Partial(string) & Partial(null)
  // テスト実行に使用された設計エージェントまたは実行エージェントのID。
  execution_environment_id: Partial(integer) & Partial(null)
  // テスト実行に使用されたSUT（被試験システム）の名称。
  sut_name: Partial(string) & Partial(null)
  // テスト実行に使用されたSUTのID。
  sut_id: Partial(string) & Partial(null)
  // このテスト結果が属するテスト設定結果のID。ライブ実行の場合は null。
  test_config_result_id: Partial(string) & Partial(null)
  // このテスト結果が表すテスト設定ステップ（0始まり）。ライブ実行結果の場合は null。
  test_config_step: Partial(integer) & Partial(null)
  // （Gherkin テスト結果の場合）このシナリオテスト結果が含まれるフィーチャファイル。
  feature_file: Partial(string) & Partial(null)
}

テスト結果ログエントリページ区切りリスト

// 単一のテスト結果に対するログエントリのページネーション付きリスト。
{
  // 制限やオフセットを適用する前に、リクエストに一致したアイテムの総数。
  total_count: integer
  // このリクエストが行われた日時。
  date_as_of: string
  // 特定のテスト結果からの単一ログエントリ。
  items: {
    // このログエントリが属するテスト結果のID。
    test_result_id: integer
    // このログエントリが作成されたタイムスタンプ。
    timestamp: string
    // このテスト結果ログエントリに含まれるメッセージ。
    message: string
    // 単一のテスト結果ログエントリの重大度レベル。
    severity: enum[CRITICAL, ERROR, WARNING, INFO, DEBUG]
    // EPFまたはDAIのいずれかからのログメッセージのステージ。
    stage: Stage
    // メッセージの種類。
    message_type: string
    // 画像の名前。
    image_name: string
    // 画像のID。
    image_id: Partial(string) & Partial(null)
  }[]
}

TestResultLogEntry

// 特定のテスト結果に属する単一のログエントリ。
{
  // このログエントリが属するテスト結果のID。
  test_result_id: integer
  // このログエントリが作成されたタイムスタンプ。
  timestamp: string
  // このテスト結果ログエントリに含まれるメッセージ。
  message: string
  // 単一のテスト結果ログエントリの重大度レベル。
  severity: enum[CRITICAL, ERROR, WARNING, INFO, DEBUG]
  // EPFまたはDAIのいずれかに由来するログメッセージのステージ。
  stage: Stage
  // メッセージの種類。
  message_type: string
  // 画像の名前。
  image_name: string
  // 画像のID。
  image_id: Partial(string) & Partial(null)
}

TestResultsPaginatedList

// テスト結果のページネーション付きリスト。
{
  // 制限やオフセットを適用する前に、リクエストに一致したアイテムの総数。
  total_count: integer
  // このリクエストが行われた日時。
  date_as_of: string
  // 単一の探索テスト、リプレイテスト、またはテストケース実行に関するすべての情報を含むテスト結果。
  items: {
    // テスト結果のID。
    id: integer
    // このテスト結果の可能なステータス。
    status: enum[RUNNING, PASSED, FAILED, ERROR, CANCELLED]
    // テスト実行の種類。
    run_type: enum[SCRIPTED_TEST_CASE, MODEL_TEST_CASE, EXPLORATORY, REPLAY, GHERKIN]
    // このテスト結果がテスト設定内で再実行（rerun）された試行の一部かどうか。
    is_rerun: boolean
    // テスト実行の開始時刻。
    start_time: string
    // テスト実行の終了時刻。実行中の場合は null。
    end_time: Partial(string) & Partial(null)
    // 実行時に使用されたモデル名。スクリプト化テストケースの場合は null。
    model_name: Partial(string) & Partial(null)
    // 実行時に使用されたモデルID。スクリプト化テストケースの場合は null。
    model_id: Partial(string) & Partial(null)
    // テスト実行に使用されたスイート名。
    suite_name: Partial(string) & Partial(null)
    // テスト実行に使用されたスイートID。
    suite_id: Partial(string) & Partial(null)
    // 実行中のテストケース名。探索またはリプレイテストの場合は null。
    test_case_name: Partial(string) & Partial(null)
    // 実行されたテストケースのID。探索またはリプレイテストの場合は null。
    test_case_id: Partial(string) & Partial(null)
    // テスト実行に使用された設計エージェントまたは実行エージェントの名前。
    execution_environment_name: Partial(string) & Partial(null)
    // テスト実行に使用された設計エージェントまたは実行エージェントのID。
    execution_environment_id: Partial(integer) & Partial(null)
    // テスト実行に使用されたSUT（被試験システム）の名前。
    sut_name: Partial(string) & Partial(null)
    // テスト実行に使用されたSUTのID。
    sut_id: Partial(string) & Partial(null)
    // このテスト結果が属するテスト設定結果のID。ライブ実行の場合は null。
    test_config_result_id: Partial(string) & Partial(null)
    // このテスト結果が表すテスト設定ステップ（0始まり）。ライブ実行結果の場合は null。
    test_config_step: Partial(integer) & Partial(null)
    // （Gherkin テスト結果の場合）このシナリオテスト結果が含まれるフィーチャファイル。
    feature_file: Partial(string) & Partial(null)
  }[]
}

ValidationError

{
  loc: Partial(string) & Partial(integer)[]
  msg: string
  type: string
}

Eggplant Public API​

パステーブル​

参照表​

パスの詳細​

[POST] /auth​

RequestBody​

レスポンス​

200 OK​

401 Unauthorized​

422 検証エラー​

[GET] /test_results​

パラメータ (クエリ)​

ヘッダー​

Responses​

200 OK​

400 Bad request​

401 Unauthorized​

422 検証エラー​

[GET] /test_results/{test_result_id}​

ヘッダー​

レスポンス​

200 テスト結果が正常に取得されました​

400 不正なリクエスト​

401 Unauthorized​

403 アクセスが拒否されました​

404 テスト結果が見つかりません​

422 検証エラー​

[GET] /test_results/{test_result_id}/logs​

パラメータ (クエリ)​

ヘッダー​

レスポンス​

200 テスト結果ログが正常に取得されました。​

400 不正なリクエスト​

401 Unauthorized​

403 アクセスが拒否されました​

404 テスト結果が見つかりません​

422 検証エラー​

[GET] /test_results/{test_result_id}/screenshots​

パラメータ (クエリ)​

ヘッダー​

レスポンス​

利用可能なスクリーンショット 200 枚が正常に取得されました​

400 Bad request​

401 Unauthorized​

403 アクセスが拒否されました​

404 テスト結果が見つかりません​

422 検証エラー​

[GET] /screenshots/{screenshot_id}​

ヘッダー​

レスポンス​

200 対象のスクリーンショット（バイト単位）。​

400 不正なリクエスト​

401 Unauthorized​

404 テスト結果が見つかりません​

422 検証エラー​

[GET] /test_config_results​

パラメータ (クエリ)​

ヘッダー​

レスポンス​

200 OK​

400 不正なリクエスト​

401 Unauthorized​

422 検証エラー​

[GET] /test_config_results/{test_config_result_id}​

ヘッダー​

レスポンス​

200 テスト構成結果が正常に取得されました​

400 不正なリクエスト​

401 Unauthorized​

403 アクセスが拒否されました​

404 テスト結果が見つかりません​

422 検証エラー​

[GET] /test_config_results/{test_config_result_id}/junit​

ヘッダー​

レスポンス​

200 テスト構成結果レポートが正常に生成されました​

400 不正なリクエスト​

401 Unauthorized​

403 アクセスが拒否されました​

404 テスト結果が見つかりません​

Eggplant Public API

パステーブル

参照表

パスの詳細

[POST] /auth

RequestBody

レスポンス

200 OK

401 Unauthorized

422 検証エラー

[GET] /test_results

パラメータ (クエリ)

ヘッダー

Responses

200 OK

400 Bad request

401 Unauthorized

422 検証エラー

[GET] /test_results/{test_result_id}

ヘッダー

レスポンス

200 テスト結果が正常に取得されました

400 不正なリクエスト

401 Unauthorized

403 アクセスが拒否されました

404 テスト結果が見つかりません

422 検証エラー

[GET] /test_results/{test_result_id}/logs

パラメータ (クエリ)

ヘッダー

レスポンス

200 テスト結果ログが正常に取得されました。

400 不正なリクエスト

401 Unauthorized

403 アクセスが拒否されました

404 テスト結果が見つかりません

422 検証エラー

[GET] /test_results/{test_result_id}/screenshots

パラメータ (クエリ)

ヘッダー

レスポンス

利用可能なスクリーンショット 200 枚が正常に取得されました

400 Bad request

401 Unauthorized

403 アクセスが拒否されました

404 テスト結果が見つかりません

422 検証エラー

[GET] /screenshots/{screenshot_id}

ヘッダー

レスポンス

200 対象のスクリーンショット（バイト単位）。

400 不正なリクエスト

401 Unauthorized

404 テスト結果が見つかりません

422 検証エラー

[GET] /test_config_results

パラメータ (クエリ)

ヘッダー

レスポンス

200 OK

400 不正なリクエスト

401 Unauthorized

422 検証エラー

[GET] /test_config_results/{test_config_result_id}

ヘッダー

レスポンス

200 テスト構成結果が正常に取得されました

400 不正なリクエスト

401 Unauthorized

403 アクセスが拒否されました

404 テスト結果が見つかりません

422 検証エラー

[GET] /test_config_results/{test_config_result_id}/junit

ヘッダー

レスポンス

200 テスト構成結果レポートが正常に生成されました

400 不正なリクエスト

401 Unauthorized

403 アクセスが拒否されました

404 テスト結果が見つかりません