Pontos de extremidade de agendamentos

Pontos de extremidade de agendamentos e parâmetros

Para saber mais sobre as relações de objetos e como usá-las na API, vá para a seção Relações de objeto.

Para obter mais informações sobre os fusos horários válidos que você pode inserir ao usar os pontos de extremidade de agendamento GET e PUT, vá para Fusos horários.

Para obter mais informações sobre agendamentos, visite a página de ajuda Agendamentos: interface de administrador.

Criar um novo agendamento

Para criar um novo agendamento, use o ponto de extremidade POST {baseURL}/v3/schedules.

Nota

Todos os usuários (incluindo administradores) só podem criar um agendamento para um fluxo de trabalho ao qual têm acesso e permissão, seja por meio de permissões de estúdio ou de coleção.

Se "timeZone" estiver vazio ou tiver sido ignorado, todos os campos de data/hora corresponderão ao fuso horário UTC-0. Se "timeZone" for especificado, todos os campos de data/hora corresponderão ao fuso horário especificado. Para exibir a lista de fusos horários válidos, acesse Fusos horários.

Parâmetros

contract (corpo): para criar um novo agendamento, o parâmetro "contract" é obrigatório. Especifique os seguintes parâmetros:
- workflowId (cadeia de caracteres): insira um ID de fluxo de trabalho que você deseja agendar.
- iteration (corpo):
  - iterationType (cadeia de caracteres (string)): especifique se o fluxo de trabalho será agendado "Once" (uma vez), "Hourly" (de hora em hora), "Daily" (diariamente), "Weekly" (semanalmente), "Monthly" (mensalmente), "Custom" (personalizado) e "Cron" (cronológico). Lembre-se de especificar a frequência como horária (hourlyContract), diária (dailyContract), semanal (weeklyContract), mensal (monthlyContract), personalizada (customContract) ou cronológica (cronContract) para o respectivo tipo de iteração. Para obter mais informações, visite a página de ajuda Agendar um fluxo de trabalho.
  - startTime (cadeia de caracteres): obrigatório. Insira uma data e hora específicas para a execução do fluxo de trabalho. A data de início precisa estar no futuro.
  - endTime (cadeia de caracteres): opcional. Insira a data e a hora específicas em que a execução do fluxo de trabalho deve terminar.
  - hourlyContract (corpo): opcional. Use se você especificou o iterationType como "Hourly" (de hora em hora).
    hours (cadeia de caracteres): insira a hora.
    minutes (cadeia de caracteres): insira os minutos.
  - dailyContract (corpo): opcional. Use se você especificou o iterationType como "Daily" (diariamente).
    runOnlyWorkWeek (booleano): opcional. Se não especificado, o padrão é "false" (falso).
  - weeklyContract (corpo): opcional. Use se você especificou o iterationType como "Weekly" (semanalmente).
    daysOfWeek (cadeia de caracteres): especifique o dia da semana em que o fluxo de trabalho deve ser executado. Por exemplo, "Sunday" (domingo).
  - monthlyContract (corpo): opcional. Use se você especificou o iterationType como "Monthly" (mensalmente).
    simpleDayOfMonth (booleano): insira "true" (verdadeiro) se deseja especificar um dia do mês em que o fluxo de trabalho deve ser executado.
    dayOfMonth (cadeia de caracteres): insira o número do dia do mês em que você deseja que o fluxo de trabalho seja executado. Por exemplo, insira "1" para o primeiro dia do mês.
    occurrence (cadeia de caracteres): insira uma das seguintes opções se desejar que o fluxo de trabalho seja executado, por exemplo, no primeiro domingo do mês. Os valores aceitáveis são: "1" (primeira ocorrência), "2" (segunda ocorrência), "3" (terceira ocorrência), "4" (quarta ocorrência) e "-1" (a última ocorrência do mês).
    dayOfWeek (inteiro): especifique o dia da semana em que o fluxo de trabalho deve ser executado. Por exemplo, para domingo, insira "0" ou "Sunday" (domingo).
  - customContract (corpo): opcional. Use se você especificou o iterationType como "Custom" (personalizado).
    daysOfMonth (matriz): especifique os dias do mês em que o fluxo de trabalho deve ser executado. Por exemplo, [1, 15, 28].
    months (matriz): especifique o mês em que o fluxo de trabalho deve ser executado. Por exemplo, [1, 5, 7, 9, 12].
  - cronContract (corpo): opcional. Use se você especificou o iterationType como "Cron" (cronológico). Usando a expressão cron, você pode definir padrões de execução complexos e personalizados baseados em tempo para fluxos de trabalho, como horas, dias ou intervalos específicos.
    cronExpression (cadeia de caracteres (string)): as expressões cron consistem em cinco campos obrigatórios. Para obter mais informações, consulte a seção Sintaxe e expressões cron.
name (cadeia de caracteres): opcional. Insira um nome para o agendamento.
comment (cadeia de caracteres): opcional. Insira um comentário, se necessário.
priority (cadeia de caracteres): opcional. Especifique a prioridade para a execução do agendamento. Escolha entre as seguintes opções: "Low" (baixa), "Medium" (média), "High" (alta) e "Critical" (crítica). Se não for especificado, o valor padrão será "Low" (baixa).
workerTag (cadeia de caracteres): opcional. Especifique o trabalhador atribuído. Se não for especificado, o valor será "none" (nenhum).
credentialId (cadeia de caracteres): opcional.
timeZone (cadeia de caracteres): opcional. Especifique o fuso horário em que o agendamento deve ser criado. Para obter mais informações sobre fusos horários válidos, acesse Fusos horários.
Exemplo: "timeZone": "Etc/GMT+4"
questions (corpo): opcional. Para um aplicativo analítico, especifique os parâmetros com os quais o agendamento será executado.
- name (string): insira o nome da ferramenta de interface usada no aplicativo analítico. Por exemplo, do XML do aplicativo analítico "<Question><Name>Text Box (10)</Name>", o name é "Text Box (10)".
- value (cadeia de caracteres): insira a resposta para a ferramenta de interface.

Exemplo de solicitação: cURL

Exemplo de uma solicitação para criar um agendamento com a seguinte ocorrência – uma vez, com hora de início e hora de término especificadas:

curl -X 'POST' \
  'http://localhost/webapi/v3/schedules' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "workflowId": "5555555555555eeeeee6666",
  "iteration": {
    "iterationType": "Once",
    "startTime": "2024-10-09T13:44:15.771Z",
    "endTime": "2024-10-10T13:44:15.771Z"
  },
  "name": "Once_October",
  "comment": "Only once in Oct 2024",
  "priority": "Default",
  "workerTag": "",
  "credentialId": ""
}'

Exemplo de uma solicitação para criar um agendamento com ocorrência de hora em hora:

curl -X 'POST' \
  'http://localhost/webapi/v3/schedules' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "workflowId": "444444444edslfksldkfjsldf9",
  "iteration": {
    "iterationType": "Hourly",
    "startTime": "2024-10-10T13:44:15.771Z",
    "endTime": "2024-10-12T13:44:15.771Z",
    "hourlyContract": {
      "hours": 1,
      "minutes": 15
    }
  },
  "name": "Hourly",
  "comment": "Testing",
  "priority": "Default",
  "workerTag": "",
  "credentialId": ""
}
'

Exemplo de uma solicitação para criar um agendamento com ocorrência semanal:

curl -X 'POST' \
  'http://localhost/webapi/v3/schedules' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "workflowId": "333333klkslfkdjslfkde444",
  "iteration": {
    "iterationType": "Weekly",
    "startTime": "2024-10-10T13:44:15.771Z",
    "endTime": "2025-10-12T13:44:15.771Z",
    "weeklyContract": {
      "daysOfWeek": [
      "Sunday" ]
    }
  },
  "name": "Weekly",
  "comment": "For 2024 and 2025",
  "priority": "Default",
  "workerTag": "",
  "credentialId": ""
}
'

Exemplo de uma solicitação para criar um agendamento com ocorrência mensal – 2º domingo de cada mês:

curl -X 'POST' \
  'http://localhost/webapi/v3/schedules' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "workflowId": "222222efklskdfjsldk111",
  "iteration": {
    "iterationType": "Monthly",
    "startTime": "2024-10-10T13:44:15.771Z",
    "endTime": "2025-10-12T13:44:15.771Z",
    "monthlyContract": {
      "simpleDayOfMonth": false,
      "occurence": 2,
      "dayNumber": "Sunday"
    }
  },
  "name": "Monthly Schedule",
  "comment": "2nd week of a month",
  "priority": "Default",
  "workerTag": "",
  "credentialId": ""
}'

Exemplo de uma solicitação para criar um agendamento com ocorrência mensal – dia 15 de cada mês:

curl -X 'POST' \
  'http://localhost/webapi/v3/schedules' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "workflowId": "61sersfs59lskdfsl345",
  "iteration": {
    "iterationType": "Monthly",
    "startTime": "2024-10-10T13:44:15.771Z",
    "endTime": "2025-10-12T13:44:15.771Z",
    "monthlyContract": {
      "simpleDayOfMonth": true,
      "dayOfMonth": 15
    }
  },
  "name": "Monthly Schedule 2",
  "comment": "every 15th",
  "priority": "Low",
  "workerTag": "",
  "credentialId": ""
}'

Exemplo de uma solicitação para criar um agendamento personalizado:

curl -X 'POST' \
  'http://localhost/webapi/v3/schedules' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "workflowId": "787899864sfgsjsldkfs45",
  "iteration": {
    "iterationType": "Custom",
    "startTime": "2024-10-10T13:44:15.771Z",
    "endTime": "2025-10-12T13:44:15.771Z",
    "customContract": {
      "daysOfMonth": [1,2,5,6,9,12,15,21,23,25],
      "months": [1,2,6,7,11,12]
    }
  },
  "name": "Custom Schedule 2",
  "comment": "every 15th",
  "priority": "Low",
  "workerTag": "",
  "credentialId": ""
}'

Exemplo de resposta

201: Identifier for the new schedule (Identificador para o novo agendamento)
```
"string"
```
400: BadRequest (400: Solicitação incorreta)
401: Unauthorized (401: Não autorizado)

Obter informações sobre todos os agendamentos

Para obter informações sobre todos os agendamentos, use o ponto de extremidade GET {baseURL}/v3/schedules. Use vários parâmetros para filtrar os agendamentos que você deseja exibir.

Nota

Os administradores recebem informações sobre todos os agendamentos para todos os fluxos de trabalho e aplicativos analíticos.
Todos os outros usuários podem obter informações sobre agendamentos para fluxos de trabalho e aplicativos analíticos para os quais têm acesso e permissão, seja por meio de permissões de estúdio ou de coleção.
Ao filtrar agendamentos usando runsAfter e runsBefore, você está limitado a um intervalo de 45 dias entre um e outro.
Devido às alterações que fizemos nos carimbos de data/hora do serviço, todos os campos de data e hora na resposta retornarão no fuso horário UTC-0. Para exibir a lista de fusos horários válidos, acesse Fusos horários.

Parâmetros

view (cadeia de caracteres): opcional. Pode ser deixado sem um valor. Você pode escolher entre os seguintes valores: "Default" (padrão) e "Full" (completo). Se esse parâmetro for definido como "Default", um objeto de visualização reduzido será retornado. Quando não especificado, o valor "Default" é usado.
ownerId (cadeia de caracteres): opcional. Insira o ID do proprietário pelo qual deseja filtrar o agendamento.
workflowId (cadeia de caracteres): opcional. Insira o ID do fluxo de trabalho pelo qual deseja filtrar o agendamento.
runsAfter (data/hora): opcional. Insira a data e a hora após as quais agendamento é executado. Insira a data e a hora no formato ISO8601.
runsBefore (data/hora): opcional. Insira a data e a hora antes das quais o agendamento é executado. Insira a data e a hora no formato ISO8601.

Exemplo de solicitação: cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/schedules' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Exemplo de resposta

200: OK

[
  {
    "id": "string",
    "name": "string",
    "workflowId": "string",
    "ownerId": "string",
    "runDateTime": "string",
    "timeZone": "string"
  }
]

400: BadRequest (400: Solicitação incorreta)
401: Unauthorized (401: Não autorizado)

Procurar um agendamento específico

Para recuperar detalhes sobre um agendamento existente, use o ponto de extremidade GET {baseURL}/v3/schedules/{scheduleId}.

Nota

Os administradores e usuários podem recuperar detalhes sobre agendamentos de fluxos de trabalho e aplicativos analíticos para os quais têm acesso e permissão, seja por meio de permissões de estúdio ou de coleção.
Se o agendamento for para um aplicativo analítico, o proprietário do agendamento poderá visualizar os valores do assistente de aplicativo analítico definidos originalmente.
Devido às alterações que fizemos nos carimbos de data/hora do serviço, todos os campos de data e hora na resposta retornarão no fuso horário UTC-0. Para exibir a lista de fusos horários válidos, acesse Fusos horários.

Parâmetros

scheduleId (cadeia de caracteres): obrigatório. Insira um ID do agendamento para recuperar informações sobre esse agendamento.

Exemplo de solicitação: cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/schedules/670ce5fb5073000030000b8e' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Exemplo de resposta

200: OK

{
  "id": "string",
  "name": "string",
  "workflowId": "string",
  "versionId": "string",
  "ownerId": "string",
  "runDateTime": "string",
  "comment": "string",
  "enabled": true,
  "priority": "Default",
  "workerTag": "string",
  "status": "string",
  "credentialId": "string",
  "creationTime": "string",
  "lastRunTime": "string",
  "state": "string",
  "runCount": 0,
  "iteration": {
    "startTime": "string",
    "endTime": "string"
  },
  "frequency": "string",
  "lastError": "string",
  "cpuName": "string",
  "lastModifiedId": "string",
  "lastModifiedDate": "string",
  "canEdit": true,
  "timeZone": "string",
  "questions": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

401: Unauthorized (401: Não autorizado)
404: NotFound (404: Não encontrado)

Atualizar um agendamento existente

Para atualizar os detalhes de um agendamento existente, use o ponto de extremidade PUT {baseURL}/v3/schedules/{scheduleId}.

Nota

Os seguintes usuários podem atualizar agendamentos:
- Os administradores podem atualizar todos os fluxos de trabalho e agendamentos de aplicativos analíticos, incluindo os valores do assistente de aplicativo analítico.
- Os proprietários de agendamentos podem atualizar seus fluxos de trabalho e agendamentos de aplicativos analíticos, incluindo os valores do assistente de aplicativo analítico.
- Os usuários podem atualizar agendamentos para fluxos de trabalho e aplicativos analíticos para os quais têm acesso e permissão, seja por meio de permissões de estúdio ou de coleção. Eles não podem atualizar os valores do assistente de agendamentos de aplicativos analíticos.
Se "timeZone" estiver vazio ou tiver sido ignorado, todos os campos de data/hora corresponderão ao fuso horário UTC-0. Se "timeZone" for especificado, todos os campos de data/hora corresponderão ao fuso horário especificado. Para exibir a lista de fusos horários válidos, acesse Fusos horários.

Parâmetros

scheduleId (cadeia de caracteres): obrigatório. Insira um ID do agendamento para atualizar esse agendamento.
contract (corpo): obrigatório. Para atualizar um agendamento, o parâmetro "contract" é obrigatório. Especifique o seguinte:
- workflowId (cadeia de caracteres): obrigatório. Insira um ID do fluxo de trabalho.
- ownerId (cadeia de caracteres): obrigatório. Insira um ID de usuário.
- iteration (corpo):
  - iterationType (cadeia de caracteres (string)): especifique se o fluxo de trabalho será agendado "Once" (uma vez), "Hourly" (de hora em hora), "Daily" (diariamente), "Weekly" (semanalmente), "Monthly" (mensalmente), "Custom" (personalizado) ou "Cron" (cronológico). Lembre-se de especificar a frequência como horária (hourlyContract), diária (dailyContract), semanal (weeklyContract), mensal (monthlyContract), personalizada (customContract) ou cronológica (cronContract) para o respectivo tipo de iteração. Para obter mais informações, visite a página de ajuda Agendar um fluxo de trabalho.
  - startTime (cadeia de caracteres): obrigatório. Insira uma data e hora específicas para a execução do fluxo de trabalho. A data de início precisa estar no futuro.
  - endTime (cadeia de caracteres): obrigatório. Insira a data e a hora específicas em que a execução do fluxo de trabalho deve terminar.
  - hourlyContract (corpo): opcional. Use se você especificou o iterationType como "Hourly" (de hora em hora).
    hours (cadeia de caracteres): insira a hora.
    minutes (cadeia de caracteres): insira os minutos.
  - dailyContract (corpo): opcional. Use se você especificou o iterationType como "Daily" (diariamente).
    runOnlyWorkWeek (booleano): opcional. Se não especificado, o padrão é "false" (falso).
  - weeklyContract (corpo): opcional. Use se você especificou o iterationType como "Weekly" (semanalmente).
    daysOfWeek (cadeia de caracteres): especifique o dia da semana em que o fluxo de trabalho deve ser executado. Por exemplo, "Sunday" (domingo).
  - monthlyContract (corpo): opcional. Use se você especificou o iterationType como "Monthly" (mensalmente).
    simpleDayOfMonth (booleano): insira "true" (verdadeiro) se deseja especificar um dia do mês em que o fluxo de trabalho deve ser executado.
    dayOfMonth (cadeia de caracteres): insira o número do dia do mês em que você deseja que o fluxo de trabalho seja executado. Por exemplo, insira "1" para o primeiro dia do mês.
    occurrence (cadeia de caracteres): insira uma das seguintes opções se desejar que o fluxo de trabalho seja executado, por exemplo, no primeiro domingo do mês. Os valores aceitáveis são: "1" (primeira ocorrência), "2" (segunda ocorrência), "3" (terceira ocorrência), "4" (quarta ocorrência) e "-1" (a última ocorrência do mês).
    dayOfWeek (inteiro): especifique o dia da semana em que o fluxo de trabalho deve ser executado. Por exemplo, para domingo, insira "0" ou "Sunday" (domingo).
  - customContract (corpo): opcional. Use se você especificou o iterationType como "Custom" (personalizado).
    daysOfMonth (matriz): especifique os dias do mês em que o fluxo de trabalho deve ser executado. Por exemplo, [1, 15, 28].
    months (matriz): especifique o mês em que o fluxo de trabalho deve ser executado. Por exemplo, [1, 5, 7, 9, 12].
  - cronContract (corpo): opcional. Use se você especificou o iterationType como "Cron" (cronológico). Usando a expressão cron, você pode definir padrões de execução complexos e personalizados baseados em tempo para fluxos de trabalho, como horas, dias ou intervalos específicos.
    cronExpression (cadeia de caracteres (string)): as expressões cron consistem em cinco campos obrigatórios. Para obter mais informações, consulte a seção Sintaxe e expressões cron.
name (cadeia de caracteres): obrigatório. Insira um nome para o agendamento.
comment (cadeia de caracteres): obrigatório. Insira um comentário, se necessário.
priority (cadeia de caracteres): opcional. Especifique a prioridade para a execução do agendamento. Escolha entre as seguintes opções: "Low" (baixa), "Medium" (média), "High" (alta) e "Critical" (crítica). Se não for especificado, o valor padrão é "Low" (baixa).
workerTag (cadeia de caracteres): obrigatório. Especifique o trabalhador atribuído. Se não for especificado, o valor será "none" (nenhum).
enabled (booleano): opcional. Especifique se o agendamento deve estar habilitado ou desabilitado.
credentialId (cadeia de caracteres): obrigatório.
timeZone (cadeia de caracteres): opcional. Especifique o fuso horário em que o agendamento deve ser criado. Para obter mais informações sobre fusos horários válidos, acesse Fusos horários.
Exemplo: "timeZone": "Etc/GMT+4"
questions (corpo): opcional. Para um aplicativo analítico, especifique os parâmetros com os quais o agendamento será executado.
- name (string): insira o nome da ferramenta de interface usada no aplicativo analítico. Por exemplo, do XML do aplicativo analítico "<Question><Name>Text Box (10)</Name>", o name é "Text Box (10)".
- value (cadeia de caracteres): insira a resposta para a ferramenta de interface.

Exemplo de solicitação: cURL

Exemplo de uma solicitação para atualizar um agendamento – alteração da hora de início e hora de término, nome e comentário (corpo):

curl -X 'PUT' \
  'http://localhost/webapi/v3/schedules/670653d48f2f00008f001ade' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "workflowId": "6706520a102704d193b4586d",
  "ownerId": "string",
  "iteration": {
    "iterationType": "Once",
    "startTime": "2024-10-10T12:17:19.701Z",
    "endTime": "2026-10-10T12:17:19.701Z"
  },
  "name": "Once",
  "comment": "Rescheduled",
  "priority": "Low",
  "workerTag": "",
  "enabled": true,
  "credentialId": ""
}
'

Exemplo de resposta

200: OK

{
  "id": "string",
  "name": "string",
  "workflowId": "string",
  "versionId": "string",
  "ownerId": "string",
  "runDateTime": "string",
  "comment": "string",
  "enabled": true,
  "priority": "Default",
  "workerTag": "string",
  "status": "string",
  "credentialId": "string",
  "creationTime": "string",
  "lastRunTime": "string",
  "state": "string",
  "runCount": 0,
  "iteration": {
    "startTime": "string",
    "endTime": "string"
  },
  "frequency": "string",
  "lastError": "string",
  "cpuName": "string",
  "lastModifiedId": "string",
  "lastModifiedDate": "string",
  "canEdit": true,
  "timeZone": "string",
  "questions": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

400: BadRequest (400: Solicitação incorreta)
401: Unauthorized (401: Não autorizado)
404: NotFound (404: Não encontrado)

Excluir um agendamento

Para excluir um agendamento específico do sistema, use o ponto de extremidade DELETE {baseURL}/v3/schedules/{scheduleId}.

Nota

Usuários que podem excluir agendamentos com esse ponto de extremidade:

Os administradores podem excluir qualquer fluxo de trabalho ou agendamentos de aplicativos analíticos.
Os proprietários de agendamentos podem excluir o fluxo de trabalho ou os agendamentos de aplicativos analíticos que criaram.
Outros usuários dentro de um estúdio também podem ter essa permissão se o estúdio estiver configurado para lhes permitir acesso aos agendamentos.

Parâmetros

scheduleId (cadeia de caracteres): obrigatório. Insira o ID do agendamento que deseja excluir.

Exemplo de solicitação: cURL

curl -X 'DELETE' \
  'http://localhost/webapi/v3/schedules/670ce5fb5073000030000b8e' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Exemplo de resposta

200: OK
400: BadRequest (400: Solicitação incorreta)
401: Unauthorized (401: Não autorizado)
404: NotFound (404: Não encontrado)

Atualizar um agendamento existente usando o ponto de extremidade PATCH

Para atualizar um agendamento existente sem ter que preencher vários campos obrigatórios para fazer uma única alteração, use o ponto de extremidade PATCH {baseURL}/v3/schedules/{scheduleId}.

Nota

Entre os usuários que podem atualizar o agendamento com esse ponto de extremidade estão:
- Proprietários do agendamento.
- Administradores com acesso ao agendamento.
- Outros usuários dentro de um estúdio, se o estúdio estiver configurado para lhes permitir acesso ao agendamento.
- Usuários na coleção que contém o agendamento.
Se "timeZone" estiver vazio ou tiver sido ignorado, todos os campos de data/hora corresponderão ao fuso horário UTC-0. Se "timeZone" for especificado, todos os campos de data/hora corresponderão ao fuso horário especificado. Para exibir a lista de fusos horários válidos, acesse Fusos horários.

Parâmetros

scheduleId (cadeia de caracteres): obrigatório. Insira um ID do agendamento para atualizar esse agendamento.
contract (corpo): obrigatório. Para atualizar um agendamento, o parâmetro "contract" é obrigatório. Especifique o seguinte:
- ownerId (cadeia de caracteres): opcional. Insira um ID de usuário.
- iteration (corpo): se você enviar opcionalmente "iteration", iterationType e startTime serão obrigatórios. Os campos restantes são opcionais.
  - iterationType (cadeia de caracteres): obrigatório se você enviar iteration. Especifique se o fluxo de trabalho será agendado "Once" (uma vez), "Hourly" (de hora em hora), "Daily" (diariamente), "Weekly" (semanalmente), "Monthly" (mensalmente) ou "Custom" (personalizado). Lembre-se de especificar a frequência como horária (hourlyContract), diária (dailyContract), semanal (weeklyContract), mensal (monthlyContract), personalizada (customContract) ou cronológica (cronContract) para o respectivo tipo de iteração. Para obter mais informações, visite a página de ajuda Agendar um fluxo de trabalho.
  - startTime (cadeia de caracteres): obrigatório se você enviar iteration. Insira uma data e hora específicas para a execução do fluxo de trabalho. A data de início precisa estar no futuro.
  - endTime (cadeia de caracteres): opcional. Insira a data e a hora específicas em que a execução do fluxo de trabalho deve terminar.
  - hourlyContract (corpo): opcional. Use se você especificou o iterationType como "Hourly" (de hora em hora).
    hours (cadeia de caracteres): opcional. Insira a hora.
    minutes (cadeia de caracteres): opcional. Insira os minutos.
  - dailyContract (corpo): opcional. Use se você especificou o iterationType como "Daily" (diariamente).
    runOnlyWorkWeek (booleano): opcional. Se não especificado, o padrão é "false" (falso).
  - weeklyContract (corpo): opcional. Use se você especificou o iterationType como "Weekly" (semanalmente).
    daysOfWeek (cadeia de caracteres): opcional. Especifique o dia da semana em que o fluxo de trabalho deve ser executado. Por exemplo, "Sunday" (domingo).
  - monthlyContract (corpo): opcional. Use se você especificou o iterationType como "Monthly" (mensalmente).
    simpleDayOfMonth (booleano): opcional. Insira "true" (verdadeiro) se deseja especificar um dia do mês em que o fluxo de trabalho deve ser executado.
    dayOfMonth (cadeia de caracteres): opcional. Insira o número do dia do mês em que você deseja que o fluxo de trabalho seja executado. Por exemplo, insira "1" para o primeiro dia do mês.
    occurrence (cadeia de caracteres): opcional. Insira uma das seguintes opções se desejar que o fluxo de trabalho seja executado, por exemplo, no primeiro domingo do mês. Os valores aceitáveis são: "1" (primeira ocorrência), "2" (segunda ocorrência), "3" (terceira ocorrência), "4" (quarta ocorrência) e "-1" (a última ocorrência do mês).
    dayOfWeek (inteiro): opcional. Especifique o dia da semana em que o fluxo de trabalho deve ser executado. Por exemplo, para domingo, insira "0" ou "Sunday" (domingo).
  - customContract (corpo): opcional. Use se você especificou o iterationType como "Custom" (personalizado).
    daysOfMonth (matriz): opcional. Especifique os dias do mês em que o fluxo de trabalho deve ser executado. Por exemplo, [1, 15, 28].
    months (matriz): opcional. Especifique o mês em que o fluxo de trabalho deve ser executado. Por exemplo, [1, 5, 7, 9, 12].
  - cronContract (corpo): opcional. Use se você especificou o iterationType como "Cron" (cronológico). Usando a expressão cron, você pode definir padrões de execução complexos e personalizados baseados em tempo para fluxos de trabalho, como horas, dias ou intervalos específicos.
    cronExpression (cadeia de caracteres (string)): as expressões cron consistem em cinco campos obrigatórios. Para obter mais informações, consulte a seção Sintaxe e expressões cron.
name (cadeia de caracteres): opcional. Insira um nome para o agendamento.
comment (cadeia de caracteres): opcional. Insira um comentário, se necessário.
priority (cadeia de caracteres): opcional. Especifique a prioridade para a execução do agendamento. Escolha entre as seguintes opções: "Low" (baixa), "Medium" (média), "High" (alta) e "Critical" (crítica). Se não for especificado, o valor padrão é "Low" (baixa).
workerTag (cadeia de caracteres): opcional. Especifique o trabalhador atribuído. Se não for especificado, o valor será "none" (nenhum).
enabled (booleano): opcional. Especifique se o agendamento deve estar habilitado ou desabilitado.
credentialId (cadeia de caracteres): opcional.
timeZone (cadeia de caracteres): opcional. Especifique o fuso horário em que o agendamento deve ser criado. Para obter mais informações sobre fusos horários válidos, acesse Fusos horários.
Exemplo: "timeZone": "Etc/GMT+4"
questions (corpo): opcional. Para um aplicativo analítico, especifique os parâmetros com os quais o agendamento será executado.
- name (cadeia de caracteres): opcional. Insira o nome da ferramenta de interface usada no aplicativo analítico. Por exemplo, do XML do aplicativo analítico "<Question><Name>Text Box (10)</Name>", o name é "Text Box (10)".
- value (cadeia de caracteres): opcional. Insira a resposta para a ferramenta de interface.

Relações de objetos

Se estiver criando um agendamento, você poderá usar objetos criados da seguinte maneira:

Objeto criado: "scheduleId" (por exemplo, "id": "619158e57e607d0011ac3009")

Você pode usá-lo como:

scheduleId se você estiver procurando um agendamento específico.
scheduleId se você desejar atualizar um agendamento específico.
scheduleId se você desejar excluir um agendamento específico.
scheduleId se você desejar adicionar um agendamento específico a uma coleção.Pontos de extremidade de coleções
scheduleId se você desejar remover um agendamento específico de uma coleção.Pontos de extremidade de coleções

Exemplos de solicitações Postman

GET /v3/schedules/

Para saber mais sobre solicitações Postman, visite a página de ajuda Como usar Postman.

Fusos horários

Esta tabela lista os fusos horários válidos que você pode inserir ao usar os seguintes pontos de extremidade:

POST {baseURL}/v3/schedules
PUT {baseURL}/v3/schedules
GET {baseURL}/v3/schedules/{id}
GET {baseURL}/v3/schedules

Lista de fusos horários

Fuso horário	Deslocamento em relação ao fuso horário UTC
Etc/GMT+12	-12:00
Etc/GMT+11	-11:00
Pacific/Niue	-11:00
Pacific/Pago_Pago	-11:00
Etc/GMT+10	-10:00
HST	-10:00
Pacific/Honolulu	-10:00
Pacific/Rarotonga	-10:00
Pacific/Tahiti	-10:00
Pacific/Marquesas	-09:30
America/Adak	-09:00
Etc/GMT+9	-09:00
Pacific/Gambier	-09:00
America/Anchorage	-08:00
America/Juneau	-08:00
America/Metlakatla	-08:00
America/Nome	-08:00
America/Sitka	-08:00
America/Yakutat	-08:00
Etc/GMT+8	-08:00
Pacific/Pitcairn	-08:00
America/Creston	-07:00
America/Dawson	-07:00
America/Dawson_Creek	-07:00
America/Fort_Nelson	-07:00
America/Hermosillo	-07:00
America/Los_Angeles	-07:00
America/Phoenix	-07:00
America/Tijuana	-07:00
America/Vancouver	-07:00
America/Whitehorse	-07:00
Etc/GMT+7	-07:00
MST	-07:00
PST8PDT	-07:00
America/Belize	-06:00
America/Boise	-06:00
America/Cambridge_Bay	-06:00
America/Chihuahua	-06:00
America/Costa_Rica	-06:00
America/Denver	-06:00
America/Edmonton	-06:00
America/El_Salvador	-06:00
America/Guatemala	-06:00
America/Inuvik	-06:00
America/Managua	-06:00
America/Mazatlan	-06:00
America/Ojinaga	-06:00
America/Regina	-06:00
America/Swift_Current	-06:00
America/Tegucigalpa	-06:00
America/Yellowknife	-06:00
Etc/GMT+6	-06:00
MST7MDT	-06:00
Pacific/Galapagos	-06:00
America/Atikokan	-05:00
America/Bahia_Banderas	-05:00
America/Bogota	-05:00
America/Cancun	-05:00
America/Chicago	-05:00
America/Eirunepe	-05:00
America/Guayaquil	-05:00
America/Indiana/Knox	-05:00
America/Indiana/Tell_City	-05:00
America/Jamaica	-05:00
America/Lima	-05:00
America/Matamoros	-05:00
America/Menominee	-05:00
America/Merida	-05:00
America/Mexico_City	-05:00
America/Monterrey	-05:00
America/North_Dakota/Beulah	-05:00
America/North_Dakota/Center	-05:00
America/North_Dakota/New_Salem	-05:00
America/Panama	-05:00
America/Rainy_River	-05:00
America/Rankin_Inlet	-05:00
America/Resolute	-05:00
America/Rio_Branco	-05:00
America/Winnipeg	-05:00
CST6CDT	-05:00
EST	-05:00
Etc/GMT+5	-05:00
Pacific/Easter	-05:00
America/Asuncion	-04:00
America/Barbados	-04:00
America/Blanc-Sablon	-04:00
America/Boa_Vista	-04:00
America/Campo_Grande	-04:00
America/Caracas	-04:00
America/Cuiaba	-04:00
America/Curacao	-04:00
America/Detroit	-04:00
America/Grand_Turk	-04:00
America/Guyana	-04:00
America/Havana	-04:00
America/Indiana/Indianapolis	-04:00
America/Indiana/Marengo	-04:00
America/Indiana/Petersburg	-04:00
America/Indiana/Vevay	-04:00
America/Indiana/Vincennes	-04:00
America/Indiana/Winamac	-04:00
America/Iqaluit	-04:00
America/Kentucky/Louisville	-04:00
America/Kentucky/Monticello	-04:00
America/La_Paz	-04:00
America/Manaus	-04:00
America/Martinique	-04:00
America/Nassau	-04:00
America/New_York	-04:00
America/Nipigon	-04:00
America/Pangnirtung	-04:00
America/Port_of_Spain	-04:00
America/Port-au-Prince	-04:00
America/Porto_Velho	-04:00
America/Puerto_Rico	-04:00
America/Santo_Domingo	-04:00
America/Thunder_Bay	-04:00
America/Toronto	-04:00
EST5EDT	-04:00
Etc/GMT+4	-04:00
America/Araguaina	-03:00
America/Argentina/Buenos_Aires	-03:00
America/Argentina/Catamarca	-03:00
America/Argentina/Cordoba	-03:00
America/Argentina/Jujuy	-03:00
America/Argentina/La_Rioja	-03:00
America/Argentina/Mendoza	-03:00
America/Argentina/Rio_Gallegos	-03:00
America/Argentina/Salta	-03:00
America/Argentina/San_Juan	-03:00
America/Argentina/San_Luis	-03:00
America/Argentina/Tucuman	-03:00
America/Argentina/Ushuaia	-03:00
America/Bahia	-03:00
America/Belem	-03:00
America/Cayenne	-03:00
America/Fortaleza	-03:00
America/Glace_Bay	-03:00
America/Goose_Bay	-03:00
America/Halifax	-03:00
America/Maceio	-03:00
America/Moncton	-03:00
America/Montevideo	-03:00
America/Paramaribo	-03:00
America/Punta_Arenas	-03:00
America/Recife	-03:00
America/Santarem	-03:00
America/Santiago	-03:00
America/Sao_Paulo	-03:00
America/Thule	-03:00
Antarctica/Palmer	-03:00
Antarctica/Rothera	-03:00
Atlantic/Bermuda	-03:00
Atlantic/Stanley	-03:00
Etc/GMT+3	-03:00
America/St_Johns	-02:30
America/Godthab	-02:00
America/Miquelon	-02:00
America/Noronha	-02:00
Atlantic/South_Georgia	-02:00
Etc/GMT+2	-02:00
Atlantic/Cape_Verde	-01:00
Etc/GMT+1	-01:00
Africa/Abidjan	+00:00
Africa/Accra	+00:00
Africa/Bissau	+00:00
Africa/Monrovia	+00:00
Africa/Sao_Tome	+00:00
America/Danmarkshavn	+00:00
America/Scoresbysund	+00:00
Atlantic/Azores	+00:00
Atlantic/Reykjavik	+00:00
Etc/GMT	+00:00
Etc/UTC	+00:00
Africa/Algiers	+01:00
Africa/Casablanca	+01:00
Africa/El_Aaiun	+01:00
Africa/Lagos	+01:00
Africa/Ndjamena	+01:00
Africa/Tunis	+01:00
Atlantic/Canary	+01:00
Atlantic/Faroe	+01:00
Atlantic/Madeira	+01:00
Etc/GMT-1	+01:00
Europe/Dublin	+01:00
Europe/Lisbon	+01:00
Europe/London	+01:00
WET	+01:00
Africa/Cairo	+02:00
Africa/Ceuta	+02:00
Africa/Johannesburg	+02:00
Africa/Khartoum	+02:00
Africa/Maputo	+02:00
Africa/Tripoli	+02:00
Africa/Windhoek	+02:00
Antarctica/Troll	+02:00
CET	+02:00
Etc/GMT-2	+02:00
Europe/Amsterdam	+02:00
Europe/Andorra	+02:00
Europe/Belgrade	+02:00
Europe/Berlin	+02:00
Europe/Brussels	+02:00
Europe/Budapest	+02:00
Europe/Copenhagen	+02:00
Europe/Gibraltar	+02:00
Europe/Kaliningrad	+02:00
Europe/Luxembourg	+02:00
Europe/Madrid	+02:00
Europe/Malta	+02:00
Europe/Monaco	+02:00
Europe/Oslo	+02:00
Europe/Paris	+02:00
Europe/Prague	+02:00
Europe/Rome	+02:00
Europe/Stockholm	+02:00
Europe/Tirane	+02:00
Europe/Vienna	+02:00
Europe/Warsaw	+02:00
Europe/Zurich	+02:00
MET	+02:00
Africa/Juba	+03:00
Africa/Nairobi	+03:00
Antarctica/Syowa	+03:00
Asia/Amman	+03:00
Asia/Baghdad	+03:00
Asia/Beirut	+03:00
Asia/Damascus	+03:00
Asia/Famagusta	+03:00
Asia/Gaza	+03:00
Asia/Hebron	+03:00
Asia/Jerusalem	+03:00
Asia/Nicosia	+03:00
Asia/Qatar	+03:00
Asia/Riyadh	+03:00
EET	+03:00
Etc/GMT-3	+03:00
Europe/Athens	+03:00
Europe/Bucharest	+03:00
Europe/Chisinau	+03:00
Europe/Helsinki	+03:00
Europe/Istanbul	+03:00
Europe/Kiev	+03:00
Europe/Kirov	+03:00
Europe/Minsk	+03:00
Europe/Moscow	+03:00
Europe/Riga	+03:00
Europe/Simferopol	+03:00
Europe/Sofia	+03:00
Europe/Tallinn	+03:00
Europe/Uzhgorod	+03:00
Europe/Vilnius	+03:00
Europe/Zaporozhye	+03:00
Asia/Baku	+04:00
Asia/Dubai	+04:00
Asia/Tbilisi	+04:00
Asia/Yerevan	+04:00
Etc/GMT-4	+04:00
Europe/Astrakhan	+04:00
Europe/Samara	+04:00
Europe/Saratov	+04:00
Europe/Ulyanovsk	+04:00
Europe/Volgograd	+04:00
Indian/Mahe	+04:00
Indian/Mauritius	+04:00
Indian/Reunion	+04:00
Asia/Kabul	+04:30
Asia/Tehran	+04:30
Antarctica/Mawson	+05:00
Asia/Aqtau	+05:00
Asia/Aqtobe	+05:00
Asia/Ashgabat	+05:00
Asia/Atyrau	+05:00
Asia/Dushanbe	+05:00
Asia/Karachi	+05:00
Asia/Oral	+05:00
Asia/Qyzylorda	+05:00
Asia/Samarkand	+05:00
Asia/Tashkent	+05:00
Asia/Yekaterinburg	+05:00
Etc/GMT-5	+05:00
Indian/Kerguelen	+05:00
Indian/Maldives	+05:00
Asia/Colombo	+05:30
Asia/Kolkata	+05:30
Asia/Kathmandu	+05:45
Antarctica/Vostok	+06:00
Asia/Almaty	+06:00
Asia/Bishkek	+06:00
Asia/Dhaka	+06:00
Asia/Omsk	+06:00
Asia/Qostanay	+06:00
Asia/Thimphu	+06:00
Asia/Urumqi	+06:00
Etc/GMT-6	+06:00
Indian/Chagos	+06:00
Asia/Yangon	+06:30
Indian/Cocos	+06:30
Antarctica/Davis	+07:00
Asia/Bangkok	+07:00
Asia/Barnaul	+07:00
Asia/Ho_Chi_Minh	+07:00
Asia/Hovd	+07:00
Asia/Jakarta	+07:00
Asia/Krasnoyarsk	+07:00
Asia/Novokuznetsk	+07:00
Asia/Novosibirsk	+07:00
Asia/Pontianak	+07:00
Asia/Tomsk	+07:00
Etc/GMT-7	+07:00
Indian/Christmas	+07:00
Antarctica/Casey	+08:00
Asia/Brunei	+08:00
Asia/Choibalsan	+08:00
Asia/Hong_Kong	+08:00
Asia/Irkutsk	+08:00
Asia/Kuala_Lumpur	+08:00
Asia/Kuching	+08:00
Asia/Macau	+08:00
Asia/Makassar	+08:00
Asia/Manila	+08:00
Asia/Shanghai	+08:00
Asia/Singapore	+08:00
Asia/Taipei	+08:00
Asia/Ulaanbaatar	+08:00
Australia/Perth	+08:00
Etc/GMT-8	+08:00
Australia/Eucla	+08:45
Asia/Chita	+09:00
Asia/Dili	+09:00
Asia/Jayapura	+09:00
Asia/Khandyga	+09:00
Asia/Pyongyang	+09:00
Asia/Seoul	+09:00
Asia/Tokyo	+09:00
Asia/Yakutsk	+09:00
Etc/GMT-9	+09:00
Pacific/Palau	+09:00
Australia/Adelaide	+09:30
Australia/Broken_Hill	+09:30
Australia/Darwin	+09:30
Antarctica/DumontDUrville	+10:00
Asia/Ust-Nera	+10:00
Asia/Vladivostok	+10:00
Australia/Brisbane	+10:00
Australia/Currie	+10:00
Australia/Hobart	+10:00
Australia/Lindeman	+10:00
Australia/Melbourne	+10:00
Australia/Sydney	+10:00
Etc/GMT-10	+10:00
Pacific/Chuuk	+10:00
Pacific/Guam	+10:00
Pacific/Port_Moresby	+10:00
Australia/Lord_Howe	+10:30
Antarctica/Macquarie	+11:00
Asia/Magadan	+11:00
Asia/Sakhalin	+11:00
Asia/Srednekolymsk	+11:00
Etc/GMT-11	+11:00
Pacific/Bougainville	+11:00
Pacific/Efate	+11:00
Pacific/Guadalcanal	+11:00
Pacific/Kosrae	+11:00
Pacific/Norfolk	+11:00
Pacific/Noumea	+11:00
Pacific/Pohnpei	+11:00
Asia/Anadyr	+12:00
Asia/Kamchatka	+12:00
Etc/GMT-12	+12:00
Pacific/Auckland	+12:00
Pacific/Fiji	+12:00
Pacific/Funafuti	+12:00
Pacific/Kwajalein	+12:00
Pacific/Majuro	+12:00
Pacific/Nauru	+12:00
Pacific/Tarawa	+12:00
Pacific/Wake	+12:00
Pacific/Wallis	+12:00
Pacific/Chatham	+12:45
Etc/GMT-13	+13:00
Pacific/Apia	+13:00
Pacific/Enderbury	+13:00
Pacific/Fakaofo	+13:00
Pacific/Tongatapu	+13:00
Etc/GMT-14	+14:00
Pacific/Kiritimati	+14:00

Sintaxe e expressões cron

O que é uma expressão cron?

Expressões cron são cadeias de caracteres (strings) usadas para definir quando uma tarefa agendada deve ser executada. Elas são comumente usadas para automatizar tarefas repetitivas, como backups, execuções de script ou manutenção do sistema.

Sintaxe cron básica

Uma expressão cron padrão tem cinco campos obrigatórios (às vezes seis, se você incluir segundos), cada uma separada por um espaço em branco:

* * * * * <command>
│ │ │ │ │
│ │ │ │ └──── Day of the week (0 - 7) (Sunday=0 or 7)
│ │ │ └────── Month (1 - 12)
│ │ └──────── Day of the month (1 - 31)
│ └────────── Hour (0 - 23)
└──────────── Minute (0 - 59)

Exemplos

Execuções de hora em hora apenas durante horas comerciais:
0 9-16 * * 1-5 → executa de hora em hora das 9:00 às 16:00, de segunda a sexta-feira.
À noite às segundas, quartas e sextas-feiras em horários específicos:
0 19,20,21 * * 1,3,5 → executa às 19:00, 20:00 e 21:00 às segundas, quartas e sextas-feiras.
Janelas de processamento de alta frequência:
*/10 15 * * 5 → executa a cada 10 minutos entre 15:00 e 16:00 às sextas-feiras.

Nesta secção:

Pontos de extremidade de agendamentos