Todos os produtos
Search
Central de documentação

DataWorks:ListCalendarVersions

Última atualização: Oct 12, 2026

Consulta as versões de um calendário de agendamento especificado.

Descrição da operação

É necessária a edição Enterprise do DataWorks.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Id

integer

Sim

O ID do calendário de agendamento.

12345

PageNumber

integer

Não

O número da página. As páginas começam em 1. Valor padrão: 1.

1

PageSize

integer

Não

O número de entradas por página. Valor padrão: 10. Valores válidos: 1 a 100.

10

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Esquema da resposta.

PagingInfo

object

As informações de paginação.

CalendarVersions

array<object>

A lista completa de versões históricas do calendário de agendamento, classificada em ordem decrescente pelo número da versão.

array<object>

O calendário de agendamento.

AllProjects

boolean

Especifica se o calendário se aplica a todos os workspaces.

true

Description

string

A descrição do calendário de agendamento.

Weekday scheduling calendar

EndDate

string

A data de término do período de validade do calendário, no formato yyyy-mm-dd. Este parâmetro é retornado apenas para calendários com restrição forte.

2026-10-09

ExpirationReminder

string

O lembrete de expiração. Este parâmetro é retornado apenas para calendários com restrição forte. Valores válidos:

  • OneMonthBefore: Um mês de antecedência.

  • OneWeekBefore: Uma semana de antecedência.

  • ThreeDaysBefore: Três dias de antecedência.

Valores válidos:

  • OneMonthBefore :

    Um mês de antecedência.

  • ThreeDaysBefore :

    Três dias de antecedência.

  • OneWeekBefore :

    Uma semana de antecedência.

OneMonthBefore

FallbackPolicy

string

A política de agendamento padrão para datas não especificadas. Este parâmetro é retornado apenas para calendários com restrição fraca. Valores válidos:

  • Normal: Agendamento normal.

  • Pause: Pausar agendamento.

  • Skip: Dry run.

Valores válidos:

  • Pause :

    Pausar agendamento.

  • Skip :

    Dry run.

  • Normal :

    Agendamento normal.

Normal

Id

integer

O ID do calendário de agendamento.

12345

ModifyTime

integer

A hora em que o calendário foi modificado. O valor é um carimbo de data/hora UNIX em milissegundos.

1640000000000

Name

string

O nome do calendário de agendamento.

work_calendar

OverduePolicy

string

A política de agendamento após a expiração do calendário. Este parâmetro é retornado apenas para calendários com restrição forte. Valores válidos:

  • Normal: Agendamento normal.

  • Pause: Pausar agendamento.

  • Skip: Dry run.

Valores válidos:

  • Pause :

    Pausar agendamento.

  • Skip :

    Dry run.

  • Normal :

    Agendamento normal.

Skip

Owner

string

O ID da conta do proprietário.

123456789

ProjectIds

array

A lista de IDs dos workspaces aplicáveis. Um array vazio é retornado se AllProjects estiver definido como true.

integer

O ID do workspace.

1000

SchedulePolicy

object

A política de agendamento de datas.

NormalDates

array

A lista de datas de agendamento normal.

string

A data de agendamento normal, no formato yyyy-mm-dd.

2026-10-08

SkipDates

array

A lista de datas de não agendamento. As tarefas realizam dry runs nessas datas.

string

A data de não agendamento, no formato yyyy-mm-dd.

2026-10-08

StartDate

string

A data de início do período de validade do calendário, no formato yyyy-mm-dd. Este parâmetro é retornado apenas para calendários com restrição forte.

2026-10-08

Type

string

O tipo de calendário. Valores válidos:

  • StrongConstraint: Calendário com restrição forte.

  • WeakConstraint: Calendário com restrição fraca.

Valores válidos:

  • WeakConstraint :

    Calendário com restrição fraca.

  • StrongConstraint :

    Calendário com restrição forte.

StrongConstraint

Version

integer

O número da versão.

1

PageNumber

integer

O número da página.

1

PageSize

integer

O número de entradas por página.

10

TotalCount

integer

O número total de entradas.

10

RequestId

string

O ID da solicitação.

6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Exemplos

Resposta de sucesso

JSON formato

{
  "PagingInfo": {
    "CalendarVersions": [
      {
        "AllProjects": true,
        "Description": "Weekday scheduling calendar",
        "EndDate": "2026-10-09",
        "ExpirationReminder": "OneMonthBefore",
        "FallbackPolicy": "Normal",
        "Id": 12345,
        "ModifyTime": 1640000000000,
        "Name": "work_calendar",
        "OverduePolicy": "Skip",
        "Owner": "123456789",
        "ProjectIds": [
          1000
        ],
        "SchedulePolicy": {
          "NormalDates": [
            "2026-10-08"
          ],
          "SkipDates": [
            "2026-10-08"
          ]
        },
        "StartDate": "2026-10-08",
        "Type": "StrongConstraint",
        "Version": 1
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 10
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.