---
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


---

# CheckInstanceTestBuilder: スコープ指定

# CheckInstanceTestBuilder: スコープ指定 {#ariaid-title1}

* リリースバージョン: Australia
* 
* 更新日 2026年03月12日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：10分

CheckInstanceTestBuilder スクリプトインクルードは、チェックインスタンスでテストチェック要求をビルドできるようにするメソッドを提供します。

このスクリプトインクルードには エージェントクライアントコレクター Framework (sn_agent) ストアアプリケーションが必要であり、 `sn_agent` 名前空間内で提供されます。詳細については、「 [エージェントクライアントコレクター](https://www.servicenow.com/docs/access?context=acc-landing-page&version=australia&pubname=australia-it-operations-management&ft:locale=en-US)」を参照してください。

REST API ソリューションについては、「 [エージェントクライアントコレクター API](https://servicenow-prod.fluidtopics.net/AkJTonHNQh2a_KwsYT8Uqg#agnt_clnt_cll-api "エージェントクライアントコレクター API は、利用可能なエージェントに対するアクションを管理し、ポリシーを管理するためのエンドポイントを提供します。")」を参照してください。  
このスクリプトインクルードは、以下を可能にするメソッドを提供します。

* チェックインスタンスをテストに設定
* テストを実行する構成アイテムを設定する

{#CheckInstanceTestBuilderAPIScoped__ul_tdb_gpk_5qb}テスト中に使用する次のいずれかの識別子を指定することもできます。

<!-- -->

* 認証情報sys_id
* 認証情報エイリアス ID
* 認証情報名
{#CheckInstanceTestBuilderAPIScoped__ul_tft_qwk_5qb}

## CheckInstanceTestBuilder:CheckInstanceTestBuilder() {#ariaid-title2}

CheckInstanceTestBuilder インスタンスを作成します。
{#CkInTB-CheckInstanceTestBuilder__table_ohr_4qd_bpb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 1. パラメーター]

{#CkInTB-CheckInstanceTestBuilder__table_ohr_4qd_bpb}  
次の例は、 CheckInstanceTestBuilder を初期化する方法を示しています。

    var builder = new sn_agent.CheckInstanceTestBuilder();

## CheckInstanceTestBuilder:build() {#ariaid-title3}

引数を設定してテストチェック要求をビルドします。
{#CkInTB-build__table_zk2_2g2_z4b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 2. パラメーター]

{#CkInTB-build__table_zk2_2g2_z4b} {#CkInTB-build__table_al2_2g2_z4b__entry__2}

| プロパティ | 説明 |
|-|-|
| オブジェクト | テスト結果レコード ID とエラーの 2 つの属性を持つ JSON オブジェクト。ビルドが成功した場合、テスト結果 ID が返され、エラーは null です。ビルド中にエラーが発生した場合、テスト結果 ID は null になり、エラーが表示されます。 |
[表 : 3. 返される内容]

{#CkInTB-build__table_al2_2g2_z4b}  
次の例は、テストチェック要求をビルドする方法を示しています。

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
    var builder = new sn_agent.CheckInstanceTestBuilder();

    var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();

    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);

## CheckInstanceTestBuilder:withCheckId(文字列 checkId) {#ariaid-title4}

テストするチェック定義のsys_idを設定します。
{#CkInTB-withCheckId_S__table_zk2_2g2_z4b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| チェック ID | 文字列 | チェック定義 \[sn_agent_check_def\] テーブルにリストされているチェック定義のSys_id。 |
[表 : 4. パラメーター]

{#CkInTB-withCheckId_S__table_zk2_2g2_z4b} {#CkInTB-withCheckId_S__table_al2_2g2_z4b__entry__2}

| タイプ | 説明 |
|-|-|
| CheckInstanceTestBuilder | メソッドが呼び出されたビルダーインスタンス。 |
[表 : 5. 返される内容]

{#CkInTB-withCheckId_S__table_al2_2g2_z4b}  
次の例は、テストチェックを作成する方法を示しています。

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
    var builder = new sn_agent.CheckInstanceTestBuilder();
    var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();
    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);

## CheckInstanceTestBuilder:withCiId(文字列 ciId) {#ariaid-title5}

テストを実行する構成アイテムのsys_idを設定します。
{#CkInTB-withCiId_S__table_zk2_2g2_z4b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| ciId | 文字列 | CMDB 構成アイテムのSys_id。 |
[表 : 6. パラメーター]

{#CkInTB-withCiId_S__table_zk2_2g2_z4b} {#CkInTB-withCiId_S__table_al2_2g2_z4b__entry__2}

| タイプ | 説明 |
|-|-|
| CheckInstanceTestBuilder | メソッドが呼び出されたビルダーインスタンス。 |
[表 : 7. 返される内容]

{#CkInTB-withCiId_S__table_al2_2g2_z4b}  
次の例は、を使用してテストチェック要求を作成する方法を示しています

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
    var builder = new sn_agent.CheckInstanceTestBuilder();
    var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();
    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);

## CheckInstanceTestBuilder:withCredentialsAliasId(文字列 credentialsAliasId) {#ariaid-title6}

テスト中に使用する認証情報エイリアスsys_idを設定します。
注:  
これを実行すると、withCredentialsName、withCredentialsAliasId、または withCredentialsAliasName を呼び出して以前に行われた割り当てが削除されます。 {#CkInTB-withCredentialsAliasId_S__table_zk2_2g2_z4b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| credentialsAliasId | 文字列 | 認証情報エイリアスレコードのSys_id。 |
[表 : 8. パラメーター]

{#CkInTB-withCredentialsAliasId_S__table_zk2_2g2_z4b} {#CkInTB-withCredentialsAliasId_S__table_bjt_555_wqb__entry__2}

| タイプ | 説明 |
|-|-|
| CheckInstanceTestBuilder | メソッドが呼び出されたビルダーインスタンス。 |
[表 : 9. 返される内容]

{#CkInTB-withCredentialsAliasId_S__table_bjt_555_wqb}  
次の例は、テストチェックを作成し、認証情報エイリアス ID を設定する方法を示しています。

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var credAlias = "<sys_id>";
    var builder = new sn_agent.CheckInstanceTestBuilder();
    var testResultJson = builder.withCheckId(checkId).withCredentialsAliasId(credAlias).build();
    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);

## CheckInstanceTestBuilder:withCredentialsAliasName(文字列 credentialsAliasName) {#ariaid-title7}

テスト中に使用する認証情報エイリアス名を設定します。指定された値が複数の認証情報エイリアスレコードの名前と一致する場合、そのうちの 1 つがランダムに選択されます。
注:  
これを実行すると、withCredentialsName、withCredentialsAliasId、または withCredentialsAliasName を呼び出して以前に行われた割り当てが削除されます。
{#CkInTB-withCredentialsAliasName_S__table_zk2_2g2_z4b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| credentialsAliasName | 文字列 | 認証情報エイリアスの名前。 |
[表 : 10. パラメーター]

{#CkInTB-withCredentialsAliasName_S__table_zk2_2g2_z4b} {#CkInTB-withCredentialsAliasName_S__table_al2_2g2_z4b__entry__2}

| タイプ | 説明 |
|-|-|
| CheckInstanceTestBuilder | メソッドが呼び出されたビルダーインスタンス。 |
[表 : 11. 返される内容]

{#CkInTB-withCredentialsAliasName_S__table_al2_2g2_z4b}  
次の例は、テストチェックを作成し、認証情報エイリアス名を設定する方法を示しています。

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var credentialsAliasName = "credentialsAliasName";
    var builder = new sn_agent.CheckInstanceTestBuilder();
    var testResultJson = builder.withCheckId(checkId).withCredentialsAliasName(credentialsAliasName).build();
    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);

## CheckInstanceTestBuilder:withCredentialsId(文字列 credentialsId) {#ariaid-title8}

テスト中に使用する認証情報sys_idを設定します。
注:  
これを実行すると、withCredentialsName、withCredentialsAliasId、または withCredentialsAliasName を呼び出して以前に行われた割り当てが削除されます。 {#CkInTB-withCredentialsId_S__table_zk2_2g2_z4b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| credentialsId | 文字列 | 認証情報レコードのSys_id。 |
[表 : 12. パラメーター]

{#CkInTB-withCredentialsId_S__table_zk2_2g2_z4b} {#CkInTB-withCredentialsId_S__table_al2_2g2_z4b__entry__2}

| タイプ | 説明 |
|-|-|
| CheckInstanceTestBuilder | メソッドが呼び出されたビルダーインスタンス。 |
[表 : 13. 返される内容]

{#CkInTB-withCredentialsId_S__table_al2_2g2_z4b}  
次の例は、テストチェックを作成し、認証情報 ID を設定する方法を示しています。

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var credID = "<sys_id>";
    var builder = new sn_agent.CheckInstanceTestBuilder();
    var testResultJson = builder.withCheckId(checkId).withCredentialsId(credID).build();
    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);

## CheckInstanceTestBuilder:withCredentialsName(文字列 credentialsName) {#ariaid-title9}

テスト中に使用する認証情報名を設定します。指定された値が複数の認証情報レコードの名前である場合、そのうちの 1 つがランダムに選択されます。
注:  
これを実行すると、withCredentialsName、withCredentialsAliasId、または withCredentialsAliasName を呼び出して以前に行われた割り当てが削除されます。 {#CkInTB-withCredentialsName_S__table_zk2_2g2_z4b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| 認証情報名 | 文字列 | 認証情報レコードの名前。 |
[表 : 14. パラメーター]

{#CkInTB-withCredentialsName_S__table_zk2_2g2_z4b} {#CkInTB-withCredentialsName_S__table_al2_2g2_z4b__entry__2}

| タイプ | 説明 |
|-|-|
| CheckInstanceTestBuilder | メソッドが呼び出されたビルダーインスタンス。 |
[表 : 15. 返される内容]

{#CkInTB-withCredentialsName_S__table_al2_2g2_z4b}  
次の例は、テストチェックを作成し、認証情報名を設定する方法を示しています。

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var credname = "credentialsName";
    var builder = new sn_agent.CheckInstanceTestBuilder();
    var testResultJson = builder.withCheckId(checkId).withCredentialsName(credName).build();
    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);

## CheckInstanceTestBuilder:withProxyAgentId(文字列 agentId) {#ariaid-title10}

テストを実行するエージェントを設定します。テスト済みのチェックインスタンスとポリシーがプロキシである場合にのみ許可されます。
{#CkInTB-withProxyAgentId_S__table_zk2_2g2_z4b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| agentId | 文字列 | このチェックを実行するエージェントプロキシの一意の ID。この値は、エージェントクライアントコレクター \[sn_agent_cmdb_ci_agent\] テーブルの \[エージェント ID\] 列にリストされます。 |
[表 : 16. パラメーター]

{#CkInTB-withProxyAgentId_S__table_zk2_2g2_z4b} {#CkInTB-withProxyAgentId_S__table_al2_2g2_z4b__entry__2}

| タイプ | 説明 |
|-|-|
| CheckInstanceTestBuilder | メソッドが呼び出されたビルダーインスタンス。 |
[表 : 17. 返される内容]

{#CkInTB-withProxyAgentId_S__table_al2_2g2_z4b}  
次の例は、テストチェックを作成し、プロキシエージェント ID を設定する方法を示しています。

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var agentId = "<agentID>";
    var builder = new sn_agent.CheckInstanceTestBuilder();
    var testResultJson = builder.withCheckId(checkId).withAgentId(agentId).build();
    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);