Todos os produtos
Search

Este produto

    DataWorks:CreateCalendar

    Central de documentação

    DataWorks:CreateCalendar

    Última atualização: Oct 12, 2026

    Cria um calendário de agendamento.

    Descrição da operação

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

    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
    Name

    string

    Sim

    O nome do calendário de agendamento. O nome deve ser exclusivo no locatário atual e pode ter até 100 caracteres.

    work_calendar
    AllProjects

    boolean

    Não

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

    • true: todos os workspaces.

    • false: os workspaces especificados por ProjectIds.

    true
    ProjectIds

    array

    Não

    A lista de IDs dos workspaces aplicáveis.

    • Se AllProjects estiver definido como false ou deixado vazio: este parâmetro é obrigatório e não pode estar vazio.

    • Se AllProjects estiver definido como true: deixe este parâmetro vazio ou passe um array vazio.

    integer

    Não

    O ID do workspace.

    1000
    Type

    string

    Sim

    O tipo do calendário.

    • 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. Formato: yyyy-mm-dd. Este parâmetro é obrigatório quando Type está definido como StrongConstraint.

    2026-10-08
    EndDate

    string

    Não

    A data de término do período de validade do calendário. Formato: yyyy-mm-dd. Este parâmetro é obrigatório quando Type está 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. Este parâmetro é obrigatório quando Type está definido como StrongConstraint.

    • 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. Este parâmetro é obrigatório quando Type está definido como StrongConstraint.

    • 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. 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. Este parâmetro é usado apenas para calendários de restrição forte.

    string

    Não

    A data de não agendamento. 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. Este parâmetro é obrigatório quando Type está definido como WeakConstraint.

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

    Weekday scheduling calendar

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Esquema da resposta.

    Id

    integer

    O ID do calendário de agendamento.

    12345
    RequestId

    string

    O ID da solicitação.

    6A6CBE87-9F91-1323-B680-E7A7065XXXXX

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "Id": 12345,
  "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.