orchestrator
latest
false
UiPath logo, featuring letters U and I in white

Guia da API do Orchestrator

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Última atualização 20 de nov de 2024

Solicitações de ativos

Observação: os ativos de texto globais e por robô suportam até 1.000.000 de caracteres.
Importante:
  1. As consultas $filter retornarão o resultado de um filtro personalizado que usa os parâmetros Nome e Descrição em uma função contains.
  2. Solicitações de ativos que expandem os valores que o UiPath Robot (GET "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Assets/UiPath.Server.Configuration.OData.GetFiltered?%24expand=UserValues") primeiro recupera UserValues, que depois se transformam em RobotValues.

Recuperando um Ativo Específico

A chamada abaixo permite exibir todas as informações disponíveis para o ativo com o nome DocAPITest e o ID 455 .

Obter

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId='455',assetName='DocAPITest')

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Código de resposta

200 OK

Corpo da Resposta

{
    "@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
    "Name": "DocAPITest",
    "ValueType": "Text",
    "StringValue": "An asset added through an API call",
    "BoolValue": false,
    "IntValue": 0,
    "CredentialUsername": "",
    "CredentialPassword": ""
}{
    "@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
    "Name": "DocAPITest",
    "ValueType": "Text",
    "StringValue": "An asset added through an API call",
    "BoolValue": false,
    "IntValue": 0,
    "CredentialUsername": "",
    "CredentialPassword": ""
}

Recuperando ativos por robô

Para executar uma solicitação GET para o endpoint /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId() , você precisa fornecer o robotId e o assetName no URL. Observe que apenas o nome de usuário é retornado para ativos de credencial por robô, como você pode ver no exemplo abaixo.

Obter

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId(robotId=193,assetName='Testing')

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Código de resposta

200 OK

Corpo da Resposta

{
  "@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
  "Name": "Testing",
  "ValueType": "Credential",
  "StringValue": "",
  "BoolValue": false,
  "IntValue": 0,
  "CredentialUsername": "DocBot",
  "CredentialPassword": ""
}{
  "@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
  "Name": "Testing",
  "ValueType": "Credential",
  "StringValue": "",
  "BoolValue": false,
  "IntValue": 0,
  "CredentialUsername": "DocBot",
  "CredentialPassword": ""
}

Adicionando um ativo

O exemplo a seguir permite criar um novo ativo global, do tipo texto.

Postar

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Assets

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Corpo da Solicitação

{
    "Name": "DocAPITest",
    "ValueScope": "Global",
    "ValueType": "Text", 
    "StringValue": "An asset added through an API call"
}{
    "Name": "DocAPITest",
    "ValueScope": "Global",
    "ValueType": "Text", 
    "StringValue": "An asset added through an API call"
}

Código de resposta

200 OK

Corpo da Resposta

{
    "@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Assets/$entity",
    "Name": "DocAPITest",
    "CanBeDeleted": true,
    "ValueScope": "Global",
    "ValueType": "Text",
    "Value": "An asset added through an API call",
    "StringValue": "An asset added through an API call",
    "BoolValue": false,
    "IntValue": 0,
    "CredentialUsername": "",
    "CredentialPassword": "",
    "Id": 455,
    "KeyValueList": []
}{
    "@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Assets/$entity",
    "Name": "DocAPITest",
    "CanBeDeleted": true,
    "ValueScope": "Global",
    "ValueType": "Text",
    "Value": "An asset added through an API call",
    "StringValue": "An asset added through an API call",
    "BoolValue": false,
    "IntValue": 0,
    "CredentialUsername": "",
    "CredentialPassword": "",
    "Id": 455,
    "KeyValueList": []
}

Esta página foi útil?

Obtenha a ajuda que você precisa
Aprendendo RPA - Cursos de automação
Fórum da comunidade da Uipath
Uipath Logo White
Confiança e segurança
© 2005-2024 UiPath. Todos os direitos reservados.