Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
Embedded API
リソース

テストAutomation ​

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

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

レート制限 ​

テスト自動化リソースには次のレート制限があります:

タイプリソース制限
すべてすべてのテスト自動化エンドポイント1分あたり60リクエスト

クイックリファレンス ​

タイプリソース説明
POST/api/managed_users/:managed_user_id/
test_cases/run_requests		顧客ワークスペースでテストケースを実行します。
GET/api/managed_users/:managed_user_id/recipes/
:recipe_id/test_cases		顧客ワークスペース内の特定のレシピのテストケースを取得します。
GET/api/managed_users/:managed_user_id/
test_cases/run_requests/:test_id		顧客ワークスペース内のテストケース実行リクエストの現在の状態を取得します。

テストケースの実行 ​

このエンドポイントを使用して、顧客ワークスペースでテストケースを実行します。

実行するテストケースは、次の方法で指定できます:

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

このエンドポイントは非同期です。

POST /api/managed_users/:managed_user_id/test_cases/run_requests

URLパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
外部IDはURLエンコードし、Eをプレフィックスとして付ける必要があります（例: EA2300）。

ペイロード ​

名前タイプ説明
manifest_id整数 任意指定したエクスポートマニフェスト内のすべてのレシピのテストケースを実行します。
project_id整数 任意指定したプロジェクト内のすべてのレシピのテストケースを実行します。 顧客ワークスペース内のすべてのプロジェクトのIDを取得するには、プロジェクトの一覧表示エンドポイントを使用します。
folder_id整数 任意指定したフォルダ内のすべてのレシピのテストケースを実行します。 顧客ワークスペース内のすべてのフォルダのIDを取得するには、フォルダの一覧表示エンドポイントを使用します。
recipe_id整数 任意指定したレシピのすべてのテストケースを実行します。 顧客ワークスペース内のすべてのレシピのIDを取得するには、レシピの一覧表示エンドポイントを使用します。
test_case_ids文字列の配列 任意特定のテストケースをIDで実行します。

サンプルリクエスト ​

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

サンプルレスポンス ​

json
{
    "data": {
        "id": "cirr-ALAGo123-Em8ewZ",
        "status": "running",
        "created_at": "2024-01-24T04:24:11.601-09:00",
        "updated_at": "2024-01-24T04:24:11.601-09:00",
        "user": {
            "id": 12345
        },
        "results": [
            {
                "job": {
                    "id": "j-ALAGo234-tXMPxZ"
                },
                "status": "pending",
                "recipe": {
                    "id": 987654,
                    "name": "Example Recipe"
                },
                "test_case": {
                    "id": "citc-ALAGd789-wcotNZ",
                    "name": "Example Test Case"
                }
            }
        ]
    }
}

テストケースの取得 ​

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

GET /api/managed_users/:managed_user_id/recipes/:recipe_id/test_cases

URLパラメータ ​

名前タイプ説明
managed_user_id文字列 必須Embedded顧客ワークスペースID/外部ID。
外部IDはURLエンコードし、Eをプレフィックスとして付ける必要があります（例: EA2300）。
recipe_id整数 必須テストケースを一覧表示するレシピのID。

サンプルレスポンス ​

shell
curl -X GET 'https://www.workato.com/api/managed_users/12345/recipes/67890/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": "Validate API connections and data mappings",
      "name": "API connection Test"
    }
  ]
}

テストケース実行リクエストの現在の状態の取得 ​

顧客ワークスペース内のテストケース実行リクエストの現在のステータスと詳細情報を取得します。 このエンドポイントは、テストの進行状況に関するInsightsを提供し、完了したテストについては、テストカバレッジやその他の関連結果に関するデータを含みます。

shell
GET /api/managed_users/:managed_user_id/test_cases/run_requests/:test_id

URLパラメータ ​

名前型説明
managed_user_id文字列 必須Embedded顧客ワークスペースID/外部ID。
test_id文字列 必須テスト実行リクエストのID。

サンプルリクエスト ​

shell
curl -X GET 'https://www.workato.com/api/managed_users/12345/test_cases/run_requests/cirr-AHNFkza6-dwMArc' \
     -H 'Authorization: Bearer <api_token>'

サンプルレスポンス ​

json
{
  "data": {
    "id": "cirr-AHNFkza6-dwMArc",
    "status": "completed",
    "created_at": "2024-01-24T04:24:11.601-09:00",
    "updated_at": "2024-01-24T04:24:12.602-09:00",
    "coverage": {
      "value": 87.5,
      "total_actions_count": 8,
      "total_visited_actions_count": 7,
      "recipes": [
        {
          "id": 67890,
          "name": "Employee Data Sync",
          "coverage": {
            "value": 87.5,
            "not_visited_actions": [
              {
                "step_number": 4,
                "description": "Check database trigger execution"
              }
            ]
          }
        }
      ]
    },
    "results": [
      {
        "recipe": {
          "id": 67890,
          "name": "Employee Data Sync"
        },
        "test_case": {
          "id": "citc-AG48N4xo-g6ccgP",
          "name": "Full Sync Test"
        },
        "job": {
          "id": "j-AHNFpnRa-sMWLYJ",
          "status": "succeeded"
        }
      }
    ]
  }
}

Last updated: