Solicitações de agendamentos

Iniciando uma programação com alocação dinâmica de robôs

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.

O parâmetro StartStrategy permite escolher como deseja executar o trabalho.

Possible values forStartStrategy

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}, {"Id" : 44882} ]	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

{OrchestratorURL}/odata/ProcessSchedules

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador

Corpo da Solicitação

{
  "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"
}

Observação:

Para determinar o valor correto para o parâmetro TimeZoneId , faça uma solicitação GET para o endpoint /odata/Settings/UiPath.Server.Configuration.OData.GetTimezones . Na resposta, localize a entrada para o seu fuso horário e copie a string no campo Value . Em seguida, quando criar o agendamento, use a string como o valor do parâmetro TimeZoneId no corpo da solicitação.

Código de resposta

200 OK

Corpo da Resposta

{
    "@odata.context": "{OrchestratorURL}/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
}

Iniciando um cronograma com valores de parâmetros de entrada

A solicitação POST a seguir para o terminal /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.

Observação:

Um máximo de 10.000 caracteres é aceito para toda a extensão da representação JSON de parâmetros de entrada, incluindo nomes de argumentos, todos os caracteres escapados, espaços, parênteses, e valores de argumentos.

Postar

{OrchestratorURL}/odata/ProcessSchedules

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador

Corpo da Solicitação

{
      "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
    }

Observação:

Para determinar o valor correto para o parâmetro TimeZoneId , faça uma solicitação GET para o endpoint /odata/Settings/UiPath.Server.Configuration.OData.GetTimezones . Na resposta, localize a entrada para o seu fuso horário e copie a string no campo Value . Em seguida, quando criar o agendamento, use a string como o valor do parâmetro TimeZoneId no corpo da solicitação.

Código de resposta

200 OK

Corpo da Resposta

{
    "@odata.context": "{OrchestratorURL}/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
}