---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# OCRotation : globale

# OCRotation : globale {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 minutes de lecture

L'include de script OCRotation fournit des méthodes pour construire une structure de données utilisée pour afficher un calendrier.

Le code génère l'objet GlideAJAXSchedulePage qui stocke une liste d'éléments de parcours. Vous pouvez utiliser ce type pour le calendrier Gwt (hérité). Consultez l'include de [OCRotationV2 - Global](https://servicenow-prod.fluidtopics.net/s43k8k4gRjZWlbAfJ2QA2g#c_OCRotationV2 "L’include de script OCRotationV2 est une extension de l’include de script OCRotation , qui est utilisé par Fullcalendar.io et le calendrier d’astreinte DHTMLX.") script pour les autres types de calendrier. Cela fait partie de la planification d'astreinte.

## OCRotation : buildRotas() {#ariaid-title2}

Crée la couverture d'astreinte en fonction de vos groupes, rotations et listes. Ceci est utilisé par la méthode OCRotationV2 - getSpans.
{#r_OCRotation-buildrotas__table_bl2_jhb_h5__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 1. Paramètres]

{#r_OCRotation-buildrotas__table_bl2_jhb_h5} {#r_OCRotation-buildrotas__table_cl2_jhb_h5__entry__2}

| Type | Description |
|-|-|
| Nul |   |
[Tableau 2. Renvoie]

{#r_OCRotation-buildrotas__table_cl2_jhb_h5}
**Référence associée**   

* [OCRotationV2 : getSpans()](https://servicenow-prod.fluidtopics.net/s43k8k4gRjZWlbAfJ2QA2g#r_OCRotationV2-getSpans "Obtenez les parcours entre la date de début spécifiée et la date de fin spécifiée. Si aucune date de début et de fin n’est fournie, la date de début est par défaut un mois avant et la date de fin par défaut est un mois après l’heure actuelle. Vous pouvez également utiliser les ID de groupes, les ID de rotation, les ID de listes, les ID d’utilisateurs pour filtrer davantage les parcours.")

## OCRotation : getEndDate() {#ariaid-title3}

Renvoie la date de fin de la période pour laquelle vous souhaitez récupérer la couverture d'astreinte.
{#r_OCRotation-getEndDate__table_ljb_njx_g5__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 3. Paramètres]

{#r_OCRotation-getEndDate__table_ljb_njx_g5} {#r_OCRotation-getEndDate__table_mjb_njx_g5__entry__2}

| Type | Description |
|-|-|
| Chaîne | Date de fin de la période pour laquelle vous souhaitez récupérer la couverture d'astreinte. |
[Tableau 4. Renvoie]

{#r_OCRotation-getEndDate__table_mjb_njx_g5}

## OCRotation : getGroupIds() {#ariaid-title4}

Renvoie une liste séparée par des virgules de valeurs de sys_id de groupe (sys_user_group) pour un calendrier d'astreinte.
{#r_OCRotation-getGroupIDs__table_d2s_nnx_g5__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 5. Paramètres]

{#r_OCRotation-getGroupIDs__table_d2s_nnx_g5} {#r_OCRotation-getGroupIDs__table_e2s_nnx_g5__entry__2}

| Type | Description |
|-|-|
| Chaîne | Liste séparée par des virgules de valeurs de sys_id de groupe (sys_user_group) pour une planification d'astreinte. |
[Tableau 6. Renvoie]

{#r_OCRotation-getGroupIDs__table_e2s_nnx_g5}

## OCRotation : getRosterIds() {#ariaid-title5}

Renvoie les listes en fonction des rotations sélectionnées.
{#r_OCRotation-getRosterIDs__table_kcq_gcb_h5__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 7. Paramètres]

{#r_OCRotation-getRosterIDs__table_kcq_gcb_h5} {#r_OCRotation-getRosterIDs__table_lcq_gcb_h5__entry__2}

| Type | Description |
|-|-|
| Chaîne | Listes en fonction des rotations sélectionnées. |
[Tableau 8. Renvoie]

{#r_OCRotation-getRosterIDs__table_lcq_gcb_h5}

## OCRotation : getRotaGr(String rotaIds, String groupIds, String rosterIds, String userIds) {#ariaid-title6}

Renvoie un GlideRecord pour la table de cmn_rota filtrée par groupes, rotation, utilisateurs et liste.
{#r_OCRotation-getrotaGr_String_String_String_String__table_r4x_prm_45__entry__3}

| Nom | Type | Description |
|-|-|-|
| rotaIds | Chaîne | Liste séparée par des virgules de valeurs de sys_id de rotation (cmn_rota) pour un calendrier d'astreinte. |
| groupIds | Chaîne | Liste séparée par des virgules de valeurs de sys_id de groupe (sys_user_group) pour une planification d'astreinte. |
| rosterIds | Chaîne | Liste séparée par des virgules des valeurs de sys_id de liste (cmn_rota_roster) pour un calendrier d'astreinte. |
| userIds | Chaîne | Liste séparée par des virgules de valeurs de sys_id d'utilisateur (sys_user) pour une planification d'astreinte. |
[Tableau 9. Paramètres]

{#r_OCRotation-getrotaGr_String_String_String_String__table_r4x_prm_45} {#r_OCRotation-getrotaGr_String_String_String_String__table_s4x_prm_45__entry__2}

| Type | Description |
|-|-|
| GlideRecord | Un GlideRecord pour la table de cmn_rota filtrée par groupes, rotation, utilisateurs et liste. |
[Tableau 10. Renvoie]

{#r_OCRotation-getrotaGr_String_String_String_String__table_s4x_prm_45}

## OCRotation : getRotaIds() {#ariaid-title7}

Renvoie les rotations pour les groupes de votre calendrier.
{#r_OCRotation-getRotaIDs__table_ycs_rbb_h5__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 11. Paramètres]

{#r_OCRotation-getRotaIDs__table_ycs_rbb_h5} {#r_OCRotation-getRotaIDs__table_zcs_rbb_h5__entry__2}

| Type | Description |
|-|-|
| Chaîne | Rotations pour les groupes de votre calendrier. |
[Tableau 12. Renvoie]

{#r_OCRotation-getRotaIDs__table_zcs_rbb_h5}

## OCRotation : getStartDate() {#ariaid-title8}

Renvoie la date de début de la période pour laquelle vous souhaitez récupérer la couverture d'astreinte.
{#r_OCRotation-getStartDate__table_asg_l3r_g5__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 13. Paramètres]

{#r_OCRotation-getStartDate__table_asg_l3r_g5} {#r_OCRotation-getStartDate__table_bsg_l3r_g5__entry__2}

| Type | Description |
|-|-|
| Chaîne | Date de début de la période pour laquelle vous souhaitez récupérer la couverture d'astreinte. |
[Tableau 14. Renvoie]

{#r_OCRotation-getStartDate__table_bsg_l3r_g5}

## OCRotation : getTimezone() {#ariaid-title9}

Renvoie le fuseau horaire que votre calendrier d'astreinte utilisera.
{#r_OCRotation-getTimezone__table_u5g_kkx_g5__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 15. Paramètres]

{#r_OCRotation-getTimezone__table_u5g_kkx_g5} {#r_OCRotation-getTimezone__table_v5g_kkx_g5__entry__2}

| Type | Description |
|-|-|
| Chaîne | Fuseau horaire que votre calendrier d'astreinte utilisera. Par exemple, Europe/Madrid et États-Unis/Pacifique. |
[Tableau 16. Renvoie]

{#r_OCRotation-getTimezone__table_v5g_kkx_g5}

## OCRotation : getUserIDs() {#ariaid-title10}

Cela filtrera les calendriers renvoyés par les utilisateurs. Obtenir la liste séparée par des virgules des valeurs de sys_id d'utilisateur (sys_user) utilisées pour filtrer les calendriers d'astreinte.
{#r_OCRotation-getUserIDs__table_y3n_5cb_h5__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 17. Paramètres]

{#r_OCRotation-getUserIDs__table_y3n_5cb_h5} {#r_OCRotation-getUserIDs__table_z3n_5cb_h5__entry__2}

| Type | Description |
|-|-|
| Chaîne | Liste séparée par des virgules des valeurs de sys_id d'utilisateur (sys_user) utilisées pour filtrer les calendriers d'astreinte. |
[Tableau 18. Renvoie]

{#r_OCRotation-getUserIDs__table_z3n_5cb_h5}

## OCRotation : setEndDate(String endDate, booléen inclus) {#ariaid-title11}

Définissez la date de fin de la période pour laquelle vous souhaitez récupérer la couverture d'astreinte. Si la date de fin n'est pas définie, le dernier jour du mois suivant est appliqué par défaut. À utiliser en conjonction avec OCRotationV2 - getSpans.
{#r_OCRotation-setEndDate_String_B__table_rvb_dkx_g5__entry__3}

| Nom | Type | Description |
|-|-|-|
| endDate | Chaîne | \[Facultatif\] Date de fin du calendrier d'astreinte. |
| inclusif | Booléen | \[Facultatif\] Si la valeur est vraie, la date de fin est incluse dans l'intervalle de temps. Si cette valeur n'est pas spécifiée, cette valeur est définie par défaut sur vrai. |
[Tableau 19. Paramètres]

{#r_OCRotation-setEndDate_String_B__table_rvb_dkx_g5} {#r_OCRotation-setEndDate_String_B__table_svb_dkx_g5__entry__2}

| Type | Description |
|-|-|
| Nul |   |
[Tableau 20. Renvoie]

{#r_OCRotation-setEndDate_String_B__table_svb_dkx_g5}
**Référence associée**   

* [OCRotationV2 : getSpans()](https://servicenow-prod.fluidtopics.net/s43k8k4gRjZWlbAfJ2QA2g#r_OCRotationV2-getSpans "Obtenez les parcours entre la date de début spécifiée et la date de fin spécifiée. Si aucune date de début et de fin n’est fournie, la date de début est par défaut un mois avant et la date de fin par défaut est un mois après l’heure actuelle. Vous pouvez également utiliser les ID de groupes, les ID de rotation, les ID de listes, les ID d’utilisateurs pour filtrer davantage les parcours.")

## OCRotation : setGroupIds(String groupIds) {#ariaid-title12}

Filtre les renvois de calendriers par groupes. Définissez une liste séparée par des virgules de valeurs de sys_id de groupe (sys_user_group) pour un calendrier d'astreinte. À utiliser en conjonction avec OCRotationV2 - getSpans.
{#r_OCRotation-setGroupIDs_String__table_zkc_kbb_h5__entry__3}

| Nom | Type | Description |
|-|-|-|
| groupIds | Chaîne | Liste séparée par des virgules de valeurs de sys_id de groupe (sys_user_group) pour une planification d'astreinte. |
[Tableau 21. Paramètres]

{#r_OCRotation-setGroupIDs_String__table_zkc_kbb_h5} {#r_OCRotation-setGroupIDs_String__table_alc_kbb_h5__entry__2}

| Type | Description |
|-|-|
| Nul |   |
[Tableau 22. Renvoie]

{#r_OCRotation-setGroupIDs_String__table_alc_kbb_h5}
**Référence associée**   

* [OCRotationV2 : getSpans()](https://servicenow-prod.fluidtopics.net/s43k8k4gRjZWlbAfJ2QA2g#r_OCRotationV2-getSpans "Obtenez les parcours entre la date de début spécifiée et la date de fin spécifiée. Si aucune date de début et de fin n’est fournie, la date de début est par défaut un mois avant et la date de fin par défaut est un mois après l’heure actuelle. Vous pouvez également utiliser les ID de groupes, les ID de rotation, les ID de listes, les ID d’utilisateurs pour filtrer davantage les parcours.")

## OCRotation : setRosterIds(String rosterIds) {#ariaid-title13}

Définit les listes en fonction des rotations sélectionnées. À utiliser en conjonction avec OCRotationV2 - getSpans.
{#r_OCRotation-setRosterIDs_String__table_ljr_mcb_h5__entry__3}

| Nom | Type | Description |
|-|-|-|
| ID de liste | Chaîne | Listes en fonction des rotations sélectionnées. |
[Tableau 23. Paramètres]

{#r_OCRotation-setRosterIDs_String__table_ljr_mcb_h5} {#r_OCRotation-setRosterIDs_String__table_mjr_mcb_h5__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 24. Renvoie]

{#r_OCRotation-setRosterIDs_String__table_mjr_mcb_h5}
**Référence associée**   

* [OCRotationV2 : getSpans()](https://servicenow-prod.fluidtopics.net/s43k8k4gRjZWlbAfJ2QA2g#r_OCRotationV2-getSpans "Obtenez les parcours entre la date de début spécifiée et la date de fin spécifiée. Si aucune date de début et de fin n’est fournie, la date de début est par défaut un mois avant et la date de fin par défaut est un mois après l’heure actuelle. Vous pouvez également utiliser les ID de groupes, les ID de rotation, les ID de listes, les ID d’utilisateurs pour filtrer davantage les parcours.")

## OCRotation : setRotaIds(String rotaIds) {#ariaid-title14}

Définit les rotations pour les groupes de votre calendrier. À utiliser en conjonction avec OCRotationV2 - getSpans.
{#r_OCRotation-setRotaIDs_String__table_gvw_zbb_h5__entry__3}

| Nom | Type | Description |
|-|-|-|
| RotaIds | Chaîne | Rotations pour les groupes de votre calendrier. |
[Tableau 25. Paramètres]

{#r_OCRotation-setRotaIDs_String__table_gvw_zbb_h5} {#r_OCRotation-setRotaIDs_String__table_hvw_zbb_h5__entry__2}

| Type | Description |
|-|-|
| Nul |   |
[Tableau 26. Renvoie]

{#r_OCRotation-setRotaIDs_String__table_hvw_zbb_h5}
**Référence associée**   

* [OCRotationV2 : getSpans()](https://servicenow-prod.fluidtopics.net/s43k8k4gRjZWlbAfJ2QA2g#r_OCRotationV2-getSpans "Obtenez les parcours entre la date de début spécifiée et la date de fin spécifiée. Si aucune date de début et de fin n’est fournie, la date de début est par défaut un mois avant et la date de fin par défaut est un mois après l’heure actuelle. Vous pouvez également utiliser les ID de groupes, les ID de rotation, les ID de listes, les ID d’utilisateurs pour filtrer davantage les parcours.")

## OCRotation : setStartDate(String startDate) {#ariaid-title15}

Définit la date de début de la période pour laquelle vous souhaitez récupérer la couverture d'astreinte. Si la date de début n'est pas définie, le premier jour du mois précédent est appliqué par défaut. À utiliser en conjonction avec OCRotationV2 - getSpans.
{#r_OCRotation-setStartDate_String__table_ivn_bjx_g5__entry__3}

| Nom | Type | Description |
|-|-|-|
| startDate | Chaîne | \[Facultatif\] Date de début de la période pour laquelle vous souhaitez récupérer la couverture d'astreinte. |
[Tableau 27. Paramètres]

{#r_OCRotation-setStartDate_String__table_ivn_bjx_g5} {#r_OCRotation-setStartDate_String__table_jvn_bjx_g5__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 28. Renvoie]

{#r_OCRotation-setStartDate_String__table_jvn_bjx_g5}
**Référence associée**   

* [OCRotationV2 : getSpans()](https://servicenow-prod.fluidtopics.net/s43k8k4gRjZWlbAfJ2QA2g#r_OCRotationV2-getSpans "Obtenez les parcours entre la date de début spécifiée et la date de fin spécifiée. Si aucune date de début et de fin n’est fournie, la date de début est par défaut un mois avant et la date de fin par défaut est un mois après l’heure actuelle. Vous pouvez également utiliser les ID de groupes, les ID de rotation, les ID de listes, les ID d’utilisateurs pour filtrer davantage les parcours.")

## OCRotation : setTimezone(String fuseau horaire) {#ariaid-title16}

Définit le fuseau horaire que votre calendrier d'astreinte utilisera. À utiliser en conjonction avec OCRotationV2 - getSpans.
{#r_OCRotation-setTimezone_String__table_mpl_3mx_g5__entry__3}

| Nom | Type | Description |
|-|-|-|
| Fuseau horaire | Chaîne | Fuseau horaire que votre calendrier d'astreinte utilisera. Par exemple, Europe/Madrid et États-Unis/Pacifique. |
[Tableau 29. Paramètres]

{#r_OCRotation-setTimezone_String__table_mpl_3mx_g5} {#r_OCRotation-setTimezone_String__table_npl_3mx_g5__entry__2}

| Type | Description |
|-|-|
| Nul |   |
[Tableau 30. Renvoie]

{#r_OCRotation-setTimezone_String__table_npl_3mx_g5}
**Référence associée**   

* [OCRotationV2 : getSpans()](https://servicenow-prod.fluidtopics.net/s43k8k4gRjZWlbAfJ2QA2g#r_OCRotationV2-getSpans "Obtenez les parcours entre la date de début spécifiée et la date de fin spécifiée. Si aucune date de début et de fin n’est fournie, la date de début est par défaut un mois avant et la date de fin par défaut est un mois après l’heure actuelle. Vous pouvez également utiliser les ID de groupes, les ID de rotation, les ID de listes, les ID d’utilisateurs pour filtrer davantage les parcours.")

## OCRotation : setUserIds(String userIds) {#ariaid-title17}

Définit la liste séparée par des virgules des valeurs de sys_id d'utilisateur (sys_user) utilisées pour filtrer les calendriers d'astreinte. À utiliser en conjonction avec OCRotationV2 - getSpans.
{#r_OCRotation-setUserIDs_String__table_l3f_1db_h5__entry__3}

| Nom | Type | Description |
|-|-|-|
| UserIds | Chaîne | Liste séparée par des virgules des valeurs de sys_id d'utilisateur (sys_user) utilisées pour filtrer les calendriers d'astreinte. |
[Tableau 31. Paramètres]

{#r_OCRotation-setUserIDs_String__table_l3f_1db_h5} {#r_OCRotation-setUserIDs_String__table_m3f_1db_h5__entry__2}

| Type | Description |
|-|-|
| Nul |   |
[Tableau 32. Renvoie]

{#r_OCRotation-setUserIDs_String__table_m3f_1db_h5}
**Référence associée**   

* [OCRotationV2 : getSpans()](https://servicenow-prod.fluidtopics.net/s43k8k4gRjZWlbAfJ2QA2g#r_OCRotationV2-getSpans "Obtenez les parcours entre la date de début spécifiée et la date de fin spécifiée. Si aucune date de début et de fin n’est fournie, la date de début est par défaut un mois avant et la date de fin par défaut est un mois après l’heure actuelle. Vous pouvez également utiliser les ID de groupes, les ID de rotation, les ID de listes, les ID d’utilisateurs pour filtrer davantage les parcours.")