---
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


---

# OCRotationV2 - Global

# OCRotationV2 - Global {#ariaid-title1}

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

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.

Use esta inclusão de script para obter o intervalo de tempo da programação entre duas datas que são filtradas por grupos, rotas, escalas e usuários. Você também pode estender o OCRotationV2 para adicionar ou modificar o comportamento. Isso faz parte do Agendamento de plantão.

## OCRotationV2 - getGroups() {#ariaid-title2}

Retorna uma matriz de grupos que têm rotas ativas.
{#r_OCRotationV2-getGroups__table_ozg_nlb_h5__entry__3}

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

{#r_OCRotationV2-getGroups__table_ozg_nlb_h5} {#r_OCRotationV2-getGroups__table_pzg_nlb_h5__entry__2}

| Tipo | Descrição |
|-|-|
| Matriz | Uma matriz de objetos de grupo. Cada um contém os seguintes atributos: * sys_id do registro sys_user_group * nome do registro sys_user_group {#r_OCRotationV2-getGroups__ul_brf_31x_55} |
[Tabela 2. Retorna]

{#r_OCRotationV2-getGroups__table_pzg_nlb_h5}

## OCRotationV2 -- getRostersByRotas(cadeia de caracteres rotaSysIds) {#ariaid-title3}

Retorna uma matriz de escalas ativas para um determinado ID de escala.
{#r_OCRotationV2-getRostersByRotas_String__table_y14_1mb_h5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| rotaSysIds | Cadeia de caracteres | Lista separada por vírgulas de valores de sys_id de escala (cmn_rota). |
[Tabela 3. Parâmetros]

{#r_OCRotationV2-getRostersByRotas_String__table_y14_1mb_h5} {#r_OCRotationV2-getRostersByRotas_String__table_z14_1mb_h5__entry__2}

| Tipo | Descrição |
|-|-|
| Matriz | Uma matriz de objetos de escala. Cada um contém os seguintes atributos: * sys_id do registro cmn_rota_roster * nome do registro cmn_rota_roster * rota sys_id do registro cmn_rota {#r_OCRotationV2-getRostersByRotas_String__ul_svs_y1x_55} |
[Tabela 4. Retorna]

{#r_OCRotationV2-getRostersByRotas_String__table_z14_1mb_h5}

## OCRotationV2 -- getRotasByGroup(cadeia de caracteres groupSysIds) {#ariaid-title4}

Retorna uma matriz de rotas ativas para um determinado ID de grupo.
{#r_OCRotationV2-getRotasByGroup_String__table_jcg_xlb_h5__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| groupSysIds | Cadeia de caracteres | Lista separada por vírgulas de valores de sys_id de grupo (sys_user_group). |
[Tabela 5. Parâmetros]

{#r_OCRotationV2-getRotasByGroup_String__table_jcg_xlb_h5} {#r_OCRotationV2-getRotasByGroup_String__table_kcg_xlb_h5__entry__2}

| Tipo | Descrição |
|-|-|
| Matriz | Uma matriz de objetos de escala. Cada um contém os seguintes atributos: * sys_id do registro cmn_rota * nome do registro cmn_rota * sys_id do grupo do registro sys_user_group {#r_OCRotationV2-getRotasByGroup_String__ul_plv_p1x_55} |
[Tabela 6. Retorna]

{#r_OCRotationV2-getRotasByGroup_String__table_kcg_xlb_h5}

## OCRotationV2 - getSpans() {#ariaid-title5}

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.
{#r_OCRotationV2-getSpans__table_j24_jlb_h5__entry__3}

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

{#r_OCRotationV2-getSpans__table_j24_jlb_h5} {#r_OCRotationV2-getSpans__table_k24_jlb_h5__entry__2}

| Tipo | Descrição |
|-|-|
| Matriz | Uma matriz de períodos. Cada um contém os seguintes atributos: id, sys_id, table, rota_id, roster_id, user_id, text, description, color, textColor, start_date, end_date. |
[Tabela 8. Retorna]

{#r_OCRotationV2-getSpans__table_k24_jlb_h5}  
Obter todos os períodos para o período padrão

    var spans = new OCRotationV2().getSpans();
    var firstSpanStartDate = spans[0].start_date; // get the first span's start date

Obter todos os períodos entre 1º de abril de 2014 e 5 de junho de 2014

    var spans = new OCRotationV2()
        .setStartDate("2014-04-01")
        .setEndDate("2014-06-05")
        .getSpans();

Obter períodos do grupo de rede para o período padrão

    var spans = new OCRotationV2()
         .setGroupIds("287ebd7da9fe198100f92cc8d1d2154e")
         .getSpans();

Obter períodos do usuário da ITIL entre 1º de janeiro de 2014 e 31 de janeiro de 2014

    var spans = new OCRotationV2()
        .setStartDate("2014-01-01")
        .setEndDate("2014-01-31")
        .setUserIds("681b365ec0a80164000fb0b05854a0cd")
        .getSpans();