---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://www.servicenow.com/docs/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# OnCallContactPrefTemplate - グローバル

# OnCallContactPrefTemplate - グローバル {#ariaid-title1}

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

OnCallContactPrefTemplate スクリプトインクルードは、連絡先設定テンプレートをエスカレーションセットに適用するメソッドを提供します。

エスカレーションプロセスの詳細については、「 [Defining On-Call Scheduling escalation process](https://www.servicenow.com/docs/access?context=defining-escalation-process-and-template&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US)」を参照してください。

このスクリプトインクルードには、オンコールスケジューリングプラグイン (com.snc.on_call_rotation) が必要です。

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

OnCallContactPrefTemplate オブジェクトをインスタンス化します。
{#OnCallCtPrefTemp-OnCallCtPrefTemp__table_b1n_q5c_kxb__entry__3}

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

{#OnCallCtPrefTemp-OnCallCtPrefTemp__table_b1n_q5c_kxb}  
この例では、 OnCallContactPrefTemplate オブジェクトをインスタンス化します。

    var contactPrefTemp = new global.OnCallContactPrefTemplate();

## OnCallContactPrefTemplate - copyContactPreferences(文字列 templateSysId, 文字列 escalationSetSysId) {#ariaid-title3}

連絡先設定テンプレートをエスカレーションセットに適用します。
テンプレートがエスカレーションセットに適用されると、シフト連絡先設定 \[cmn_rota_contact_preference\] テーブルに連絡試行レコードが作成されます。

このメソッドを呼び出す前に、 deleteContactPreferenceAttempts() メソッドを呼び出して、既存の連絡試行レコードを削除します。既存のレコードが最初に削除されていない場合、このメソッドはエラーを返します。
{#OnCallCtPrefTemp-copyCtPrefs_S_S__table_cgl_2rd_3xb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| templateSysId | 文字列 | オンコール連絡先設定テンプレート \[on_call_template_contact_preference\] テーブルの連絡先設定テンプレートのSys_id。 |
| エスカレーションセット SysID | 文字列 | シフトエスカレーションセット \[cmn_rota_escalation_set\] テーブル内のエスカレーションセットのSys_id。 |
[表 : 2. パラメーター]

{#OnCallCtPrefTemp-copyCtPrefs_S_S__table_cgl_2rd_3xb} {#OnCallCtPrefTemp-copyCtPrefs_S_S__table_dgl_2rd_3xb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | エラーメッセージと警告メッセージを含むオブジェクト。操作が成功した場合、このオブジェクトは空です。 注: エラーが発生すると、操作は停止し、テンプレートは適用されません。警告が発生した場合、操作は続行され、一部のレコードは引き続き作成されます。 { "error": "String", "warning": "String" } |
| \<Object\>。エラー | エラーメッセージ 可能な値： * 連絡設定テンプレートのsys_idが正しくありません * エスカレーションセットsys_idが正しくありません * 連絡試行は既に存在します {#OnCallCtPrefTemp-copyCtPrefs_S_S__ul_dmh_3tc_kxb} データタイプ：文字列 |
| \<Object\>。警告 | 警告メッセージ。 データタイプ：文字列 |
[表 : 3. 返される内容]

{#OnCallCtPrefTemp-copyCtPrefs_S_S__table_dgl_2rd_3xb}  
この例では、連絡先設定テンプレートをサービスデスク - デフォルトのエスカレーションセットに適用します。エラーや警告がないため、戻りオブジェクトは空です。

    var escSetSysId = "a47ac1abeb5a6110249e8d835d5228aa";
    var templateSysId = "f8dac9ebeb5a6110249e8d835d522873";

    var contactPrefTemp = new global.OnCallContactPrefTemplate();

    // delete existing contact attempt records before applying the template
    contactPrefTemp.deleteContactPreferenceAttempts(escSetSysId); 

    var result = contactPrefTemp.copyContactPreferences(templateSysId, escSetSysId);
    gs.info(JSON.stringify(result));

出力:

    {}

## OnCallContactPrefTemplate - deleteContactPreferenceAttempts(文字列 escalationSetSysId) {#ariaid-title4}

エスカレーションセットに関連付けられているすべての連絡先設定を削除します。
エスカレーションセットのすべての連絡試行レコードが、シフト連絡先設定 \[cmn_rota_contact_preference\] テーブルから削除されます。
{#OnCallCtPrefTemp-deleteCtPrefAtt_S__table_zlg_zqd_3xb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| エスカレーションセット SysID | 文字列 | シフトエスカレーションセット \[cmn_rota_escalation_set\] テーブル内のエスカレーションセットのSys_id。 |
[表 : 4. パラメーター]

{#OnCallCtPrefTemp-deleteCtPrefAtt_S__table_zlg_zqd_3xb} {#OnCallCtPrefTemp-deleteCtPrefAtt_S__table_amg_zqd_3xb__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 5. 返される内容]

{#OnCallCtPrefTemp-deleteCtPrefAtt_S__table_amg_zqd_3xb}  
この例では、「サービスデスク - デフォルト」エスカレーションセットに関連付けられているすべての連絡先設定を削除します。

    var escSetSysId = "a47ac1abeb5a6110249e8d835d5228aa";
    var contactPrefTemp = new global.OnCallContactPrefTemplate();

    contactPrefTemp.deleteContactPreferenceAttempts(escSetSysId);