- Introdução
- Autenticação
- Definição do Swagger
- APIs do Orchestrator
- Solicitações de alertas
- Solicitações de ativos
- Solicitações de calendários
- Solicitações de ambientes
- Solicitações de pastas
- Solicitações de Tarefas Genéricas
- Solicitações de trabalhos
- Solicitações de bibliotecas
- Solicitações de licenças
- Solicitações de pacotes
- Solicitações de permissões
- Solicitações de espaços de trabalho pessoais
- Solicitações de processos
- Solicitações de itens de fila
- Solicitações de robôs
- Solicitações de funções
- Solicitações de agendamentos
- Solicitações de configurações
- Solicitações de tarefas
- Solicitações de catálogos de tarefas
- Solicitações de formulários de tarefas
- Solicitações de tenants
- Solicitações de Transações
- Solicitações de usuários
- Solicitações de webhooks
- APIs de gestão de plataforma
Guia da API do Orchestrator
Solicitações de agendamentos
A solicitação a seguir permite criar um agendamento chamado ApiTest, no fuso horário GMT Standard Time, que é acionado a cada 5 meses, aos domingos.
StartStrategy
permite escolher como deseja executar o trabalho.
StartStrategy
Valor |
Name |
Description |
Contexto de pasta |
---|---|---|---|
-1
|
Todos os Robôs |
Executa o job uma vez para cada robô presente no ambiente do processo. |
Clássico |
0
|
robôs personalizados |
Executa o trabalho uma vez em cada um dos robôs especificados. Para especificar os robôs, inclua os IDs dos robôs como valores em
ExecutorRobots . Por exemplo, `"ExecutorRobots": [{"Id": 44881
|
Clássico |
1
|
1 robô |
Executa o trabalho em um robô selecionado dinamicamente de qualquer usuário que tenha acesso à pasta onde está o processo. Você também pode definir o trabalho para ser executado no robô especificado em
MachineRobots . Consulte o exemplo de corpo de solicitação abaixo para obter um exemplo.
|
Moderno |
qualquer outro número |
Alocação Dinâmica |
Cria o número especificado de trabalhos e escolhe dinamicamente os robôs nos quais executá-los a partir dos robôs disponíveis na pasta moderna do processo ou dos robôs no ambiente para pastas clássicas. Para pastas modernas, você também pode especificar um ou mais modelos de máquina, robôs ou ambos os modelos de máquina e robôs usando o parâmetro de lista
MachineRobots . Nesse caso, o valor StartStrategy representa o número de vezes para executar o trabalho em cada robô especificado ou combinação de máquina-robô.
Isso não é possível para pastas clássicas e, se especificado, o parâmetro
ExecutorRobots será ignorado.
|
clássico ou moderno |
Postar
https://{yourDomain}/odata/ProcessSchedules
{
"Name":"ApiTest",
"ReleaseId":75,
"ReleaseName":"BlankProcess_DocEnv",
"StartProcessCron":"0 0 0 ? 1/5 SUN *",
"StartProcessCronDetails":"{\"type\":4,\"minutely\":{},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[{\"id\":\"SUN\",\"weekly\":\"Sunday\",\"monthly\":\"Sunday\"}],\"atMinute\":0,\"atHour\":0,\"frequencyInMonths\":\"5\"},\"advancedCronExpression\":\"\"}",
"StartStrategy":15,
"ExecutorRobots":[],
"MachineRobots":[
{
"MachineId":null,
"MachineName":null,
"RobotId":44880,
"RobotUserName":"acme\\john.doe"
}
],
"StopProcessExpression":"",
"StopStrategy":null,
"TimeZoneId":"GMT Standard Time"
}
{
"Name":"ApiTest",
"ReleaseId":75,
"ReleaseName":"BlankProcess_DocEnv",
"StartProcessCron":"0 0 0 ? 1/5 SUN *",
"StartProcessCronDetails":"{\"type\":4,\"minutely\":{},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[{\"id\":\"SUN\",\"weekly\":\"Sunday\",\"monthly\":\"Sunday\"}],\"atMinute\":0,\"atHour\":0,\"frequencyInMonths\":\"5\"},\"advancedCronExpression\":\"\"}",
"StartStrategy":15,
"ExecutorRobots":[],
"MachineRobots":[
{
"MachineId":null,
"MachineName":null,
"RobotId":44880,
"RobotUserName":"acme\\john.doe"
}
],
"StopProcessExpression":"",
"StopStrategy":null,
"TimeZoneId":"GMT Standard Time"
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#ProcessSchedules/$entity",
"Enabled": true,
"Name": "ApiTest",
"ReleaseId": 75,
"ReleaseKey": "00000000-0000-0000-0000-000000000000",
"ReleaseName": null,
"PackageName": null,
"EnvironmentName": null,
"EnvironmentId": "0",
"StartProcessCron": "0 0 0 ? 1/5 SUN *",
"StartProcessCronDetails": "{\"type\":4,\"minutely\":{},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[{\"id\":\"SUN\",\"weekly\":\"Sunday\",\"monthly\":\"Sunday\"}],\"atMinute\":0,\"atHour\":0,\"frequencyInMonths\":\"5\"},\"advancedCronExpression\":\"\"}",
"StartProcessCronSummary": null,
"StartProcessNextOccurrence": null,
"StartStrategy": 15,
"StopProcessExpression": "",
"StopStrategy": null,
"ExternalJobKey": "8cda4b35-e835-445b-b477-1ea0961d62e5",
"TimeZoneId": "GMT Standard Time",
"TimeZoneIana": "Europe/London",
"UseCalendar": false,
"StopProcessDate": null,
"InputArguments": "{}",
"Id": 43
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#ProcessSchedules/$entity",
"Enabled": true,
"Name": "ApiTest",
"ReleaseId": 75,
"ReleaseKey": "00000000-0000-0000-0000-000000000000",
"ReleaseName": null,
"PackageName": null,
"EnvironmentName": null,
"EnvironmentId": "0",
"StartProcessCron": "0 0 0 ? 1/5 SUN *",
"StartProcessCronDetails": "{\"type\":4,\"minutely\":{},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[{\"id\":\"SUN\",\"weekly\":\"Sunday\",\"monthly\":\"Sunday\"}],\"atMinute\":0,\"atHour\":0,\"frequencyInMonths\":\"5\"},\"advancedCronExpression\":\"\"}",
"StartProcessCronSummary": null,
"StartProcessNextOccurrence": null,
"StartStrategy": 15,
"StopProcessExpression": "",
"StopStrategy": null,
"ExternalJobKey": "8cda4b35-e835-445b-b477-1ea0961d62e5",
"TimeZoneId": "GMT Standard Time",
"TimeZoneIana": "Europe/London",
"UseCalendar": false,
"StopProcessDate": null,
"InputArguments": "{}",
"Id": 43
}
/odata/ProcessSchedules
permite que você crie uma programação habilitada com o nome "API_schedule_test" no processo com o ID 55, além de adicionar valores personalizados para alguns dos parâmetros dos processos. A programação começa a cada cinco minutos em todos os Robôs disponíveis e não considera os dias não úteis.
Postar
https://{yourDomain}/odata/ProcessSchedules
{
"Enabled": true,
"Name": "API_schedule_test",
"ReleaseId": 55,
"ReleaseKey": "429cf1cc-283c-424f-a935-43f72c2ca719",
"ReleaseName": "input_output_test_DocEnv",
"PackageName": "input_output_test",
"EnvironmentName": "DocEnv",
"EnvironmentId": "7",
"StartProcessCron": "0 0/5 * 1/1 * ? *",
"StartProcessCronDetails": "{\"type\":0,\"minutely\":{\"atMinute\":5},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"\"}",
"StartProcessCronSummary": "Every 5 minutes",
"StartProcessNextOccurrence": null,
"StartStrategy": 0,
"StopProcessExpression": "",
"StopStrategy": null,
"ExternalJobKey": "af486c19-c797-48cd-b586-cfb7a12110a2",
"TimeZoneId": "Morocco Standard Time",
"TimeZoneIana": "Africa/Casablanca",
"UseCalendar": false,
"StopProcessDate": null,
"InputArguments": "{\"arrayStrings\":[\"test\",\"test\"],\"age\":666,\"trueOrFalse\":false,\"dateNow\":\"2012-04-23T18:25:43.511Z\",\"stringNew\":\"stringTest\",\"DoubleTest\":7.555555}",
"Id": 37
}
{
"Enabled": true,
"Name": "API_schedule_test",
"ReleaseId": 55,
"ReleaseKey": "429cf1cc-283c-424f-a935-43f72c2ca719",
"ReleaseName": "input_output_test_DocEnv",
"PackageName": "input_output_test",
"EnvironmentName": "DocEnv",
"EnvironmentId": "7",
"StartProcessCron": "0 0/5 * 1/1 * ? *",
"StartProcessCronDetails": "{\"type\":0,\"minutely\":{\"atMinute\":5},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"\"}",
"StartProcessCronSummary": "Every 5 minutes",
"StartProcessNextOccurrence": null,
"StartStrategy": 0,
"StopProcessExpression": "",
"StopStrategy": null,
"ExternalJobKey": "af486c19-c797-48cd-b586-cfb7a12110a2",
"TimeZoneId": "Morocco Standard Time",
"TimeZoneIana": "Africa/Casablanca",
"UseCalendar": false,
"StopProcessDate": null,
"InputArguments": "{\"arrayStrings\":[\"test\",\"test\"],\"age\":666,\"trueOrFalse\":false,\"dateNow\":\"2012-04-23T18:25:43.511Z\",\"stringNew\":\"stringTest\",\"DoubleTest\":7.555555}",
"Id": 37
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#ProcessSchedules/$entity",
"Enabled": true,
"Name": "API_schedule_test",
"ReleaseId": 55,
"ReleaseKey": "00000000-0000-0000-0000-000000000000",
"ReleaseName": null,
"PackageName": null,
"EnvironmentName": null,
"EnvironmentId": "0",
"StartProcessCron": "0 0/5 * 1/1 * ? *",
"StartProcessCronDetails": "{\"type\":0,\"minutely\":{\"atMinute\":5},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"\"}",
"StartProcessCronSummary": "Every 5 minutes",
"StartProcessNextOccurrence": null,
"StartStrategy": 0,
"StopProcessExpression": "",
"StopStrategy": null,
"ExternalJobKey": "7ecbff8d-832d-41e1-a3ed-aee0957caffe",
"TimeZoneId": "Morocco Standard Time",
"TimeZoneIana": "Africa/Casablanca",
"UseCalendar": false,
"StopProcessDate": null,
"InputArguments": "{\"arrayStrings\":[\"test\",\"test\"],\"age\":666,\"trueOrFalse\":false,\"dateNow\":\"2012-04-23T18:25:43.511Z\",\"stringNew\":\"stringTest\",\"DoubleTest\":7.555555,\"inOutTry\":\"2012-04-23T18:25:43.511Z\"}",
"Id": 37
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#ProcessSchedules/$entity",
"Enabled": true,
"Name": "API_schedule_test",
"ReleaseId": 55,
"ReleaseKey": "00000000-0000-0000-0000-000000000000",
"ReleaseName": null,
"PackageName": null,
"EnvironmentName": null,
"EnvironmentId": "0",
"StartProcessCron": "0 0/5 * 1/1 * ? *",
"StartProcessCronDetails": "{\"type\":0,\"minutely\":{\"atMinute\":5},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"\"}",
"StartProcessCronSummary": "Every 5 minutes",
"StartProcessNextOccurrence": null,
"StartStrategy": 0,
"StopProcessExpression": "",
"StopStrategy": null,
"ExternalJobKey": "7ecbff8d-832d-41e1-a3ed-aee0957caffe",
"TimeZoneId": "Morocco Standard Time",
"TimeZoneIana": "Africa/Casablanca",
"UseCalendar": false,
"StopProcessDate": null,
"InputArguments": "{\"arrayStrings\":[\"test\",\"test\"],\"age\":666,\"trueOrFalse\":false,\"dateNow\":\"2012-04-23T18:25:43.511Z\",\"stringNew\":\"stringTest\",\"DoubleTest\":7.555555,\"inOutTry\":\"2012-04-23T18:25:43.511Z\"}",
"Id": 37
}