--- 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 --- # OCRotation - グローバル # OCRotation - グローバル {#ariaid-title1} * リリースバージョン: Xanadu * * 更新日 2024年08月01日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：6分 OCRotation スクリプトインクルードは、カレンダーの表示に使用されるデータ構造をビルドするためのメソッドを提供します。 このコードは、スパンアイテムのリストを格納する GlideAJAXSchedulePage オブジェクトを構築します。このタイプは従来の Gwt カレンダーに使用できます。他のカレンダータイプについては、 [OCRotationV2 - グローバル](https://servicenow-prod.fluidtopics.net/rcfKCSLyIXv3_lSN_0ziVA#c_OCRotationV2 "OCRotationV2 スクリプトインクルードは、Fullcalendar.io および DHTMLX オンコールカレンダーで使用される OCRotation スクリプトインクルードの拡張です。") スクリプトインクルードを参照してください。これは On-Call Scheduling の一部です。 ## OCRotation - buildRotas() {#ariaid-title2} グループ、勤務表および勤務表に基づいてオンコールカバー範囲を構築します。OCRotationV2 - getSpan メソッドで使用されます。 {#r_OCRotation-buildrotas__table_bl2_jhb_h5__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 1. パラメーター] {#r_OCRotation-buildrotas__table_bl2_jhb_h5} {#r_OCRotation-buildrotas__table_cl2_jhb_h5__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 2. 返される内容] {#r_OCRotation-buildrotas__table_cl2_jhb_h5} **関連資料** * [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/rcfKCSLyIXv3_lSN_0ziVA#r_OCRotationV2-getSpans "指定された開始日から指定された終了日までのスパンを取得します。開始日と終了日が指定されていない場合、開始日のデフォルトは現在の時刻の 1 か月前、終了日のデフォルトは 1 か月後になります。グループ ID、勤務表 ID、勤務表 ID、ユーザー ID を使用して、スパンをさらに細かくフィルタリングすることもできます。") ## OCRotation - getEndDate() {#ariaid-title3} オンコールカバー範囲を取得する期間の終了日を返します。 {#r_OCRotation-getEndDate__table_ljb_njx_g5__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 3. パラメーター] {#r_OCRotation-getEndDate__table_ljb_njx_g5} {#r_OCRotation-getEndDate__table_mjb_njx_g5__entry__2} | タイプ | 説明 | |-|-| | 文字列 | オンコールカバー範囲を取得する期間の終了日。 | [表 : 4. 返される内容] {#r_OCRotation-getEndDate__table_mjb_njx_g5} ## OCRotation - getGroupIds() {#ariaid-title4} オンコールスケジュールのグループ sys_id (sys_user_group) の値のカンマ区切りリストを返します。 {#r_OCRotation-getGroupIDs__table_d2s_nnx_g5__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 5. パラメーター] {#r_OCRotation-getGroupIDs__table_d2s_nnx_g5} {#r_OCRotation-getGroupIDs__table_e2s_nnx_g5__entry__2} | タイプ | 説明 | |-|-| | 文字列 | オンコールスケジュールのグループ sys_id (sys_user_group) の値のカンマ区切りリスト。 | [表 : 6. 返される内容] {#r_OCRotation-getGroupIDs__table_e2s_nnx_g5} ## OCRotation - getRosterIds() {#ariaid-title5} 選択した勤務表に従って勤務表を返します。 {#r_OCRotation-getRosterIDs__table_kcq_gcb_h5__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 7. パラメーター] {#r_OCRotation-getRosterIDs__table_kcq_gcb_h5} {#r_OCRotation-getRosterIDs__table_lcq_gcb_h5__entry__2} | タイプ | 説明 | |-|-| | 文字列 | 選択した勤務表に従った勤務表。 | [表 : 8. 返される内容] {#r_OCRotation-getRosterIDs__table_lcq_gcb_h5} ## OCRotation - getRotaGr(文字列 rotaIds, 文字列 groupIds, 文字列 rosterIds, 文字列 userIds) {#ariaid-title6} グループ、勤務表、ユーザー、勤務表を基準にフィルタリングされた cmn_rota テーブルの GlideRecord を返します。 {#r_OCRotation-getrotaGr_String_String_String_String__table_r4x_prm_45__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | rotaIds | 文字列 | オンコールスケジュールの勤務表 sys_id (cmn_rota) の値のカンマ区切りリスト。 | | groupIds | 文字列 | オンコールスケジュールのグループ sys_id (sys_user_group) の値のカンマ区切りリスト。 | | rosterIds | 文字列 | オンコールスケジュールの勤務表 sys_id (cmn_rota_roster) の値のカンマ区切りリスト。 | | userIds | 文字列 | オンコールスケジュールのユーザー sys_id (sys_user) の値のカンマ区切りリスト。 | [表 : 9. パラメーター] {#r_OCRotation-getrotaGr_String_String_String_String__table_r4x_prm_45} {#r_OCRotation-getrotaGr_String_String_String_String__table_s4x_prm_45__entry__2} | タイプ | 説明 | |-|-| | GlideRecord | グループ、勤務表、ユーザー、勤務表を基準にフィルタリングされた cmn_rota テーブルの GlideRecord。 | [表 : 10. 返される内容] {#r_OCRotation-getrotaGr_String_String_String_String__table_s4x_prm_45} ## OCRotation - getRotaIds() {#ariaid-title7} カレンダー上のグループの勤務表を返します。 {#r_OCRotation-getRotaIDs__table_ycs_rbb_h5__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 11. パラメーター] {#r_OCRotation-getRotaIDs__table_ycs_rbb_h5} {#r_OCRotation-getRotaIDs__table_zcs_rbb_h5__entry__2} | タイプ | 説明 | |-|-| | 文字列 | カレンダー上のグループの勤務表。 | [表 : 12. 返される内容] {#r_OCRotation-getRotaIDs__table_zcs_rbb_h5} ## OCRotation - getStartDate() {#ariaid-title8} オンコールカバー範囲を取得する期間の開始日を返します。 {#r_OCRotation-getStartDate__table_asg_l3r_g5__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 13. パラメーター] {#r_OCRotation-getStartDate__table_asg_l3r_g5} {#r_OCRotation-getStartDate__table_bsg_l3r_g5__entry__2} | タイプ | 説明 | |-|-| | 文字列 | オンコールカバー範囲を取得する期間の開始日。 | [表 : 14. 返される内容] {#r_OCRotation-getStartDate__table_bsg_l3r_g5} ## OCRotation - getTimezone() {#ariaid-title9} オンコールカレンダーが使用するタイムゾーンを返します。 {#r_OCRotation-getTimezone__table_u5g_kkx_g5__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 15. パラメーター] {#r_OCRotation-getTimezone__table_u5g_kkx_g5} {#r_OCRotation-getTimezone__table_v5g_kkx_g5__entry__2} | タイプ | 説明 | |-|-| | 文字列 | オンコールカレンダーが使用するタイムゾーン。たとえば、\[欧州/マドリッド\] や \[米国/太平洋\]などです。 | [表 : 16. 返される内容] {#r_OCRotation-getTimezone__table_v5g_kkx_g5} ## OCRotation - getUserIDs() {#ariaid-title10} これにより、ユーザーによって返されるスケジュールがフィルタリングされます。オンコールスケジュールのフィルタリングに使用されるユーザー sys_id (sys_user) の値のカンマ区切りリストを取得します。 {#r_OCRotation-getUserIDs__table_y3n_5cb_h5__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 17. パラメーター] {#r_OCRotation-getUserIDs__table_y3n_5cb_h5} {#r_OCRotation-getUserIDs__table_z3n_5cb_h5__entry__2} | タイプ | 説明 | |-|-| | 文字列 | オンコールスケジュールのフィルタリングに使用されるユーザー sys_id (sys_user) の値のカンマ区切りリスト。 | [表 : 18. 返される内容] {#r_OCRotation-getUserIDs__table_z3n_5cb_h5} ## OCRotation - setEndDate(文字列 endDate, ブーリアン inclusive) {#ariaid-title11} オンコールカバー範囲を取得する期間の終了日を設定します。終了日が設定されていない場合、翌月の末日がデフォルトで適用されます。OCRotationV2 - getSpan と組み合わせて使用します。 {#r_OCRotation-setEndDate_String_B__table_rvb_dkx_g5__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | endDate | 文字列 | (オプション) オンコールスケジュールの終了日。 | | inclusive | ブーリアン | (オプション) true の場合、終了日がタイムスパンに含まれます。指定しない場合、この値はデフォルトで true に設定されます。 | [表 : 19. パラメーター] {#r_OCRotation-setEndDate_String_B__table_rvb_dkx_g5} {#r_OCRotation-setEndDate_String_B__table_svb_dkx_g5__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 20. 返される内容] {#r_OCRotation-setEndDate_String_B__table_svb_dkx_g5} **関連資料** * [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/rcfKCSLyIXv3_lSN_0ziVA#r_OCRotationV2-getSpans "指定された開始日から指定された終了日までのスパンを取得します。開始日と終了日が指定されていない場合、開始日のデフォルトは現在の時刻の 1 か月前、終了日のデフォルトは 1 か月後になります。グループ ID、勤務表 ID、勤務表 ID、ユーザー ID を使用して、スパンをさらに細かくフィルタリングすることもできます。") ## OCRotation - setGroupIds(文字列 groupIds) {#ariaid-title12} 返されるスケジュールをグループ別にフィルタリングします。オンコールスケジュールのグループ sys_id (sys_user_group) の値のカンマ区切りリストを設定します。OCRotationV2 - getSpan と組み合わせて使用します。 {#r_OCRotation-setGroupIDs_String__table_zkc_kbb_h5__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | groupIds | 文字列 | オンコールスケジュールのグループ sys_id (sys_user_group) の値のカンマ区切りリスト。 | [表 : 21. パラメーター] {#r_OCRotation-setGroupIDs_String__table_zkc_kbb_h5} {#r_OCRotation-setGroupIDs_String__table_alc_kbb_h5__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 22. 返される内容] {#r_OCRotation-setGroupIDs_String__table_alc_kbb_h5} **関連資料** * [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/rcfKCSLyIXv3_lSN_0ziVA#r_OCRotationV2-getSpans "指定された開始日から指定された終了日までのスパンを取得します。開始日と終了日が指定されていない場合、開始日のデフォルトは現在の時刻の 1 か月前、終了日のデフォルトは 1 か月後になります。グループ ID、勤務表 ID、勤務表 ID、ユーザー ID を使用して、スパンをさらに細かくフィルタリングすることもできます。") ## OCRotation - setRosterIds(文字列 rosterIds) {#ariaid-title13} 選択した勤務表に従って勤務表を設定します。OCRotationV2 - getSpan と組み合わせて使用します。 {#r_OCRotation-setRosterIDs_String__table_ljr_mcb_h5__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | RosterIds | 文字列 | 選択した勤務表に従った勤務表。 | [表 : 23. パラメーター] {#r_OCRotation-setRosterIDs_String__table_ljr_mcb_h5} {#r_OCRotation-setRosterIDs_String__table_mjr_mcb_h5__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 24. 返される内容] {#r_OCRotation-setRosterIDs_String__table_mjr_mcb_h5} **関連資料** * [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/rcfKCSLyIXv3_lSN_0ziVA#r_OCRotationV2-getSpans "指定された開始日から指定された終了日までのスパンを取得します。開始日と終了日が指定されていない場合、開始日のデフォルトは現在の時刻の 1 か月前、終了日のデフォルトは 1 か月後になります。グループ ID、勤務表 ID、勤務表 ID、ユーザー ID を使用して、スパンをさらに細かくフィルタリングすることもできます。") ## OCRotation - setRotaIds(文字列 rotaIds) {#ariaid-title14} カレンダー上のグループの勤務表を設定します。OCRotationV2 - getSpan と組み合わせて使用します。 {#r_OCRotation-setRotaIDs_String__table_gvw_zbb_h5__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | RotaIds | 文字列 | カレンダー上のグループの勤務表。 | [表 : 25. パラメーター] {#r_OCRotation-setRotaIDs_String__table_gvw_zbb_h5} {#r_OCRotation-setRotaIDs_String__table_hvw_zbb_h5__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 26. 返される内容] {#r_OCRotation-setRotaIDs_String__table_hvw_zbb_h5} **関連資料** * [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/rcfKCSLyIXv3_lSN_0ziVA#r_OCRotationV2-getSpans "指定された開始日から指定された終了日までのスパンを取得します。開始日と終了日が指定されていない場合、開始日のデフォルトは現在の時刻の 1 か月前、終了日のデフォルトは 1 か月後になります。グループ ID、勤務表 ID、勤務表 ID、ユーザー ID を使用して、スパンをさらに細かくフィルタリングすることもできます。") ## OCRotation - setStartDate(文字列 startDate) {#ariaid-title15} オンコールカバー範囲を取得する期間の開始日を設定します。開始日が設定されていない場合、前月の初日がデフォルトで適用されます。OCRotationV2 - getSpan と組み合わせて使用します。 {#r_OCRotation-setStartDate_String__table_ivn_bjx_g5__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | startDate | 文字列 | (オプション) オンコールカバー範囲を取得する期間の開始日。 | [表 : 27. パラメーター] {#r_OCRotation-setStartDate_String__table_ivn_bjx_g5} {#r_OCRotation-setStartDate_String__table_jvn_bjx_g5__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 28. 返される内容] {#r_OCRotation-setStartDate_String__table_jvn_bjx_g5} **関連資料** * [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/rcfKCSLyIXv3_lSN_0ziVA#r_OCRotationV2-getSpans "指定された開始日から指定された終了日までのスパンを取得します。開始日と終了日が指定されていない場合、開始日のデフォルトは現在の時刻の 1 か月前、終了日のデフォルトは 1 か月後になります。グループ ID、勤務表 ID、勤務表 ID、ユーザー ID を使用して、スパンをさらに細かくフィルタリングすることもできます。") ## OCRotation - setTimezone(文字列 timezone) {#ariaid-title16} オンコールカレンダーが使用するタイムゾーンを設定します。OCRotationV2 - getSpan と組み合わせて使用します。 {#r_OCRotation-setTimezone_String__table_mpl_3mx_g5__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | タイムゾーン | 文字列 | オンコールカレンダーが使用するタイムゾーン。たとえば、\[欧州/マドリッド\] や \[米国/太平洋\]などです。 | [表 : 29. パラメーター] {#r_OCRotation-setTimezone_String__table_mpl_3mx_g5} {#r_OCRotation-setTimezone_String__table_npl_3mx_g5__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 30. 返される内容] {#r_OCRotation-setTimezone_String__table_npl_3mx_g5} **関連資料** * [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/rcfKCSLyIXv3_lSN_0ziVA#r_OCRotationV2-getSpans "指定された開始日から指定された終了日までのスパンを取得します。開始日と終了日が指定されていない場合、開始日のデフォルトは現在の時刻の 1 か月前、終了日のデフォルトは 1 か月後になります。グループ ID、勤務表 ID、勤務表 ID、ユーザー ID を使用して、スパンをさらに細かくフィルタリングすることもできます。") ## OCRotation - setUserIds(文字列 userIds) {#ariaid-title17} オンコールスケジュールのフィルタリングに使用されるユーザー sys_id (sys_user) の値のカンマ区切りリストを設定します。OCRotationV2 - getSpan と組み合わせて使用します。 {#r_OCRotation-setUserIDs_String__table_l3f_1db_h5__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | UserIds | 文字列 | オンコールスケジュールのフィルタリングに使用されるユーザー sys_id (sys_user) の値のカンマ区切りリスト。 | [表 : 31. パラメーター] {#r_OCRotation-setUserIDs_String__table_l3f_1db_h5} {#r_OCRotation-setUserIDs_String__table_m3f_1db_h5__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 32. 返される内容] {#r_OCRotation-setUserIDs_String__table_m3f_1db_h5} **関連資料** * [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/rcfKCSLyIXv3_lSN_0ziVA#r_OCRotationV2-getSpans "指定された開始日から指定された終了日までのスパンを取得します。開始日と終了日が指定されていない場合、開始日のデフォルトは現在の時刻の 1 か月前、終了日のデフォルトは 1 か月後になります。グループ ID、勤務表 ID、勤務表 ID、ユーザー ID を使用して、スパンをさらに細かくフィルタリングすることもできます。")