Solicitações de ativos

Observação:

Os ativos de texto do tipo Global e Por robô são compatíveis com até 1.000.000 caracteres.

Importante:

• 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 .

Recuperação de 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

{AutomationCloudURL}/{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": "{AutomationCloudURL}/{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": ""
}

Retrieving a specific asset by name

You can retrieve a specific asset by its name using the GetAssetByName endpoint. This is useful when you already know the asset name and want to fetch its value outside of an automation workflow.

Obter

/api/Assets/name/{name}/value

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador
X-UIPATH-OrganizationUnitId	ID da Pasta

Exemplo de solicitação

GET /api/Assets/name/Testing/value
Authorization: Bearer {access_token}
X-UIPATH-OrganizationUnitId: {folderId}

Código de resposta

200 OK

Corpo da Resposta

{
  "Name": "Testing",
  "ValueType": "Credential",
  "Value": "username: Testing",
  "StringValue": "",
  "BoolValue": false,
  "IntValue": 0,
  "SecretValue": "",
  "CredentialUsername": "Testing",
  "CredentialPassword": "Testing",
  "ExternalName": null,
  "CredentialStoreId": 1,
  "KeyValueList": [],
  "ConnectionData": null,
  "Id": 1
}

Recuperação de 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

{AutomationCloudURL}/{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": "{AutomationCloudURL}/{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

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

Código de resposta

200 OK

Corpo da Resposta

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