Solicitudes de trabajos

Solicitar trabajos iniciados por un robot específico

You can filter jobs by robot ID, robot name, job state, and dates. The following section shows the base request format and common filter examples.

Base request format

Obtener

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Jobs?$top=3&$filter={filter-expression}

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Código de respuesta

200 OK

Ejemplos de filtros

Use these filter variations to query jobs by different criteria:

Caso de uso	ExpresiónDeFiltro
By robot ID	Robot/Id eq 749
By robot name	Robot/Name eq 'DocBot'
By robot ID and state	Robot/Id eq 749 and State eq 'Successful'
By robot ID and end date	Robot/Id eq 759 and EndTime lt 2018-02-22T10:00:00.837Z
By robot ID and start date	Robot/Id eq 749 and StartTime gt 2017-09-22T09:59:22.837Z

Respuesta de ejemplo

The following response shows the structure returned when querying jobs:

{
    "@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Jobs",
    "@odata.count": 13,
    "value": [
        {
            "Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
            "StartTime": "2018-01-15T18:18:02.79Z",
            "EndTime": "2018-01-15T18:18:47.587Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
            "Info": "Job completed",
            "CreationTime": "2018-01-15T18:18:01.623Z",
            "StartingScheduleId": null,
            "Id": 125161
        }
    ]
}

Iniciar un trabajo

La siguiente solicitud te permite iniciar la ejecución del proceso indicado (a través del parámetro ReleaseKey), en todos los Robots disponibles que se encuentran en el entorno asociado.

Nota:

La estrategia Todos no es aplicable a las carpetas modernas.

Publicar

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Solicitar cuerpo

{
  "startInfo": {
    "ReleaseKey": "795cbab2-8008-4a54-b1cb-f9ff1ece139e",
    "Strategy": "All",
    "RobotIds": [],
    "NoOfRobots": 0
  }
}

Código de respuesta

200 OK

Cuerpo de respuesta

{
  "@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Jobs",
  "value": [
    {
      "Key": "31ade17f-5a35-4250-beea-43922dc2a20d",
      "StartTime": null,
      "EndTime": null,
      "State": "Pending",
      "Source": "Manual",
      "BatchExecutionKey": "cbaff1c6-32b0-468b-9ad9-b59f9ca1d3b6",
      "Info": null,
      "CreationTime": "2018-03-19T19:01:58.6806126Z",
      "StartingScheduleId": null,
      "Id": 128209
    },
    {
      "Key": "c4caf051-9db6-486d-8078-231f9dec1a4c",
      "StartTime": null,
      "EndTime": null,
      "State": "Pending",
      "Source": "Manual",
      "BatchExecutionKey": "cbaff1c6-32b0-468b-9ad9-b59f9ca1d3b6",
      "Info": null,
      "CreationTime": "2018-03-19T19:01:58.7610094Z",
      "StartingScheduleId": null,
      "Id": 128210
    },
    {
      "Key": "969552ba-cfe5-4e87-adde-c85a358ae96f",
      "StartTime": null,
      "EndTime": null,
      "State": "Pending",
      "Source": "Manual",
      "BatchExecutionKey": "cbaff1c6-32b0-468b-9ad9-b59f9ca1d3b6",
      "Info": null,
      "CreationTime": "2018-03-19T19:01:58.8212679Z",
      "StartingScheduleId": null,
      "Id": 128211
    }
  ]
}

Iniciar un trabajo con valores personalizados para los parámetros de entrada

La siguiente solicitud POST al punto final /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs te permite añadir valores personalizados para los parámetros de entrada a la vez que inicias un trabajo en un Robot específico.

Nota:

Ten en cuenta que se acepta un máximo de 10 000 caracteres para toda la longitud de la representación JSON de los parámetros de entrada, incluidos los nombres de los argumentos, todos los caracteres en blanco, los espacios, los corchetes y los valores de los argumentos. Si proporcionas valores para los parámetros de entrada enteros al realizar llamadas de API de inicio de trabajo que también son valores ASCII válidos, ten en cuenta que cambian. Por ejemplo, 0065 se convierte en 53.

Publicar

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Solicitar cuerpo

{
    "startInfo": {
        "ReleaseKey": "429cf1cc-283c-424f-a935-43f72c2ca719",
        "RobotIds": [121],
        "JobsCount": 0,
        "Strategy": "Specific",
        "InputArguments": "{\"age\":33,\"trueOrFalse\":false,\"stringNew\":\"testing\"}"
    }
}

Código de respuesta

200 OK

Cuerpo de respuesta

{
    "@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Jobs",
    "value": [
        {
            "Key": "0fbdbecb-3677-4c33-a491-a1f7ed4ff886",
            "StartTime": null,
            "EndTime": null,
            "State": "Pending",
            "Source": "Manual",
            "SourceType": "Manual",
            "BatchExecutionKey": "e188f409-c504-47b7-b2cf-30b8fe423f87",
            "Info": null,
            "CreationTime": "2018-08-27T16:41:00.4773869Z",
            "StartingScheduleId": null,
            "ReleaseName": "input_output_test_DocEnv",
            "Type": "Unattended",
            "InputArguments": "{\"age\":33,\"trueOrFalse\":false,\"stringNew\":\"testing\"}",
            "OutputArguments": null,
            "Id": 21767
        }
    ]
}

Recuperar trabajos ejecutados por un entorno indicado

El siguiente ejemplo nos permite obtener los dos primeros trabajos ejecutados por los robots que forman parte del entorno con el ID 312 y expandir la información del proceso.

Obtener

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Jobs?$top=2&$expand=Release&$filter=Release/EnvironmentId eq 312

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Código de respuesta

200 OK

Cuerpo de respuesta

{
    "@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Jobs",
    "@odata.count": 26,
    "value": [
        {
            "Key": "d3780aac-1e80-49b0-bfd3-c8ec6a3939db",
            "StartTime": "2018-01-15T18:03:42.51Z",
            "EndTime": "2018-01-15T18:03:44.353Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "c08beec5-243c-4e08-854d-7c100cd35214",
            "Info": "Logon failure: unknown user name or bad password",
            "CreationTime": "2018-01-15T18:03:41.56Z",
            "StartingScheduleId": null,
            "Id": 125153,
            "Release": {
                "Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
                "ProcessKey": "Release_Project",
                "ProcessVersion": "",
                "IsLatestVersion": false,
                "IsProcessDeleted": false,
                "Description": "rockerii",
                "Name": "Release_Project_doc_env",
                "EnvironmentId": 312,
                "EnvironmentName": null,
                "Id": 440
            }
        },
        {
            "Key": "93b0bfc1-cb80-4594-bb3e-9f35f3efc828",
            "StartTime": "2018-01-15T18:05:42.393Z",
            "EndTime": "2018-01-15T18:05:42.393Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "2f894a2b-7ba1-4eee-b399-c67894a9b3ec",
            "Info": "Logon failure: unknown user name or bad password",
            "CreationTime": "2018-01-15T18:05:41.093Z",
            "StartingScheduleId": null,
            "Id": 125154,
            "Release": {
                "Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
                "ProcessKey": "Release_Project",
                "ProcessVersion": "",
                "IsLatestVersion": false,
                "IsProcessDeleted": false,
                "Description": "rockerii",
                "Name": "Release_Project_doc_env",
                "EnvironmentId": 312,
                "EnvironmentName": null,
                "Id": 440
            }
        }
    ]
}

Recuperar trabajos defectuosos según errores

La siguiente llamada te ayuda a mostrar los 2 primeros trabajos que fallaron con el error "Error de inicio de sesión: nombre de usuario desconocido o contraseña incorrecta" y expande los detalles de robot y proceso. Puedes utilizar esta consulta para cualquier tipo de error que se muestre en la ventana Detalles del trabajo.

Obtener

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Jobs?$filter=(CreationTime gt 2017-01-01T00:00:00.000Z and State eq '4' and indexof(Info,'Logon failure: unknown user name or bad password') ne -1)&$expand=Robot,Release&$top=2

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Código de respuesta

200 OK

Cuerpo de respuesta

{
  "@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Jobs",
  "@odata.count": 5,
  "value": [
    {
      "Key": "d3780aac-1e80-49b0-bfd3-c8ec6a3939db",
      "StartTime": "2018-01-15T18:03:42.51Z",
      "EndTime": "2018-01-15T18:03:44.353Z",
      "State": "Faulted",
      "Source": "Manual",
      "BatchExecutionKey": "c08beec5-243c-4e08-854d-7c100cd35214",
      "Info": "Logon failure: unknown user name or bad password",
      "CreationTime": "2018-01-15T18:03:41.56Z",
      "StartingScheduleId": null,
      "Id": 125153,
      "Robot": {
        "LicenseKey": null,
        "MachineName": "DESKTOP-PMFQGCB",
        "Name": "RoboDrulea",
        "Username": "ALEX",
        "Description": null,
        "Type": "Unattended",
        "Password": null,
        "RobotEnvironments": "",
        "Id": 758,
        "ExecutionSettings": null
      },
      "Release": {
        "Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
        "ProcessKey": "Release_Project",
        "ProcessVersion": "",
        "IsLatestVersion": false,
        "IsProcessDeleted": false,
        "Description": null,
        "Name": "Release_Project_doc_env",
        "EnvironmentId": 312,
        "EnvironmentName": null,
        "Id": 440
      }
    },
    {
      "Key": "93b0bfc1-cb80-4594-bb3e-9f35f3efc828",
      "StartTime": "2018-01-15T18:05:42.393Z",
      "EndTime": "2018-01-15T18:05:42.393Z",
      "State": "Faulted",
      "Source": "Manual",
      "BatchExecutionKey": "2f894a2b-7ba1-4eee-b399-c67894a9b3ec",
      "Info": "Logon failure: unknown user name or bad password",
      "CreationTime": "2018-01-15T18:05:41.093Z",
      "StartingScheduleId": null,
      "Id": 125154,
      "Robot": {
        "LicenseKey": null,
        "MachineName": "DESKTOP-PMFQGCB",
        "Name": "RoboDrulea",
        "Username": "ALEX",
        "Description": null,
        "Type": "Unattended",
        "Password": null,
        "RobotEnvironments": "",
        "Id": 758,
        "ExecutionSettings": null
      },
      "Release": {
        "Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
        "ProcessKey": "Release_Project",
        "ProcessVersion": "",
        "IsLatestVersion": false,
        "IsProcessDeleted": false,
        "Description": null,
        "Name": "Release_Project_doc_env",
        "EnvironmentId": 312,
        "EnvironmentName": null,
        "Id": 440
      }
    }
  ]
}

Detener varios trabajos

La siguiente solicitud te permite detener trabajos. Puedes establecer como destino trabajos por sus ID o por una clave de ejecución por lotes.Solo se puede especificar uno de estos parámetros a la vez.

Nota:

El parámetro strategy puede completarse con los siguientes valores:

• SoftStop o 1
• Kill or 2.

Publicar

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StopJobs

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Solicitar cuerpo

Detener por ID de trabajo

{
    "jobIds": [22450719, 22450728],
    "strategy": "1"
}

Detener por clave de ejecución por lotes

{
    "batchExecutionKey": "57a377aa-af29-45bb-a0bb-22feba96eb96",
    "strategy": "1"
}

Código de respuesta

200 OK

Exportar trabajos

Esta acción requiere llamadas a varios puntos finales.

Nota:

Este punto final se limita a 100 solicitudes de API/día/inquilino.

1. Inicia una exportación llamando a POST {AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_//odata/Jobs/UiPath.Server.Configuration.OData.Export. Añade los filtros que sean necesarios.

Este es el aspecto del cuerpo de la solicitud:

POST {AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.Export?$top=1000&$expand=Robot,Machine,Release&$orderby=CreationTime%20desc HTTP/1.1
Authorization: Bearer rt_45D8A3C5FF2AC56A92A906EE14FB0B8B004D76BAC67AE375521C373F23447684-1
X-Uipath-Organizationunitid: 770643

La respuesta incluye un ID necesario para los pasos posteriores:

{"@odata.context":"{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Exports/$entity","Id":8661,"Name":"jobs-02c0398c-227b-47f4-aade-2252146d7d8f","Type":"Jobs","Status":"New","RequestedAt":"2024-01-15T07:48:34.8805788Z","ExecutedAt":null,"Size":null}

2. Obtén el estado de la solicitud llamando a GET {AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/orchestrator_/odata/Exports(8661), donde el texto entre paréntesis es el ID devuelto en el paso 1.

Este es el aspecto del cuerpo de la solicitud:

GET {AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Exports(8661) HTTP/1.1
Host: alpha.uipath.com
Authorization: Bearer rt_45D8A3C5FF2AC56A92A906EE14FB0B8B004D76BAC67AE375521C373F23447684-1
X-Uipath-Organizationunitid: 770643
Cookie: __cf_bm=lxqtVnB6oC_KS1nxJsWcqGK87Up9b5TGUCkZLeoaLP8-1705304914-1-AcpGG76FE03iiFdCw+u2Sq/xV3T38gqfvE7vjjZ5YHs5Iwjmrw1/1DjR5RSlqdQU1ocpukAZ1I0JLAGnkdOnumA=

Espera a recibir la respuesta completa:

{"@odata.context":"{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Exports/$entity","Id":8661,"Name":"jobs-02c0398c-227b-47f4-aade-2252146d7d8f","Type":"Jobs","Status":"Completed","RequestedAt":"2024-01-15T07:48:34.88Z","ExecutedAt":"2024-01-15T07:48:38.51Z","Size":692}

3. Obtén el enlace de descarga llamando a GET {AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Exports(8661)/UiPath.Server.Configuration.OData.GetDownloadLink, donde el texto entre paréntesis es el ID devuelto en el paso 1.

Este es el aspecto del cuerpo de la solicitud:

GET {AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Exports(8661)/UiPath.Server.Configuration.OData.GetDownloadLink HTTP/1.1
Authorization: Bearer rt_45D8A3C5FF2AC56A92A906EE14FB0B8B004D76BAC67AE375521C373F23447684-1
X-Uipath-Organizationunitid: 770643

La respuesta incluye un URI que puedes utilizar para recuperar una exportación CSV de tus datos:

{"@odata.context":"{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Server.Configuration.OData.BlobFileAccessDto","Uri":"<Download URI>","Verb":"GET","RequiresAuth":false,"Headers":{"Keys":[],"Values":[]}}

4. Realiza una solicitud OBTENER al URI devuelto en el paso 3. Esto desencadena la descarga de la exportación CSV. Consulta la sección Informe exportado de nuestra guía del usuario para obtener más detalles sobre el formato y la convención de nombres.