Todos os produtos
Search

Este produto

    DataWorks:UpdateCalendar

    Central de documentação

    DataWorks:UpdateCalendar

    Última atualização: Oct 12, 2026

    Atualiza um calendário de agendamento. Esta é uma atualização completa que exige o envio da configuração editável completa.

    Descrição da operação

    Você deve adquirir o DataWorks Enterprise Edition para usar este recurso.

    O nome do calendário não pode ser modificado. As datas não enviadas não são retidas.

    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
    AllProjects

    boolean

    Não

    Especifica se o calendário se aplica a todos os workspaces. Valor padrão: false. Valores válidos:

    • true: Todos os workspaces.

    • false: Os workspaces especificados por ProjectIds.

    true
    ProjectIds

    array

    Não

    A lista de IDs dos workspaces aplicáveis.

    • Obrigatório e não pode estar vazio quando AllProjects é definido como false ou deixado sem especificação.

    • Deixe vazio ou passe um array vazio quando AllProjects é definido como true.

    integer

    Não

    O ID do workspace.

    1000
    Type

    string

    Sim

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

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

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

    Valores válidos:

    • WeakConstraint :

      Calendário de restrição fraca.

    • StrongConstraint :

      Calendário de restrição forte.

    StrongConstraint
    StartDate

    string

    Não

    A data de início do período de validade do calendário, no formato yyyy-mm-dd. Obrigatório quando Type é definido como StrongConstraint.

    2026-10-08
    EndDate

    string

    Não

    A data de término do período de validade do calendário, no formato yyyy-mm-dd. Obrigatório quando Type é definido como StrongConstraint. A data de término não pode ser anterior à data de início, e o intervalo entre a data de início e a data de término deve ser inferior a 5 anos.

    2026-10-09
    ExpirationReminder

    string

    Não

    O lembrete de expiração. Obrigatório quando Type é definido como StrongConstraint. 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
    OverduePolicy

    string

    Não

    A política de agendamento após a expiração do calendário. Obrigatório quando Type é definido como StrongConstraint. 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
    SchedulePolicy

    object

    Sim

    A política de agendamento de datas. Para um calendário de restrição forte, as datas de agendamento normal e as datas de não agendamento devem cobrir todos os dias dentro do período de validade e não podem se sobrepor.

    NormalDates

    array

    Não

    A lista de datas de agendamento normal.

    string

    Não

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

    2026-10-08
    SkipDates

    array

    Não

    A lista de datas de não agendamento. As tarefas realizam dry runs nessas datas. Usado apenas para calendários de restrição forte.

    string

    Não

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

    2026-10-08
    FallbackPolicy

    string

    Não

    A política de agendamento padrão para datas que não estão configuradas. Obrigatório quando Type é definido como WeakConstraint. 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
    Owner

    string

    Sim

    O ID da conta do proprietário.

    123456789
    Description

    string

    Sim

    A descrição do calendário de agendamento. A descrição deve ter de 5 a 2.048 caracteres de comprimento.

    Weekday scheduling calendar

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Esquema da resposta.

    RequestId

    string

    O ID da solicitação.

    6A6CBE87-9F91-1323-B680-E7A7065XXXXX
    Version

    integer

    O número da versão atualizada.

    2

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX",
  "Version": 2
}

    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.