- Primeros pasos
- Definición de Swagger
- API de Orchestrator
- Solicitudes de alertas
- Solicitudes de tareas de aplicaciones
- Solicitudes de activos
- Solicitudes de calendario
- Solicitudes de entornos
- Solicitudes de carpetas
- Solicitudes de tareas genéricas
- Solicitudes de trabajos
- Solicitudes de bibliotecas
- Solicitudes de licencia
- Solicitudes de paquetes
- Solicitudes de permisos
- Solicitudes de espacios de trabajo personales
- Solicitudes de procesos
- Procesar solicitudes de política de retención de datos
- Solicitudes de elementos en cola
- Solicitudes de política de retención de cola
- Solicitudes de robots
- Solicitudes de roles
- Solicitudes de horarios
- Solicitudes de configuración
- Solicitudes de cubos de almacenamiento
- Solicitudes de tareas
- Solicitudes de catálogos de tareas
- Solicitudes de formularios de tareas
- Solicitudes de tenants
- Solicitudes de transacciones
- Solicitudes de usuario
- Solicitudes de Webhooks
Guía de la API de Orchestrator
Los activos de texto globales y por robot admiten hasta 1 millón de caracteres.
- Las consultas
$filterdevuelven el resultado de un filtro personalizado que utiliza los parámetros Nombre y Descripción en una funcióncontains.
Recuperar un Activo específico
La siguiente llamada le permite mostrar toda la información disponible para el activo con el nombre 455 DocAPITest la ID.
Obtener
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId='455',assetName='DocAPITest')
Solicitar encabezados.
| Clave | Valor |
|---|---|
| Autorización | Portador |
Código de respuesta
200 OK
Cuerpo de respuesta
{
"@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": ""
}
{
"@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.
Obtener
/api/Assets/name/{name}/value
Solicitar encabezados.
| Clave | Valor |
|---|---|
| Autorización | Portador |
| X-UIPATH-OrganizationUnitId | ID de carpeta |
Solicitud de ejemplo
GET /api/Assets/name/Testing/value
Authorization: Bearer {access_token}
X-UIPATH-OrganizationUnitId: {folderId}
GET /api/Assets/name/Testing/value
Authorization: Bearer {access_token}
X-UIPATH-OrganizationUnitId: {folderId}
Código de respuesta
200 OK
Cuerpo de respuesta
{
"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
}
{
"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
}
Recuperar activos por robot
Para realizar una solicitud GET al punto final /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId() , debes proporcionar robotId y assetName en la URL. Ten en cuenta que solo se devuelve el nombre de usuario para los activos de credenciales por robot, como puedes ver en el siguiente ejemplo.
Obtener
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId(robotId=193,assetName='Testing')
Solicitar encabezados.
| Clave | Valor |
|---|---|
| Autorización | Portador |
Código de respuesta
200 OK
Cuerpo de respuesta
{
"@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": ""
}
{
"@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": ""
}
Añadir un activo
El siguiente ejemplo te permite crear un nuevo activo global de tipo texto.
Publicar
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Assets
Solicitar encabezados.
| Clave | Valor |
|---|---|
| Autorización | Portador |
Solicitar cuerpo
{
"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 respuesta
200 OK
Cuerpo de respuesta
{
"@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": []
}
{
"@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": []
}
- Recuperar un Activo específico
- Solicitar encabezados.
- Código de respuesta
- Cuerpo de respuesta
- Retrieving a specific asset by name
- Solicitar encabezados.
- Solicitud de ejemplo
- Código de respuesta
- Cuerpo de respuesta
- Recuperar activos por robot
- Solicitar encabezados.
- Código de respuesta
- Cuerpo de respuesta
- Añadir un activo
- Solicitar encabezados.
- Solicitar cuerpo
- Código de respuesta
- Cuerpo de respuesta