--- sourceDocument: オーストラリア API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference Release : - australia ft:locale : - ja-JP ft:publication_title : - オーストラリア API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # クラウドランナーテストランナー REST API # クラウドランナーテストランナー REST API {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：12分 自動テストフレームワーク (ATF) のクラウドランナーで実行されるテストを管理します。 クラウドランナーテストランナー API には、[ATF Test Generator and Cloud Runner](https://www.servicenow.com/docs/access?context=atf-tg-cr-intro&version=australia&pubname=australia-servicenow-platform&ft:locale=en-US) (sn_atf_tg) プラグインが必要です。この API で使用できるメソッドは Now 名前空間で実行され、REST API エクスプローラーで API 名、 ATF のワンクリック回帰テストを使用して呼び出すことができます。この API にアクセスするには、admin ロールが必要です。 この API は、次のタスクに使用できます。 * クラウドランナーブラウザーで ATF テストまたはテストスイートを開始します。 * テストジョブの進行状況を確認します。 * テストジョブをキャンセルします。 {#cloudrunner-testrunner-api__cloudrnr-TestRunnerAPI-scoped_ul_vwb_wvn_31c} クラウドランナーテストランナー API は、[クラウドランナーテスト生成 REST API](https://servicenow-prod.fluidtopics.net/wdDlIEXmrC8QOFUBuUbiGA#cloudrunner-testgeneration-api "自動テストフレームワーク (ATF) のクラウドランナーで実行されるテストジョブの生成を管理します。")および [クラウドランナーテストユーザー REST API](https://servicenow-prod.fluidtopics.net/_6KGrBFJxTb8ImJjmt2X9Q#cloudrunner-testuser-api "自動テストフレームワーク (ATF) のクラウドランナーで実行されるテストユーザージョブを管理します。") と連携して使用できます。たとえば、テスト (Cloud Runner Test Generation API) を生成し、ブラウザーオーケストレーションキュー (Cloud Runner TEST Generation API) でテストの進行状況を取得し、合格または不合格になったテストの数を確認できます。 この API のサーバー API リファレンスドキュメントを表示するには、「 [クラウドランナー TestRunnerApi:スコープ指定、グローバル](https://servicenow-prod.fluidtopics.net/6p5zqJDphRgmZqrtnMw88A#cloudrnr-TestRunnerAPI-scoped "自動テストフレームワーク (ATF) のクラウドランナーで実行されるテストを管理します。 この API は CloudRunnerApi スクリプトインクルードの一部です。")」を参照してください。 ## クラウドランナーテストランナー:GET /now/sn_atf_tg/test_runner_progress {#ariaid-title2} 指定されたブラウザオーケストレーションキュー (BOQ) レコードに対して実行された各テストのステータスを提供します。 ### URL 形式 デフォルト URL:GET /api/now/sn_atf_tg/test_runner_progress ### サポートされている要求パラメーター {#cr-TestRunnerAPI-GET-test-run-progress__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 1. パスパラメーター] {#cr-TestRunnerAPI-GET-test-run-progress__entry__6} | 名前 | 説明 | |-|-| | snboqId | 必須です。進行状況を取得するテストランナージョブの BOQ レコードsys_id。 データタイプ：文字列 テーブル:BOQ \[sn_atf_tg_sn_boq\] | [表 : 2. クエリパラメーター] {#cr-TestRunnerAPI-GET-test-run-progress__entry__10} | 名前 | 説明 | |-|-| | なし | | [表 : 3. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cr-TestRunnerAPI-GET-test-run-progress__entry__14}{#cr-TestRunnerAPI-GET-test-run-progress__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 4. 要求ヘッダー] {#cr-TestRunnerAPI-GET-test-run-progress__entry__18} | ヘッダー | 説明 | |-|-| | なし | | [表 : 5. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cr-TestRunnerAPI-GET-test-run-progress__table_vdy_gwz_31c__entry__2} | ステータスコード | 説明 | |-|-| | 200 | BOQ ジョブの進行状況が正常に取得されました。 | | 400 | BOQ レコードステータスの取得中にエラーが発生しました。次のいずれかのメッセージを返します。 * BOQ ID が渡されませんでした:BOQ ID が指定されていません。BOQ ID を要求本文に追加します。 * BOQ レコードが見つかりません:無効な Sys ID。BOQ レコードのsys_idが有効であり、レコードが存在することを確認します。 {#cr-TestRunnerAPI-GET-test-run-progress__ul_d5p_btk_p1c} | | 403 | エンドポイントへのユーザーアクセスの許可中にエラーが発生しました。ユーザーに admin ロールがあることを確認します。 | [表 : 6. ステータスコード] {#cr-TestRunnerAPI-GET-test-run-progress__table_vdy_gwz_31c} ### 応答本文のパラメーター (JSON または XML) {#cr-TestRunnerAPI-GET-test-run-progress__entry__30} | 名前 | 説明 | |-|-| | result | テストランナージョブの進行状況の結果、または要求が失敗した理由を説明するメッセージを含むオブジェクト。 データタイプ: オブジェクト "result": { "progress": 100, "state": "completed" } または： { "result": { "message": "String" } } | | result.message | テストランナーの進捗状況を取得できない理由を詳述したエラーメッセージ。message パラメーターは、正常な応答では返されません。 データタイプ：文字列 | | result.progress | 実行中ステータスでのテストの完了までどの程度近づいているかを示すパーセンテージ。 データタイプ：数値 | | result.state | BOQ レコードの現在のステータス。 可能な値： * ブラウザーが要求されました:テスト生成またはテスト実行のためにブラウザーを起動するための要求がクラウドインフラストラクチャに送信されました。 * 完了:テストタスクが完了しました。 * 失敗ステータス:テストタスクが失敗しました。 * 処理待ち:要求されたテストアクティビティが作成され、実行を待機しています。 * 処理中:インスタンスはレコードをスキャンして、要求がクラウドインフラストラクチャに送信される前に、実行トラッカーがクラウドランナー用にマークされていることを確認します。 * 実行中:クラウドインフラストラクチャブラウザーは、保留中のテストを検索して実行します。 {#cr-TestRunnerAPI-GET-test-run-progress__ul_hph_y5h_41c} データタイプ：文字列 | [ ] ### cURL 要求 次の要求は、BOQ レコードのテストランナージョブの進捗状況を取得します。 curl "http://instance.service-now.com/api/now/sn_atf_tg/test_runner_progress?snboqId=" \ --request GET \ --header "Accept:application/json" \ --user "username:password" 応答は、テストが 100% 完了したことを示しています。 { "result": { "progress": 100, "state": "completed" } } 次の例では、BOQ ID が渡されない場合に 400 エラーメッセージが返されます。 curl "http://instance.service-now.com/api/now/sn_atf_tg/test_runner_progress" \ --request GET \ --header "Accept:application/json" \ --user "username:password" 応答： { "result": { "message": "No SNBOQ ID passed in, add snboqId to request body" } } 次の例では、無効な BOQ ID が渡されると 400 エラーメッセージが返されます。 curl "http://instance.service-now.com/api/now/sn_atf_tg/test_runner_progress?snboqId=invalid_sys_id" \ --request GET \ --header "Accept:application/json" \ --user "username:password" 応答： { "result": { "message": "Invalid SNBOQ sys_id passed in" } } ## クラウドランナーテストランナー:POST /now/sn_atf_tg/cancel_test_runner {#ariaid-title3} テストランナージョブを完了ステータスに設定し、実行中の生成済みテストのルートトラッカーをキャンセルします。 ### URL 形式 デフォルト URL:GET /now/sn_atf_tg/cancel_test_runner ### サポートされている要求パラメーター {#cr-TestRunnerAPI-POST-cancel-test-runner__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 7. パスパラメーター] {#cr-TestRunnerAPI-POST-cancel-test-runner__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 8. クエリパラメーター] {#cr-TestRunnerAPI-POST-cancel-test-runner__entry__10} | 名前 | 説明 | |-|-| | snboqId | キャンセルするテストランナージョブに関連付けられているブラウザオーケストレーションキュー (BOQ) レコード (sn_atf_tg_sn_boq) のSys_id。 データタイプ：文字列 テーブル:BOQ \[sn_atf_tg_sn_boq\] | [表 : 9. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cr-TestRunnerAPI-POST-cancel-test-runner__table_ism_z2j_41c__entry__2}{#cr-TestRunnerAPI-POST-cancel-test-runner__accept-RESTAPI}{#cr-TestRunnerAPI-POST-cancel-test-runner__content_type-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 10. 要求ヘッダー] {#cr-TestRunnerAPI-POST-cancel-test-runner__table_ism_z2j_41c} {#cr-TestRunnerAPI-POST-cancel-test-runner__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 11. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cr-TestRunnerAPI-POST-cancel-test-runner__entry__24}{#cr-TestRunnerAPI-POST-cancel-test-runner__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | ジョブのキャンセル中にエラーが発生しました。次のいずれかのメッセージを返します。 * BOQ ID が渡されませんでした:BOQ ID が指定されていません。BOQ ID を要求本文に追加します。 * BOQ レコードが見つかりません:無効な Sys ID。BOQ レコードのsys_idが有効であり、レコードが存在することを確認します。 {#cr-TestRunnerAPI-POST-cancel-test-runner__ul_fzp_ztk_p1c} | | 403 | エンドポイントへのユーザーアクセスの許可中にエラーが発生しました。ユーザーに admin ロールがあることを確認します。 | [表 : 12. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cr-TestRunnerAPI-POST-cancel-test-runner__entry__32} | 名前 | 説明 | |-|-| | result | 要求の結果を含むオブジェクト。 "result": { "message": String } {#cr-TestRunnerAPI-POST-cancel-test-runner__codeblock_hhp_4k2_p1c} データタイプ: オブジェクト | | result.message | テストのキャンセルが成功したかどうかを詳述するメッセージ。 データタイプ：文字列 | [ ] ### cURL 要求 次の例は、BOQ レコードのsys_idに従ってテストランナーのキャンセル要求を作成する方法を示しています。 curl "https://instance.service-now.com/api/now/sn_atf_tg/cancel_test_runner" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{\"snboqId\":\"\"}" \ --user "username:password" テストランナーが正常にキャンセルされたことを示す応答メッセージ。 { "result": { "message": "success" } } ## クラウドランナーテストランナー:POST /now/sn_atf_tg/test_runner {#ariaid-title4} 指定されたテストまたはテストスイートの BOQ \[sn_atf_tg_sn_boq\] テーブルにテストランナージョブを挿入します。このジョブはクラウドランナーで実行されます。 ### URL 形式 デフォルト URL:POST api/now/sn_atf_tg/test_runner ### サポートされている要求パラメーター {#cr-TestRunnerAPI-POST-test-runner__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 13. パスパラメーター] {#cr-TestRunnerAPI-POST-test-runner__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 14. クエリパラメーター] {#cr-TestRunnerAPI-POST-test-runner__entry__10} | 名前 | 説明 | |-|-| | testid | クラウドランナーで実行するテスト \[sys_atf_test\] またはテストスイート \[sys_atf_test_suite\] のSys_id。 | [表 : 15. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cr-TestRunnerAPI-POST-test-runner__table_gcx_1fj_41c__entry__2}{#cr-TestRunnerAPI-POST-test-runner__accept-RESTAPI}{#cr-TestRunnerAPI-POST-test-runner__content_type-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 16. 要求ヘッダー] {#cr-TestRunnerAPI-POST-test-runner__table_gcx_1fj_41c} {#cr-TestRunnerAPI-POST-test-runner__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 17. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cr-TestRunnerAPI-POST-test-runner__entry__24} | ステータスコード | 説明 | |-|-| | 200 | テストランナー BOQ ジョブが正常に挿入されました。 | | 400 | テストランナージョブの開始中にエラーが発生しました。次のいずれかのメッセージを返します。 * 次の Sys ID のテストまたはテストスイートが見つかりません \:テスト ID が無効です。テスト (sys_atf_test) またはテストスイート (sys_atf_test_suite) レコードのsys_idが有効であり、レコードが存在することを確認します。 * テスト ID が渡されませんでした (No Test ID passed in):テスト ID が合格しませんでした。テスト ID を要求本文に追加します。 {#cr-TestRunnerAPI-POST-test-runner__ul_uht_ttk_p1c} | | 403 | エンドポイントへのユーザーアクセスの許可中にエラーが発生しました。ユーザーに admin ロールがあることを確認します。 | [表 : 18. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cr-TestRunnerAPI-POST-test-runner__entry__32} | 名前 | 説明 | |-|-| | result | 要求の結果を含むオブジェクト。 データタイプ: オブジェクト { "result": { "snboqId": "String" } } {#cr-TestRunnerAPI-POST-test-runner__codeblock_n5d_sxk_p1c} または： "result": { "message": "String" } {#cr-TestRunnerAPI-POST-test-runner__codeblock_hhp_4k2_p1c} | | result.snboqId | テストランナーの開始時に挿入される BOQ レコードのSys_id。 データタイプ：文字列 テーブル:BOQ \[sn_atf_tg_sn_boq\] | | result.message | テストランナーを開始できない理由を詳述したエラーメッセージ。 データタイプ：文字列 | [ ] ### cURL 要求 次の要求は、テストランナージョブを BOQ \[sn_atf_tg_sn_boq\] テーブルに挿入します。 curl "https://instance.service-now.com/api/now/sn_atf_tg/test_runner" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{\"testId\":\"\"}" \ --user "username:password" 応答本文は、正常に挿入されたテストランナージョブのsys_idを返します。 { "result": { "snboqId": "" } } {#cr-TestRunnerAPI-POST-test-runner__codeblock_bhq_np3_41c}