Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
開発者用 API
リソース

テスト自動化 ​

以下のエンドポイントを使用すると、テスト自動化機能をプログラムで利用できます。

クイックリファレンス ​

タイプリソース説明
POST/api/test_cases/run_requestsテストケースを実行します。
GET/api/test_cases/run_requests/{id}テストケースの実行状態を取得します。
GET/api/recipes/{recipe_id}/test_casesテストケースを取得します。

テストケースを実行する ​

このエンドポイントを使用してテストケースを実行します。以下の方法で実行するテストケースを指定できます：

  • エクスポートマニフェスト内のすべてのレシピのすべてのテストケース
  • プロジェクト内のすべてのレシピのすべてのテストケース
  • フォルダ内のすべてのレシピのすべてのテストケース
  • 特定のレシピに属するすべてのテストケース
  • 指定したテストケース

このエンドポイントは非同期です。/api/test_cases/run_requests/{id}エンドポイントを使用して、リクエストの現在の状態をポーリングするために実行リクエストのidを使用できます。

POST /api/test_cases/run_requests

リクエストボディ ​

名前タイプ説明
manifest_idinteger オプション指定したエクスポートマニフェスト内のすべてのレシピのテストケースを実行します。
project_idinteger オプション指定したプロジェクト内のすべてのレシピのテストケースを実行します。ワークスペース内のすべてのプロジェクトのIDを取得するには、プロジェクトの一覧エンドポイントを使用します。
folder_idinteger オプション指定したフォルダ内のすべてのレシピのテストケースを実行します。
recipe_idinteger オプション指定したレシピのすべてのテストケースを実行します。
test_case_idsstring オプションIDで指定した特定のテストケースを実行します。

サンプルリクエスト ​

shell
curl  -X POST https://www.workato.com/api/test_cases/run_requests \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "manifest_id": "0"
          }'

サンプルレスポンス ​

json
{
  "data": {
    "id": "cirr-AHNFkza6-dwMArc",
    "status": "running",
    "user": {
      "id": 0
    },
    "created_at": "2023-06-01T01:40:00.000-07:00",
    "updated_at": "2023-06-01T01:40:00.000-07:00",
    "results": [
      {
        "recipe": {
          "id": 0,
          "name": "string"
        },
        "test_case": {
          "id": "citc-AG48N4xo-g6ccgP",
          "name": "string"
        },
        "job": {
          "id": "j-AHNFpnRa-sMWLYJ"
        },
        "status": "pending"
      }
    ]
  }
}

テストケースの実行状態を取得する ​

テストケースの実行状態を取得します。完了したリクエストの場合、Workatoは結果とともにテストカバレッジデータも返します。

GET /api/test_cases/run_requests/{id}

URLパラメータ ​

名前タイプ説明
idstring 必須実行リクエストのID。

サンプルリクエスト ​

shell
curl  -X GET https://www.workato.com/api/test_cases/run_requests/{id} \
      -H 'Authorization: Bearer <api_token>'

サンプルレスポンス ​

json
{
  "data": {
    "id": "cirr-AHNFkza6-dwMArc",
    "status": "completed",
    "user": {
      "id": 0
    },
    "created_at": "2023-06-01T01:40:00.000-07:00",
    "updated_at": "2023-06-01T01:40:00.000-07:00",
    "coverage": {
      "value": 87.5,
      "total_actions_count": 8,
      "total_visited_actions_count": 7,
      "recipes": [
        {
          "id": 0,
          "version_no": 0,
          "coverage": {
            "value": 87.5,
            "not_visited_actions": [
              {
                "step_number": 4
              }
            ]
          }
        }
      ]
    },
    "results": [
      {
        "recipe": {
          "id": 0,
          "name": "string"
        },
        "test_case": {
          "id": "citc-AG48N4xo-g6ccgP",
          "name": "string"
        },
        "job": {
          "id": "j-AHNFpnRa-sMWLYJ"
        },
        "status": "succeeded"
      }
    ]
  }
}

テストケースを取得する ​

指定したレシピに属するテストケースのコレクションを返します。

GET  /api/recipes/{recipe_id}/test_cases

URLパラメータ ​

名前タイプ説明
recipe_idinteger 必須テストケースの詳細を取得するレシピのID。

サンプルリクエスト ​

shell
curl  -X GET https://www.workato.com/api/recipes/{recipe_id}/test_cases \
      -H 'Authorization: Bearer <api_token>'

サンプルレスポンス ​

json
{
  "data": [
    {
      "id": "citc-AG48N4xo-g6ccgP",
      "created_at": "2023-06-01T01:40:00.000-07:00",
      "updated_at": "2023-06-01T01:40:00.000-07:00",
      "description": "string",
      "name": "string"
    }
  ]
}

Last updated: