OnCallContactPrefTemplate - グローバル

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

エスカレーションプロセスの詳細については、「」を参照してください Defining On-Call Scheduling escalation process。

この API には On-Call Scheduling プラグイン (com.snc.on_call_rotation) が必要です。

OnCallContactPrefTemplate:OnCallContactPrefTemplate()

OnCallContactPrefTemplate オブジェクトをインスタンス化します。

表 : 1. パラメーター

名前	タイプ	説明
なし

この例では、 OnCallContactPrefTemplate オブジェクトをインスタンス化します。

var contactPrefTemp = new global.OnCallContactPrefTemplate();

OnCallContactPrefTemplate - copyContactPreferences(文字列 templateSysId, 文字列 escalationSetSysId)

連絡先設定テンプレートをエスカレーションセットに適用します。

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

このメソッドを呼び出す前に、 deleteContactPreferenceAttempts() メソッドを呼び出して既存の連絡試行レコードを削除します。既存のレコードを先に削除しない場合、このメソッドはエラーを返します。

表 : 2. パラメーター

名前	タイプ	説明
templateSysId	文字列	オンコール連絡先設定テンプレート [on_call_template_contact_preference] テーブルの連絡先設定テンプレートのSys_id。
escalationSetSysID	文字列	シフトエスカレーションセット [cmn_rota_escalation_set] テーブル内のエスカレーションセットのSys_id。

表 : 3. 返される内容

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

この例では、連絡先設定テンプレートを Service Desk - デフォルトのエスカレーションセットに適用します。エラーや警告がないため、返されるオブジェクトは空です。

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)

エスカレーションセットに関連付けられたすべての連絡先設定を削除します。

エスカレーションセットのすべての連絡試行レコードがシフト連絡設定 [cmn_rota_contact_preference] テーブルから削除されます。

表 : 4. パラメーター

名前	タイプ	説明
escalationSetSysID	文字列	シフトエスカレーションセット [cmn_rota_escalation_set] テーブル内のエスカレーションセットのSys_id。

表 : 5. 返される内容

タイプ	説明
なし

この例は、Service Desk - デフォルトのエスカレーションセットに関連付けられているすべての連絡先設定を削除します。

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

contactPrefTemp.deleteContactPreferenceAttempts(escSetSysId);