---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# CheckDefinitionTestBuilder - スコープ指定

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

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：9分

CheckDefinitionTestBuilder スクリプトインクルードは、チェック定義に対するチェックテスト要求を作成できるようにするメソッドを提供します。

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

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

* テストするチェック定義を設定
* テストを実行するための構成アイテムを設定

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

<!-- -->

* 資格情報 sys_id
* 資格情報エイリアス ID
* 資格情報名
{#CheckDefinitionTestBuilderAPIScope__ul_tft_qwk_5qb}

## CheckDefinitionTestBuilder - CheckDefinitionTestBuilder() {#ariaid-title2}

CheckDefinitionTestBuilder インスタンスを作成します。
{#CkDfTB-CheckDefinitionTestBuilder__table_ohr_4qd_bpb__entry__3}

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

{#CkDfTB-CheckDefinitionTestBuilder__table_ohr_4qd_bpb}  
次の例は、CheckDefinitionTestBuilderを初期化する方法を示しています。

    var builder = new sn_agent.CheckDefinitionTestBuilder();

## CheckDefinitionTestBuilder - build() {#ariaid-title3}

引数を設定してテストチェック要求を構築します。
{#CkDfTB-build__table_zk2_2g2_z4b__entry__3}

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

{#CkDfTB-build__table_zk2_2g2_z4b} {#CkDfTB-build__table_al2_2g2_z4b__entry__2}

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

{#CkDfTB-build__table_al2_2g2_z4b}  
次の例は、テストチェック要求の構築方法を示しています。

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

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

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

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

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

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

{#CkDfTB-withCheckId_S__table_zk2_2g2_z4b} {#CkDfTB-withCheckId_S__table_al2_2g2_z4b__entry__2}

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

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

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

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

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

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

{#CkDfTB-withCiId_S__table_zk2_2g2_z4b} {#CkDfTB-withCiId_S__table_al2_2g2_z4b__entry__2}

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

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

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

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

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

| 名前 | タイプ | 説明 |
|-|-|-|
| credentialsAliasId | 文字列 | 資格情報レコードの sys_id。 |
[表 : 8. パラメーター]

{#CkDfTB-withCredentialsAliasId_S__table_zk2_2g2_z4b} {#CkDfTB-withCredentialsAliasId_S__table_bjt_555_wqb__entry__2}

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

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

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

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

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

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

{#CkDfTB-withCredentialsAliasName_S__table_zk2_2g2_z4b} {#CkDfTB-withCredentialsAliasName_S__table_al2_2g2_z4b__entry__2}

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

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

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

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

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

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

{#CkDfTB-withCredentialsId_S__table_zk2_2g2_z4b} {#CkDfTB-withCredentialsId_S__table_al2_2g2_z4b__entry__2}

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

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

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

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

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

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

{#CkDfTB-withCredentialsName_S__table_zk2_2g2_z4b} {#CkDfTB-withCredentialsName_S__table_al2_2g2_z4b__entry__2}

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

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

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