- 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
- 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
Guia da API do Orchestrator
Códigos de resposta
A API do Orchestrator tenta retornar códigos de status HTTP apropriados para cada solicitação.
Além disso, a API do Orchestrator também retorna alguns códigos de erro personalizados. A tabela abaixo descreve cada um desses erros e quando você pode encontrá-los.
Código |
Texto |
Description |
---|---|---|
1000 |
Solicitação inválida! Nome de usuário/endereço de e-mail ou senha inválidos. Opções de consulta do OData inválidas. |
Genérico |
1001 |
O nome [CustomNameYouAdded] já está sendo usado. |
Uma mensagem de erro lançada se você tentar criar ou editar um recurso com um nome que já existe no banco de dados. Este erro é retornado para os seguintes endpoints:
|
1002 |
O Robô não existe. |
Uma mensagem de erro lançada se você fizer uma solicitação para um recurso que não existe no banco de dados. Ele é retornado para inquilinos, ativos, trabalhos, licenças de host, filas e itens de fila, processos, configurações e usuários. |
1003 |
Falha na chamada de proteção para a cadeia de caracteres fornecida. |
|
1004 |
|
Esta mensagem é lançada se você tentar criar um ativo ou robô que já existe no banco de dados. Isso também se aplica ao upload de um pacote. |
1006 |
|
|
1007 |
|
Este erro é exibido se você tentar atualizar um comentário de transação que foi adicionado por um usuário diferente, fazendo uma solicitação PUT para o endpoint
/odata/QueueItemComments(Id) .
|
1008 |
|
Um erro gerado se o Orchestrator falhou ao enviar um e-mail para um usuário ao executar uma solicitação POST, PUT ou PATCH para o ponto e extremidae
/odata/Users .
|
1009 |
Argumento inválido [ArgumentName]. | |
1010 |
| |
1011 |
Não é possível abrir o feed de bibliotecas. Tente novamente mais tarde. |
Esta mensagem é exibida se o feed das bibliotecas não puder ser acessado por vários motivos. O erro pode ser retornado pelos seguintes endpoints:
|
1012 |
|
Este erro é gerado se a unidade organizacional que você está tentando excluir tiver usuários associados a ela. Este é um erro exibido ao fazer uma chamada DELETE para o endpoint
/odata/OrganizationUnits .
|
1013 |
O pacote é referido nos processos ativos e não pode ser excluído. |
Um erro exibido ao tentar excluir uma versão do pacote que está ativa, como uma solicitação DELETE para https:/uipath.platform.com/odata/Processes('input_output_test%3A1.1.0'). Somente pacotes inativos (não associados a um ambiente) podem ser removidos. |
1014 |
O parâmetro [ParameterName] está ausente. |
Este é um erro genérico gerado quando um parâmetro obrigatório não foi fornecido. Esse erro pode ser exibido para os seguintes endpoints:
|
1015 |
O parâmetro [ParameterName] é inválido. O valor deve estar entre 0 e 168. |
Esse erro é exibido nas seguintes situações:
|
1016 |
Erro ao criar [ReferenceName]. Referência duplicada. (Exemplo: Erro ao criar UiPath.Core.Model.Queues.UiQueueItem. Referência duplicada.) |
Este erro é exibido se você tentou adicionar um item de fila com uma referência que já existe. Isso ocorre apenas se você definir sua fila para trabalhar apenas com referências exclusivas. |
1017 |
Não é permitido baixar o pacote especificado. Os Termos e Condições devem ser aceitos. |
Uma mensagem exibida se o usuário com o qual você está autenticado não tiver direitos para baixar um pacote ou biblioteca específica, executando solicitações GET para
/odata/Processes/UiPath.Server.Configuration.OData.DownloadPackage(key='key') ou `/odata/Libraries/UiPath.Server.Configuration.OData.DownloadPackage(key= '{chave
|
1018 |
Não é possível conectar ao domínio do AD. O usuário não existe. |
Esta mensagem de erro é exibida quando você está tentando importar um usuário AD que não é membro do domínio especificado. |
1050 |
Não é possível incluir o relacionamento especificado. |
Auditar |
1100 |
O usuário não está mais associado à unidade organizacional. |
Exibido apenas se as unidades de organização estiverem habilitadas. Este erro é exibido se você está tentando fazer chamadas usando um usuário que está associado a uma unidade organizacional diferente daquela que você está tentando acessar. |
1101 |
|
Exibido apenas se as unidades organizacionais estiverem habilitadas em sua instância do orquestrador. O erro é gerado ao fazer solicitações POST endpoint sem incluir uma unidade organizacional como parâmetro. |
1102 |
A unidade organizacional não existe ou não está mais associada ao usuário. |
Exibido apenas se as unidades de organização estiverem habilitadas. Esta mensagem de erro é lançada ao fazer uma solicitação POST para o terminal
/odata/Users(Id)/UiPath.Server.Configuration.OData.ToggleOrganizationUnit se o usuário com o qual você está autenticado não estiver associado à unidade organizacional fornecida como um parâmetro ou não existir.
|
1200 |
Nesta máquina já existe um robô com uma chave de licença diferente. |
Essa mensagem de erro é exibida se um robô já estiver presente na máquina especificada com uma chave de licença diferente. Ele é lançado para os seguintes endpoints:
|
1201 |
|
Essa mensagem de erro é lançada se não houver mais licenças no Orchestrator para o robô no qual você está tentando iniciar um trabalho. |
1202 |
A máquina [MachineName] não pode ser excluída porque tem robôs anexados a ela. |
Essa mensagem de erro é lançada se você estiver tentando excluir uma máquina que tenha robôs definidos nela. |
1203 |
Chave de licença inválida. A chave de máquina está vinculada a outra máquina! |
Robôs |
1204 |
|
Robôs |
1205 |
Se a senha for definida, será necessário um nome de usuário. | |
1206 |
Os robôs ocupados não podem ser modificados nem excluídos. |
Esta mensagem é exibida se você estiver tentando excluir um robô que está executando um trabalho no momento. |
1207 |
|
Robôs |
1208 |
MachineLicenseCannotChange ;
InvalidNonProductionMachineSlots ;
InvalidUnattendedMachineSlots .
|
Robôs |
1209 |
Não é possível atualizar o Nome de Usuário, a Máquina ou o Tipo de um Robô ocupado! |
Essa mensagem é exibida se você estiver tentando atualizar um Robô que está atualmente executando um trabalho. |
1222 |
|
Este é um alerta acionado quando um robô se desconecta do orquestrador. |
1223 |
|
Este é um alerta que é acionado quando um robô conectado ao Orchestrator deixa de responder. |
1250 |
|
Essa mensagem de erro é lançada nos seguintes casos:
|
1300 |
|
Conflito (409) |
1301 |
|
Conflito (409) |
1302 |
|
Conflito (409) |
1400 |
|
Autorização, Usuários, Funções |
1401 |
|
Autorização, Usuários, Funções |
1403 |
Alterar Senha |
Autorização, Usuários, Funções |
1404 |
A senha expirou. |
Esta mensagem de erro é exibida quando a senha com a qual você está tentando fazer login expirou. |
1405 |
|
Autorização, Usuários, Funções |
1406 |
|
Esta mensagem é exibida se você estiver tentando excluir a função Administrador. |
1407 |
|
O usuário com o qual você está autenticado no momento não tem o direito de editar o usuário indicado. |
1408 |
|
Autorização, Usuários, Funções |
1409 |
|
Essa mensagem de erro é exibida se o procedimento de redefinição de senha falhou. |
1410 |
Falha na confirmação do email. | |
1411 |
|
Este erro é retornado se você estiver tentando usar uma senha antiga durante o procedimento de redefinição de senha. |
1412 |
|
Essa mensagem é exibida se você estiver tentando fazer alterações na função Administrador, que não é editável. |
1413 |
|
Este erro é gerado se o usuário do domínio que você está tentando fornecer ao Orchestrator não pertencer ao Active Directory definido. |
1414 |
Não é possível atualizar o Username! |
Autorização, Usuários, Funções |
1415 |
|
Autorização, Usuários, Funções |
1500 |
O ativo da credencial não pode ter uma senha vazia para um novo usuário. | |
1501 |
O ativo Credential não pode ter uma senha fazia para um robô novo. |
Essa mensagem será exibida se, ao criar um ativo de credencial, você também não fornecer um valor para a senha. |
1502 |
Não é possível atualizar o tipo de ativo. |
Este erro é gerado se você estiver tentando alterar o tipo de ativo por meio de uma solicitação PUT. |
1503 |
O ativo não tem um valor associado a este robô. |
Esta mensagem é exibida se a solicitação feita for para um ativo PerRobot, mas o Robô fornecido não estiver associado ao ativo fornecido. |
1600 |
Sintaxe inválida da expressão cron. |
A programação que você tentou adicionar contém uma expressão Cron que não é válida. |
1601 |
| |
1650 |
|
Processos/Pacotes/Trabalhos |
1651 |
Não é possível conectar ao feed de pacotes, a URL pode ser inválida. |
Processos/Pacotes/Trabalhos |
1652 |
Não é compatível com Feeds Externos. |
Processos/Pacotes/Trabalhos |
1653 |
|
Processos/Pacotes/Trabalhos |
1654 |
Detalhes de pacote inválidos! |
Processos/Pacotes/Trabalhos |
1655 |
Não é possível abrir o feed de pacote. Tente novamente mais tarde. |
Processos/Pacotes/Trabalhos |
1656 |
|
Processos/Pacotes/Trabalhos |
1657 |
|
Processos/Pacotes/Trabalhos |
1658 |
Não é possível cancelar um trabalho com o status [Status]. Isso só pode ser aplicado a trabalhos em Execução, Pendentes, ou Parados. |
Esta mensagem é exibida se você estiver tentando cancelar um trabalho que possui um dos seguintes status: Bem-sucedido, Com falha, Encerrando, Interrompido. |
1659 |
Não é possível encerrar um trabalho com o status [Status]. Isso só pode ser aplicado a trabalhos em Execução, Pendentes, ou Parados. |
Esse erro é exibido se você estiver tentando cancelar um trabalho que tem um dos seguintes status: Bem-sucedido, Com Falha, Parado. |
1660 |
O pacote do trabalho [PackageName], versão [VersionNumber] não foi encontrado. |
Esse erro é gerado se, ao tentar iniciar um trabalho, o pacote com a versão indicada não for encontrado no feed do NuGet. |
1661 |
ProcessNotFound ,
PackageNotFound .
O processo associado não existe mais. |
Processos/Pacotes/Trabalhos |
1662 |
|
Processos/Pacotes/Trabalhos |
1663 |
|
Processos/Pacotes/Trabalhos |
1664 |
|
Processos/Pacotes/Trabalhos |
1665 |
|
Processos/Pacotes/Trabalhos |
1666 |
|
Processos/Pacotes/Trabalhos |
1667 |
Tenant não encontrado. | |
1670 |
Os robôs já têm tarefas pendentes para este Processo. |
Esta mensagem é exibida quando você já tem um trabalho pendente no mesmo processo e robô. |
1671 |
Os ID(s) do(s) robô(s) especificado(s) são inválidos. |
Processos/Pacotes/Trabalhos |
1672 |
Não é possível iniciar tarefas. É necessária uma licença válida. |
Processos/Pacotes/Trabalhos |
1673 |
Licença expirada. Não é mais possível iniciar tarefas. |
Processos/Pacotes/Trabalhos |
1674 |
Processo indefinido. |
O id do processo no qual você está tentando iniciar um trabalho não é válido. |
1675 |
Versão de pacote inválida. |
Processos/Pacotes/Trabalhos |
1676 |
O inquilino [NameOfTenant] está desativado! |
Processos/Pacotes/Trabalhos |
1677 |
PackageNotFound | |
1678 |
|
Este erro é lançado se não houver robôs disponíveis para um agendamento e, portanto, nenhum trabalho pode ser criado. |
1679 |
PathTooLong | |
1680 |
|
Este alerta é gerado quando um trabalho falha. |
1700 |
|
Componentes de terceiros |
1750 |
|
Logs |
1800 |
|
Configuração |
1801 |
A chave de criptografia configurada não está no formato Base64 válido. |
Configuração |
1850 |
|
Item de fila/fila |
1851 |
|
O estado de andamento da transação que você está tentando atualizar não é o correto para a atualização que você deseja realizar. |
1852 |
|
Item de fila/fila |
1853 |
|
O usuário que você está tentando atribuir como revisor de uma transação não possui a permissão necessária (Visualizar e Editar transações). |
1855 |
|
Item de fila/fila |
1856 |
|
Essa mensagem de erro é exibida se um aplicativo for lançado para um item e não for mais repetido. |
1900 |
Licença não encontrada. |
Licença |
1901 |
Licença expirada! |
Licença |
1902 |
A licença já está em uso! |
Licença |
1903 |
Formato de licença inválido. |
Licença |
1904 |
|
Licença |
1905 |
|
Licença |
1906 |
|
Licença |
1907 |
|
Licença |
1908 |
|
Licença |
1909 |
|
Licença |
1910 |
|
Licença |
1911 |
|
Licença |
1912 |
|
Licença |
1913 |
|
Licença |
1914 |
O Licenciamento do Robô falhou. Não há licenças disponíveis no servidor. |
Esta mensagem de erro é exibida nos detalhes do trabalho se você tentou executar um trabalho em uma máquina que não está licenciada, o trabalho tem o estado Pendente, um robô atribuído. |
1915 |
O Licenciamento do Robô falhou. Não há licenças disponíveis no servidor. |
|
1916 |
Não há licenças disponíveis: o número de novos slots de máquina excederia a contagem total de licenças. |
Licença |
1917 |
Não há {0 suficiente |
Licença |
1918 |
|
Licença |
1919 |
|
Licença |
1920 |
|
Licença |