- Introduçã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
- Processar solicitações de política de retenção de dados
- Solicitações de itens de fila
- Solicitações da política de retenção de filas
- Solicitações de robôs
- Solicitações de funções
- Solicitações de agendamentos
- Solicitações de configurações
- Solicitações de bucket de armazenamento
- 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
Solicitações de pacotes
Obter
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='QueueItemsProcessing')
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Processes",
"@odata.count": 2,
"value": [
{
"IsActive": true,
"SupportsMultipleEntryPoints": false,
"MainEntryPointPath": null,
"RequiresUserInteraction": true,
"TargetFramework": "Legacy",
"Title": null,
"Version": "1.0.6981.35861",
"Key": "QueueItemsProcessing:1.0.6981.35861",
"Description": "Process items from an Orchestrator queue.",
"Published": "2021-07-23T16:40:07.793Z",
"IsLatestVersion": false,
"OldVersion": null,
"ReleaseNotes": null,
"Authors": "petrina.calota",
"ProjectType": "Undefined",
"Tags": null,
"Id": "QueueItemsProcessing",
"Arguments": {
"Input": "[{\"name\":\"argument1\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"argument2\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"argument3\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
"Output": null
}
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Processes",
"@odata.count": 2,
"value": [
{
"IsActive": true,
"SupportsMultipleEntryPoints": false,
"MainEntryPointPath": null,
"RequiresUserInteraction": true,
"TargetFramework": "Legacy",
"Title": null,
"Version": "1.0.6981.35861",
"Key": "QueueItemsProcessing:1.0.6981.35861",
"Description": "Process items from an Orchestrator queue.",
"Published": "2021-07-23T16:40:07.793Z",
"IsLatestVersion": false,
"OldVersion": null,
"ReleaseNotes": null,
"Authors": "petrina.calota",
"ProjectType": "Undefined",
"Tags": null,
"Id": "QueueItemsProcessing",
"Arguments": {
"Input": "[{\"name\":\"argument1\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"argument2\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"argument3\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
"Output": null
}
}
]
}
A solicitação abaixo permite que você baixe o pacote com o nome "add_queue_items" e a versão 1.0.6654.27080.
Obter
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Processes/UiPath.Server.Configuration.OData.DownloadPackage(key='add_queue_items:1.0.6654.27080')
/odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='key')
retorna todos os argumentos de entrada e saída de um pacote específico, seu tipo e se eles têm um valor padrão. Os argumentos In, Out ou In/Out de um projeto tornam-se parâmetros de entrada e saída no Orchestrator.
Obter
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='input_output_test%3A1.3.5')
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Core.Arguments.ArgumentMetadata",
"Input": "[\r\n {\r\n \"name\": \"age\",\r\n \"type\": \"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n },\r\n {\r\n \"name\": \"Array\",\r\n \"type\": \"System.Int32[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": true\r\n },\r\n {\r\n \"name\": \"trueOrFalse\",\r\n \"type\": \"System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": true\r\n },\r\n {\r\n \"name\": \"dateNow\",\r\n \"type\": \"System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": true\r\n },\r\n {\r\n \"name\": \"stringNew\",\r\n \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n },\r\n {\r\n \"name\": \"arrayStrings\",\r\n \"type\": \"System.String[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n },\r\n {\r\n \"name\": \"inOutTry\",\r\n \"type\": \"System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n }\r\n]",
"Output": "[\r\n {\r\n \"name\": \"output\",\r\n \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\"\r\n },\r\n {\r\n \"name\": \"inOutTry\",\r\n \"type\": \"System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\"\r\n }\r\n]"
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Core.Arguments.ArgumentMetadata",
"Input": "[\r\n {\r\n \"name\": \"age\",\r\n \"type\": \"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n },\r\n {\r\n \"name\": \"Array\",\r\n \"type\": \"System.Int32[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": true\r\n },\r\n {\r\n \"name\": \"trueOrFalse\",\r\n \"type\": \"System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": true\r\n },\r\n {\r\n \"name\": \"dateNow\",\r\n \"type\": \"System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": true\r\n },\r\n {\r\n \"name\": \"stringNew\",\r\n \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n },\r\n {\r\n \"name\": \"arrayStrings\",\r\n \"type\": \"System.String[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n },\r\n {\r\n \"name\": \"inOutTry\",\r\n \"type\": \"System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n }\r\n]",
"Output": "[\r\n {\r\n \"name\": \"output\",\r\n \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\"\r\n },\r\n {\r\n \"name\": \"inOutTry\",\r\n \"type\": \"System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\"\r\n }\r\n]"
}
/odata/Processes/UiPath.Server.Configuration.OData.SetArguments
.
Essa chamada substitui todos os parâmetros anteriores e oferece validação.
Além disso, observe que esse ponto de extremidade pode ser usado para alterar os parâmetros de entrada e saída de um pacote de automação somente se você não o carregou no Orchestrator por meio da API, da página Pacotes ou do feed NuGet.
Se você desejar atualizar apenas os valores dos parâmetros de entrada, poderá fazê-lo no nível do processo, no nível do trabalho e/ou no nível do agendamento.
Postar
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Processes/UiPath.Server.Configuration.OData.SetArguments
{
"key": "input_output_test:1.3.6",
"arguments": {
"Input": "[{\"name\":\"arg1\", \"type\": \"System.String\", \"required\": false}]",
"Output": "[{\"name\":\"outputArg\", \"type\":\"System.String\", \"required\":false}]"
}
}
{
"key": "input_output_test:1.3.6",
"arguments": {
"Input": "[{\"name\":\"arg1\", \"type\": \"System.String\", \"required\": false}]",
"Output": "[{\"name\":\"outputArg\", \"type\":\"System.String\", \"required\":false}]"
}
}
Obter
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Processes
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Processes",
"@odata.count": 2,
"value": [
{
"IsActive": false,
"SupportsMultipleEntryPoints": false,
"MainEntryPointPath": null,
"RequiresUserInteraction": true,
"TargetFramework": "Legacy",
"Title": null,
"Version": "1.0.6981.35861",
"Key": "QueueItemsProcessing:1.0.6981.35861",
"Description": "Process items from an Orchestrator queue.",
"Published": "2021-07-23T16:40:07.7933333Z",
"IsLatestVersion": false,
"OldVersion": null,
"ReleaseNotes": null,
"Authors": "petrina.calota",
"ProjectType": "Undefined",
"Tags": null,
"Id": "QueueItemsProcessing",
"Arguments": {
"Input": "[{\"name\":\"argument1\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"argument2\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"argument3\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
"Output": null
}
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Processes",
"@odata.count": 2,
"value": [
{
"IsActive": false,
"SupportsMultipleEntryPoints": false,
"MainEntryPointPath": null,
"RequiresUserInteraction": true,
"TargetFramework": "Legacy",
"Title": null,
"Version": "1.0.6981.35861",
"Key": "QueueItemsProcessing:1.0.6981.35861",
"Description": "Process items from an Orchestrator queue.",
"Published": "2021-07-23T16:40:07.7933333Z",
"IsLatestVersion": false,
"OldVersion": null,
"ReleaseNotes": null,
"Authors": "petrina.calota",
"ProjectType": "Undefined",
"Tags": null,
"Id": "QueueItemsProcessing",
"Arguments": {
"Input": "[{\"name\":\"argument1\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"argument2\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"argument3\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
"Output": null
}
}
]
}
- Recuperando todas as versões disponíveis para um pacote específico
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Baixando uma versão específica do pacote
- Cabeçalhos de solicitação.
- Código de resposta
- Recuperar Argumentos de um Pacote
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Alterando os Parâmetros no Nível do Pacote
- Cabeçalhos de solicitação.
- Corpo da Solicitação
- Código de resposta
- Recuperando Pacotes
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta