Solicitudes de robots

Recuperar estados de robots

Nota:

Si quieres extraer el valor del parámetro LicenseKey, debes realizar una solicitud GET al punto final /odata/Robots(Id).

Según su ID

El siguiente ejemplo le permite ver el estado actual del Robot con el 749 Id.

Obtener

https://{yourDomain}/odata/Sessions?$top=10&$filter=Robot/Id eq 749&$select=State

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Código de respuesta

200 OK

Cuerpo de respuesta

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Sessions(State)",
    "@odata.count": 1,
    "value": [
        {
            "State": "Available"
        }
    ]
}

Por su nombre

El siguiente ejemplo te permite ver el estado actual del UiPath Robot con el Nombre de DocBot.

Obtener

https://{yourDomain}/odata/Sessions?$top=10&$filter=Robot/Name eq 'DocBot'&$select=State

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Código de respuesta

200 OK

Cuerpo de respuesta

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Sessions(State)",
    "@odata.count": 1,
    "value": [
        {
            "State": "Available"
        }
    ]
}

Recuperar información del robot según su estado: ejemplo 1

El siguiente ejemplo solicita los primeros 10 Robots que tienen el estado Disponible y enviaron un latido en los últimos 2 minutos. Solo se muestra la información relevante del robot. Puedes comprobar los latidos mediante el parámetro Tiempo de informe y restar 2 minutos de la hora actual. Como sabrá, si un robot no ha enviado un latido en los últimos 2 minutos, se marca como que no responde.

Obtener

https://{yourDomain}/odata/Sessions?$top=10&$filter=State eq 'Available' and ReportingTime gt 2018-03-05T03:48:04.147Z&$select=Robot&$expand=Robot

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Código de respuesta

200 OK

Cuerpo de respuesta

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Sessions(Robot)",
    "@odata.count": 2,
    "value": [
        {
            "Robot": {
                    "LicenseKey": null,
                "MachineName": "MBOBOC",
                "Name": "DocBot",
                "Username": "UIPATH\\MADALINA.BOBOC",
                "Description": null,
                "Type": "NonProduction",
                "Password": null,
                "RobotEnvironments": "doc_env,WR_env,Group1",
                "Id": 749,
                "ExecutionSettings": null
            }
        },
        {
            "Robot": {
                    "LicenseKey": null,
                "MachineName": "midragomir",
                "Name": "mr-Rob",
                "Username": "uipath\\mircea.dragomir",
                "Description": "Alerts",
                "Type": "NonProduction",
                "Password": null,
                "RobotEnvironments": "",
                "Id": 902,
                "ExecutionSettings": null
            }
        }
    ]
}

Recuperar Información de UiPath Robot por su estado: ejemplo 2

El siguiente ejemplo busca los 10 principales robots que tienen el estado Desconectado y expande la información del robot.

Obtener

https://{yourDomain}/odata/Sessions?$top=10&$filter=State eq 'Disconnected'&$expand=Robot

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Código de respuesta

200 OK

Cuerpo de respuesta

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Sessions",
    "@odata.count": 2,
    "value": [
        {
            "State": "Disconnected",
            "ReportingTime": "2018-01-15T18:47:07.93Z",
            "Info": null,
            "IsUnresponsive": false,
            "Id": 718,
            "Robot": {
                    "LicenseKey": null,
                "MachineName": "DESKTOP-PMFQGCB",
                "Name": "Stan",
                "Username": "Alex",
                "Description": null,
                "Type": "Unattended",
                "Password": null,
                "RobotEnvironments": "doc_env,a_invoke_env,Group1",
                "Id": 759,
                "ExecutionSettings": null
            }
        },
        {
            "State": "Disconnected",
            "ReportingTime": "2018-01-18T18:14:14.34Z",
            "Info": null,
            "IsUnresponsive": false,
            "Id": 730,
            "Robot": {
                    "LicenseKey": null,
                "MachineName": "DESKTOP-PMFQGCB",
                "Name": "!~#$%^&*()_+=-",
                "Username": "dragomirmir",
                "Description": null,
                "Type": "NonProduction",
                "Password": null,
                "RobotEnvironments": "WR_env",
                "Id": 771,
                "ExecutionSettings": null
            }
        }
    ]
}

Recuperar información del robot según su ID

El siguiente ejemplo recupera los detalles del Robot con el Id. 216. Tenga en cuenta que este robot utiliza autenticación con tarjeta inteligente.

Obtener

https://{yourDomain}/odata/Robots(216)

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Código de respuesta

200 OK

Cuerpo de respuesta

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Robots/$entity",
    "LicenseKey": "fc157179-3724-4bb0-acd2-8261bef82d01",
    "MachineName": "CAPETRINA",
    "MachineId": 15,
    "Name": "Gustavee",
    "Username": "uipath\\john.smith",
    "ExternalName": null,
    "Description": null,
    "Type": "Development",
    "HostingType": "Standard",
    "ProvisionType": "Manual",
    "Password": null,
    "CredentialStoreId": null,
    "UserId": 45,
    "Enabled": true,
    "CredentialType": null,
    "RobotEnvironments": "",
    "IsExternalLicensed": false,
    "LimitConcurrentExecution": false,
    "Id": 216,
    "ExecutionSettings": {
        "ResolutionHeight": 0,
        "ResolutionDepth": 0,
        "FontSmoothing": false,
        "AutoDownloadProcess": false
    }
}

Recuperar todos los robots que pueden ejecutar un proceso específico

El siguiente ejemplo realiza una solicitud a /odata/Robots/UiPath.Server.Configuration.OData.GetRobotsForProcess. Te permite identificar, sobre la marcha, qué Robots pueden ejecutar el paquete con la ID input_output_arguments_example .

Obtener

https://{yourDomain}/odata/Robots/UiPath.Server.Configuration.OData.GetRobotsForProcess(processId='input_output_arguments_example')

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Código de respuesta

200 OK

Cuerpo de respuesta

{
  "@odata.context": "https://{yourDomain}/odata/$metadata#Robots",
  "@odata.count": 2,
  "value": [
    {
      "LicenseKey": null,
      "MachineName": "DESKTOP-ASBD",
      "MachineId": 129,
      "Name": "Stan",
      "Username": "Alex",
      "Description": null,
      "Version": null,
      "Type": "Unattended",
      "HostingType": "Standard",
      "Password": null,
      "RobotEnvironments": "doc_env,a_invoke_env,Group1",
      "Id": 759,
      "ExecutionSettings": null
    },
    {
      "LicenseKey": null,
      "MachineName": "Doc",
      "MachineId": 1066,
      "Name": "DocBot",
      "Username": "uipath\\documentation",
      "Description": null,
      "Version": "18.3.0.558",
      "Type": "NonProduction",
      "HostingType": "Standard",
      "Password": null,
      "RobotEnvironments": "doc_env",
      "Id": 1684,
      "ExecutionSettings": null
    }
  ]
}

Recuperar registros de robots según el nombre del robot

El siguiente ejemplo le permite ver los registros del robot para el robot llamado DocBot.

Obtener

https://{yourDomain}/odata/RobotLogs?$top=100&$skip=200&$filter=RobotName eq 'DocBot'

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Código de respuesta

200 OK

Cuerpo de respuesta

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#RobotLogs",
    "@odata.count": 202,
    "value": [
        {
            "Level": "Info",
            "WindowsIdentity": "UIPATH\\john.smith",
            "ProcessName": "TestingSequence_DOC",
            "TimeStamp": "2019-10-14T13:55:18.2473626Z",
            "Message": "TestingSequence_DOC execution started",
            "JobKey": "e49c0012-ee01-45e4-884c-0ce1f2aa6fbb",
            "RawMessage": "{\r\n  \"message\": \"TestingSequence_DOC execution started\",\r\n  \"level\": \"Information\",\r\n  \"logType\": \"Default\",\r\n  \"timeStamp\": \"2019-10-14T13:55:18.2473626+00:00\",\r\n  \"fingerprint\": \"972a32c3-95d9-4264-ae5d-af589bf4f0b5\",\r\n  \"windowsIdentity\": \"UIPATH\\\\petrina.calota\",\r\n  \"machineName\": \"LAPTOP-IN7198N3\",\r\n  \"processName\": \"TestingSequence_DOC\",\r\n  \"processVersion\": \"1.1.7024.37929\",\r\n  \"jobId\": \"e49c0012-ee01-45e4-884c-0ce1f2aa6fbb\",\r\n  \"robotName\": \"G\",\r\n  \"machineId\": 229978,\r\n  \"organizationUnitId\": 67543,\r\n  \"fileName\": \"Main\"\r\n}",
            "RobotName": "DocBot",
            "MachineId": 229978,
            "Id": 0
        },
        {
            "Level": "Info",
            "WindowsIdentity": "UIPATH\\john.smith",
            "ProcessName": "TestingSequence_DOC",
            "TimeStamp": "2019-10-14T13:57:21.4985672Z",
            "Message": "TestingSequence_DOC execution ended",
            "JobKey": "e49c0012-ee01-45e4-884c-0ce1f2aa6fbb",
            "RawMessage": "{\r\n  \"message\": \"TestingSequence_DOC execution ended\",\r\n  \"level\": \"Information\",\r\n  \"logType\": \"Default\",\r\n  \"timeStamp\": \"2019-10-14T13:57:21.4985672+00:00\",\r\n  \"fingerprint\": \"e973b4f2-deec-4290-978b-3a8af0769b35\",\r\n  \"windowsIdentity\": \"UIPATH\\\\petrina.calota\",\r\n  \"machineName\": \"LAPTOP-IN7198N3\",\r\n  \"processName\": \"TestingSequence_DOC\",\r\n  \"processVersion\": \"1.1.7024.37929\",\r\n  \"jobId\": \"e49c0012-ee01-45e4-884c-0ce1f2aa6fbb\",\r\n  \"robotName\": \"G\",\r\n  \"machineId\": 229978,\r\n  \"organizationUnitId\": 67543,\r\n  \"totalExecutionTimeInSeconds\": 123,\r\n  \"totalExecutionTime\": \"00:02:03\",\r\n  \"fileName\": \"Main\"\r\n}",
            "RobotName": "DocBot",
            "MachineId": 229978,
            "Id": 0
        }
  ]
}

Nota:

Las solicitudes GET para los registros de robot almacenados utilizando Elasticsearch solo recuperan las primeras 10000 entradas. Esto se debe a una limitación de Elasticsearch, y no se produce si utilizas SQL. Utilizar los parámetros $top y $skip que superan el límite de 10 000 devuelve el siguiente mensaje de error: "La profundidad de la paginación está limitada en Elasticsearch por la configuración de índice max_result_window. Asegúrate de que omitir + tomar sea inferior a 10000". Solo se admiten las siguientes combinaciones de condición y verbo al parametrizar solicitudes de registros de robot almacenados utilizando Elasticsearch: RobotName eq, JobKey eq, MachineId eq, Level ge, TimeStamp gt.

Editar información del robot

El siguiente ejemplo cambia el tipo y nombre del Robot con el Id 749 y modifica su configuración de ajustes de ejecución. Recuerda poner X-UIPATH-OrganizationUnitId en el encabezado de la solicitud, así como la ID de robot y el nombre de la máquina en el cuerpo de la solicitud.

Nota:

Al realizar solicitudes PUT al punto final de los robots, tenga en cuenta lo siguiente:

• el nombre de usuario y la contraseña del robot no se actualizan cuando envía el mismo nombre de usuario y una contraseña nula o vacía.
• si se envía un nuevo nombre de usuario con una contraseña nula o vacía, las credenciales del Robot se actualizan y se utiliza el nuevo nombre de usuario.

PONER

https://{yourDomain}/odata/Robots(749)

Solicitar encabezados.

Clave	Valor
Autorización	Portador
X-UIPATH-OrganizationUnitId	El ID de carpeta del contenedor. Por ejemplo, 36886.

Solicitar cuerpo

{
  "LicenseKey": "8ec4t984-b2d7-44f2-b5be-0a64ee9a487b",
  "MachineName": "MBOBOC",
  "Name": "DocBot",
  "Type": "Development",
  "Id": 749,
  "Username": "UIPATH\\JustAnotherRobot",
  "ExecutionSettings":{
        "TracingLevel":"Information",
        "StudioNotifyServer":true,
        "LoginToConsole":false,
        "ResolutionWidth":0,
        "ResolutionHeight":0,
        "ResolutionDepth":0,
        "FontSmoothing":false,
        "AutoDownloadProcess":false
    }
}

Código de respuesta

200 OK

Eliminar Robots

Eliminar un solo robot

Para eliminar un robot específico, realiza una solicitud DELETE en el punto final odata/Robots({robot_id}).

Eliminar

https://{yourDomain}/odata/Robots(79)

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Código de respuesta

209 Sin contenido

Eliminar varios robots

Para eliminar varios robots al mismo periodo, realiza una solicitud POST al punto final /Robots/UiPath.Server.Configuration.OData.DeleteBulk.

Publicar

https://{yourDomain}/odata/Robots/UiPath.Server.Configuration.OData.DeleteBulk

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Solicitar cuerpo

{
    "robotIds": [119, 120]
}

Código de respuesta

209 Sin contenido

Actualizar la contraseña de tu propio Unattended robot

Al llamar al punto final siguiente se actualiza la contraseña de tu propio robot desatendido, introduciendo tu ID de usuario (por ejemplo, digamos que tu ID de usuario es 88). Esta operación no requiere permisos de edición en usuarios.

Nota:

Si quieres actualizar la contraseña de un robot diferente, realiza una solicitud PUT al mismo punto final, utilizando el ID del usuario respectivo.

PARCHE

https://{yourDomain}/odata/Users(88)

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Solicitar cuerpo

{
"UnattendedRobot": 
   {
    "Password": "newUnattendedRobotP@ss"
    }
}

Código de respuesta

200 OK