Obtém a configuração atual de um calendário de agendamento especificado.
Descrição da operação
A edição Enterprise do DataWorks é necessária para usar esta API.
Experimente agora
Testar
Autorização RAM
Sintaxe da solicitação
POST HTTP/1.1Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| Id |
integer |
Sim |
O ID do calendário de agendamento. |
12345 |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Esquema da resposta. |
||
| Calendar |
object |
A configuração completa atual do 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 |
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:\n- OneMonthBefore: Um mês de antecedência.\n- OneWeekBefore: Uma semana de antecedência.\n- ThreeDaysBefore: Três dias de antecedência. Valores válidos:
|
OneMonthBefore |
| FallbackPolicy |
string |
A política de agendamento padrão para datas que não estão configuradas. Este parâmetro é retornado apenas para calendários com restrição fraca. Valores válidos:\n- Normal: Agendamento normal.\n- Pause: Pausar agendamento.\n- Skip: Dry run. Valores válidos:
|
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:\n- Normal: Agendamento normal.\n- Pause: Pausar agendamento.\n- Skip: Dry run. Valores válidos:
|
Skip |
| Owner |
string |
O ID da conta do proprietário. |
123456789 |
| ProjectIds |
array |
A lista de IDs dos workspaces aplicáveis. Uma matriz vazia é retornada 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 |
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 |
2026-10-08 |
|
| StartDate |
string |
A data de início do período de validade do calendário, no formato |
2026-10-08 |
| Type |
string |
O tipo de calendário. Valores válidos:\n- StrongConstraint: Calendário com restrição forte.\n- WeakConstraint: Calendário com restrição fraca. Valores válidos:
|
StrongConstraint |
| Version |
integer |
O número da versão. |
1 |
| RequestId |
string |
O ID da solicitação. |
6A6CBE87-9F91-1323-B680-E7A7065XXXXX |
Exemplos
Resposta de sucesso
JSON formato
{
"Calendar": {
"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
},
"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.