---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# OCRotation - Global

# OCRotation - Global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 min. de leitura

A inclusão de script OCRotation fornece métodos para criar uma estrutura de dados que é usada para exibir um calendário.

O código cria o objeto GlideAJAXSchedulePage que armazena uma lista de itens de período. Você pode usar este tipo para o calendário GWT (legado). Consulte a inclusão de script [OCRotationV2 - Global](https://servicenow-prod.fluidtopics.net/7l_Y839RzhgNgFmDmAIkjw#c_OCRotationV2 "A inclusão de script OCRotationV2 é uma extensão da inclusão de script OCRotation, que é usada pelo Fullcalendar.io e pelo calendário de plantão DHTMLX.") para outros tipos de calendário. Isso faz parte do Agendamento de plantão.

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

Cria a cobertura de plantão com base em seus grupos, escalas e escalas. É usado pelo método OCRotationV2 - getSpans.
{#r_OCRotation-buildrotas__table_bl2_jhb_h5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 1. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Vazio |   |
[Tabela 2. Retorna]

{#r_OCRotation-buildrotas__table_cl2_jhb_h5}
**Referência relacionada**   

* [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/7l_Y839RzhgNgFmDmAIkjw#r_OCRotationV2-getSpans "Obtenha os períodos da data de início especificada até a data de término especificada. Se nenhuma data de início e de término forem fornecidas, a data de início será padronizada para um mês antes e a data de término será padronizada para um mês após a hora atual. Você também pode usar os IDs de grupos, IDs de escala, IDs de listagem e IDs de usuário para filtrar ainda mais os períodos.")

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

Retorna a data de término do período para o qual você deseja recuperar a cobertura de plantão.
{#r_OCRotation-getEndDate__table_ljb_njx_g5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 3. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Data de término do período para o qual você deseja recuperar a cobertura de plantão. |
[Tabela 4. Retorna]

{#r_OCRotation-getEndDate__table_mjb_njx_g5}

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

Retorna uma lista separada por vírgulas de valores de sys_id de grupo (sys_user_group) para uma programação de plantão.
{#r_OCRotation-getGroupIDs__table_d2s_nnx_g5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 5. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Lista separada por vírgulas de valores de sys_id de grupo (sys_user_group) para uma programação de plantão. |
[Tabela 6. Retorna]

{#r_OCRotation-getGroupIDs__table_e2s_nnx_g5}

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

Retorna as escalas de acordo com as escalas selecionadas.
{#r_OCRotation-getRosterIDs__table_kcq_gcb_h5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 7. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Escalas de acordo com as escalas selecionadas. |
[Tabela 8. Retorna]

{#r_OCRotation-getRosterIDs__table_lcq_gcb_h5}

## OCRotation - getRotaGr(cadeia de caracteres rotaIds, cadeia de caracteres groupIds, cadeia de caracteres rosterIds, cadeia de caracteres userIds) {#ariaid-title6}

Retorna um GlideRecord para a tabela cmn_rota filtrada por grupos, escala, usuários e listagem.
{#r_OCRotation-getrotaGr_String_String_String_String__table_r4x_prm_45__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| rotaIds | Cadeia de caracteres | Lista separada por vírgulas de valores de sys_id de escala (cmn_rota) para uma programação de plantão. |
| groupIds | Cadeia de caracteres | Lista separada por vírgulas de valores de sys_id de grupo (sys_user_group) para uma programação de plantão. |
| rosterIds | Cadeia de caracteres | Lista separada por vírgulas de valores de sys_id de escala (cmn_rota_roster) para uma programação de plantão. |
| userIds | Cadeia de caracteres | Lista separada por vírgulas de valores de sys_id (sys_user) do usuário para uma programação de plantão. |
[Tabela 9. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| GlideRecord | Um GlideRecord para a tabela cmn_rota filtrada por grupos, escala, usuários e listagem. |
[Tabela 10. Retorna]

{#r_OCRotation-getrotaGr_String_String_String_String__table_s4x_prm_45}

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

Retorna as rotas dos grupos no seu calendário.
{#r_OCRotation-getRotaIDs__table_ycs_rbb_h5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 11. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Escalas para os grupos no seu calendário. |
[Tabela 12. Retorna]

{#r_OCRotation-getRotaIDs__table_zcs_rbb_h5}

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

Retorna a data de início do período para o qual você deseja recuperar a cobertura de plantão.
{#r_OCRotation-getStartDate__table_asg_l3r_g5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 13. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Data de início do período para o qual você deseja recuperar a cobertura de plantão. |
[Tabela 14. Retorna]

{#r_OCRotation-getStartDate__table_bsg_l3r_g5}

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

Retorna o fuso horário que o calendário de plantão usará.
{#r_OCRotation-getTimezone__table_u5g_kkx_g5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 15. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Fuso horário que o calendário de plantão usará. Por exemplo, Europa/Madrid e EUA/Pacífico. |
[Tabela 16. Retorna]

{#r_OCRotation-getTimezone__table_v5g_kkx_g5}

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

Isso filtrará os cronogramas retornados pelos usuários. Obtenha a lista separada por vírgulas de valores de sys_id (sys_user) do usuário usados para filtrar cronogramas de plantão.
{#r_OCRotation-getUserIDs__table_y3n_5cb_h5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 17. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Lista separada por vírgulas de valores de sys_id (sys_user) do usuário usados para filtrar cronogramas de plantão. |
[Tabela 18. Retorna]

{#r_OCRotation-getUserIDs__table_z3n_5cb_h5}

## OCRotation - setEndDate(cadeia de caracteres endDate, booliano inclusive) {#ariaid-title11}

Defina a data de término do período para o qual você deseja recuperar a cobertura de plantão. Se a data de término não estiver definida, o último dia do próximo mês será aplicado por padrão. Use em conjunto com OCRotationV2 - getSpans.
{#r_OCRotation-setEndDate_String_B__table_rvb_dkx_g5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| endDate | Cadeia de caracteres | \[Opcional\] Data de término da programação de plantão. |
| inclusivo | Booliano | \[Opcional\] Quando verdadeira, a data de término é incluída no intervalo de tempo. Se não for especificado, o valor padrão será verdadeiro. |
[Tabela 19. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Vazio |   |
[Tabela 20. Retorna]

{#r_OCRotation-setEndDate_String_B__table_svb_dkx_g5}
**Referência relacionada**   

* [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/7l_Y839RzhgNgFmDmAIkjw#r_OCRotationV2-getSpans "Obtenha os períodos da data de início especificada até a data de término especificada. Se nenhuma data de início e de término forem fornecidas, a data de início será padronizada para um mês antes e a data de término será padronizada para um mês após a hora atual. Você também pode usar os IDs de grupos, IDs de escala, IDs de listagem e IDs de usuário para filtrar ainda mais os períodos.")

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

Filtra os cronogramas retornados por grupos. Defina a lista separada por vírgulas de valores de sys_id de grupo (sys_user_group) para uma programação de plantão. Use em conjunto com OCRotationV2 - getSpans.
{#r_OCRotation-setGroupIDs_String__table_zkc_kbb_h5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| groupIds | Cadeia de caracteres | Lista separada por vírgulas de valores de sys_id de grupo (sys_user_group) para uma programação de plantão. |
[Tabela 21. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Vazio |   |
[Tabela 22. Retorna]

{#r_OCRotation-setGroupIDs_String__table_alc_kbb_h5}
**Referência relacionada**   

* [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/7l_Y839RzhgNgFmDmAIkjw#r_OCRotationV2-getSpans "Obtenha os períodos da data de início especificada até a data de término especificada. Se nenhuma data de início e de término forem fornecidas, a data de início será padronizada para um mês antes e a data de término será padronizada para um mês após a hora atual. Você também pode usar os IDs de grupos, IDs de escala, IDs de listagem e IDs de usuário para filtrar ainda mais os períodos.")

## OCRotation - setRosterIds(cadeia de caracteres rosterIds) {#ariaid-title13}

Define as escalas de acordo com as escalas selecionadas. Use em conjunto com OCRotationV2 - getSpans.
{#r_OCRotation-setRosterIDs_String__table_ljr_mcb_h5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| IDs da escala | Cadeia de caracteres | Escalas de acordo com as escalas selecionadas. |
[Tabela 23. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 24. Retorna]

{#r_OCRotation-setRosterIDs_String__table_mjr_mcb_h5}
**Referência relacionada**   

* [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/7l_Y839RzhgNgFmDmAIkjw#r_OCRotationV2-getSpans "Obtenha os períodos da data de início especificada até a data de término especificada. Se nenhuma data de início e de término forem fornecidas, a data de início será padronizada para um mês antes e a data de término será padronizada para um mês após a hora atual. Você também pode usar os IDs de grupos, IDs de escala, IDs de listagem e IDs de usuário para filtrar ainda mais os períodos.")

## OCRotation - setRotaIds(cadeia de caracteres rotaIds) {#ariaid-title14}

Define as rotas para os grupos no seu calendário. Use em conjunto com OCRotationV2 - getSpans.
{#r_OCRotation-setRotaIDs_String__table_gvw_zbb_h5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| RotaIds | Cadeia de caracteres | Escalas para os grupos no seu calendário. |
[Tabela 25. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Vazio |   |
[Tabela 26. Retorna]

{#r_OCRotation-setRotaIDs_String__table_hvw_zbb_h5}
**Referência relacionada**   

* [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/7l_Y839RzhgNgFmDmAIkjw#r_OCRotationV2-getSpans "Obtenha os períodos da data de início especificada até a data de término especificada. Se nenhuma data de início e de término forem fornecidas, a data de início será padronizada para um mês antes e a data de término será padronizada para um mês após a hora atual. Você também pode usar os IDs de grupos, IDs de escala, IDs de listagem e IDs de usuário para filtrar ainda mais os períodos.")

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

Define a data de início do período para o qual você deseja recuperar a cobertura de plantão. Se a data de início não estiver definida, o primeiro dia do mês anterior será aplicado por padrão. Use em conjunto com OCRotationV2 - getSpans.
{#r_OCRotation-setStartDate_String__table_ivn_bjx_g5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| startDate | Cadeia de caracteres | \[Opcional\] Data de início do período para o qual você deseja recuperar a cobertura de plantão. |
[Tabela 27. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 28. Retorna]

{#r_OCRotation-setStartDate_String__table_jvn_bjx_g5}
**Referência relacionada**   

* [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/7l_Y839RzhgNgFmDmAIkjw#r_OCRotationV2-getSpans "Obtenha os períodos da data de início especificada até a data de término especificada. Se nenhuma data de início e de término forem fornecidas, a data de início será padronizada para um mês antes e a data de término será padronizada para um mês após a hora atual. Você também pode usar os IDs de grupos, IDs de escala, IDs de listagem e IDs de usuário para filtrar ainda mais os períodos.")

## OCRotation - setTimezone(String timezone) {#ariaid-title16}

Define o fuso horário que o calendário de plantão usará. Use em conjunto com OCRotationV2 - getSpans.
{#r_OCRotation-setTimezone_String__table_mpl_3mx_g5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Fuso horário | Cadeia de caracteres | Fuso horário que o calendário de plantão usará. Por exemplo, Europa/Madrid e EUA/Pacífico. |
[Tabela 29. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Vazio |   |
[Tabela 30. Retorna]

{#r_OCRotation-setTimezone_String__table_npl_3mx_g5}
**Referência relacionada**   

* [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/7l_Y839RzhgNgFmDmAIkjw#r_OCRotationV2-getSpans "Obtenha os períodos da data de início especificada até a data de término especificada. Se nenhuma data de início e de término forem fornecidas, a data de início será padronizada para um mês antes e a data de término será padronizada para um mês após a hora atual. Você também pode usar os IDs de grupos, IDs de escala, IDs de listagem e IDs de usuário para filtrar ainda mais os períodos.")

## OCRotation - setUserIds(cadeia de caracteres userIds) {#ariaid-title17}

Define a lista separada por vírgulas de valores de sys_id (sys_user) do usuário usados para filtrar cronogramas de plantão. Use em conjunto com OCRotationV2 - getSpans.
{#r_OCRotation-setUserIDs_String__table_l3f_1db_h5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| UserIds | Cadeia de caracteres | Lista separada por vírgulas de valores de sys_id (sys_user) do usuário usados para filtrar cronogramas de plantão. |
[Tabela 31. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Vazio |   |
[Tabela 32. Retorna]

{#r_OCRotation-setUserIDs_String__table_m3f_1db_h5}
**Referência relacionada**   

* [OCRotationV2 - getSpans()](https://servicenow-prod.fluidtopics.net/7l_Y839RzhgNgFmDmAIkjw#r_OCRotationV2-getSpans "Obtenha os períodos da data de início especificada até a data de término especificada. Se nenhuma data de início e de término forem fornecidas, a data de início será padronizada para um mês antes e a data de término será padronizada para um mês após a hora atual. Você também pode usar os IDs de grupos, IDs de escala, IDs de listagem e IDs de usuário para filtrar ainda mais os períodos.")