orchestrator
2023.4
false
Importante :
A tradução automática foi aplicada parcialmente neste conteúdo.
Guia da API do Orchestrator
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated 22 de jun de 2024

Solicitações de trabalhos

Solicitando trabalhos iniciados por um robô específico

De acordo com o ID do robô

Como você pode ver no exemplo abaixo, solicitamos os 3 principais jobs, mas apenas 1 foi retornado, pois foi encontrado apenas um job executado no Robot com o Id 749.

Obter

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Jobs?$top=3&$filter=Robot/Id eq 749

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Código de resposta

200 OK

Corpo da Resposta

{
    "@odata.context": "https://{yourDomain}/{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
        },
        {
            "Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
            "StartTime": "2018-03-02T17:25:35.17Z",
            "EndTime": "2018-03-02T17:25:46.62Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
            "Info": "Job completed",
            "CreationTime": "2018-03-02T17:25:34.087Z",
            "StartingScheduleId": null,
            "Id": 127283
        },
        {
            "Key": "e29e472d-5d51-4369-9c15-af867e6dd580",
            "StartTime": "2018-03-05T18:27:27.123Z",
            "EndTime": "2018-03-05T18:27:38.593Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "ad498d35-326c-4c6c-89d0-16fb73abd0c8",
            "Info": "Execution error : System.ArgumentException: The sheet does not exist\r\n   at UiPath.Excel.WorkbookApplication.SetSheet(String sheetName, Boolean createNew)\r\n   at UiPath.Excel.Activities.ExcelInteropActivity`1.BeginExecute(AsyncCodeActivityContext context, AsyncCallback callback, Object state)\r\n   at System.Activities.AsyncCodeActivity.InternalExecute(ActivityInstance instance, ActivityExecutor executor, BookmarkManager bookmarkManager)\r\n   at System.Activities.ActivityInstance.Execute(ActivityExecutor executor, BookmarkManager bookmarkManager)\r\n   at System.Activities.Runtime.ActivityExecutor.ExecuteActivityWorkItem.ExecuteBody(ActivityExecutor executor, BookmarkManager bookmarkManager, Location resultLocation)",
            "CreationTime": "2018-03-05T18:27:25.793Z",
            "StartingScheduleId": null,
            "Id": 127416
        }
    ]
}{
    "@odata.context": "https://{yourDomain}/{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
        },
        {
            "Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
            "StartTime": "2018-03-02T17:25:35.17Z",
            "EndTime": "2018-03-02T17:25:46.62Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
            "Info": "Job completed",
            "CreationTime": "2018-03-02T17:25:34.087Z",
            "StartingScheduleId": null,
            "Id": 127283
        },
        {
            "Key": "e29e472d-5d51-4369-9c15-af867e6dd580",
            "StartTime": "2018-03-05T18:27:27.123Z",
            "EndTime": "2018-03-05T18:27:38.593Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "ad498d35-326c-4c6c-89d0-16fb73abd0c8",
            "Info": "Execution error : System.ArgumentException: The sheet does not exist\r\n   at UiPath.Excel.WorkbookApplication.SetSheet(String sheetName, Boolean createNew)\r\n   at UiPath.Excel.Activities.ExcelInteropActivity`1.BeginExecute(AsyncCodeActivityContext context, AsyncCallback callback, Object state)\r\n   at System.Activities.AsyncCodeActivity.InternalExecute(ActivityInstance instance, ActivityExecutor executor, BookmarkManager bookmarkManager)\r\n   at System.Activities.ActivityInstance.Execute(ActivityExecutor executor, BookmarkManager bookmarkManager)\r\n   at System.Activities.Runtime.ActivityExecutor.ExecuteActivityWorkItem.ExecuteBody(ActivityExecutor executor, BookmarkManager bookmarkManager, Location resultLocation)",
            "CreationTime": "2018-03-05T18:27:25.793Z",
            "StartingScheduleId": null,
            "Id": 127416
        }
    ]
}

De acordo com o Nome do Robô

Esta chamada solicita todos os 10 principais trabalhos que foram executados por um robô com o nome "DocBot", mas apenas 1 foi retornado porque apenas um trabalho foi encontrado.

Obter

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Jobs?$top=10&$filter=Robot/Name eq 'DocBot'

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Código de resposta

200 OK

Corpo da Resposta

{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Jobs",
    "@odata.count": 1,
    "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
        }
    ]
}{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Jobs",
    "@odata.count": 1,
    "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
        }
    ]
}

De acordo com um ID de robô específico, com um estado específico

O exemplo a seguir procura os primeiros 10 trabalhos que foram processados por um robô com o ID 749 e estão no estado Bem-sucedido. Como você pode ver, apenas dois resultados foram retornados.

Obter

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Jobs?$top=10&$filter=Robot/Id eq 749 and State eq 'Successful'

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Código de resposta

200 OK

Corpo da Resposta

{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/$metadata#Jobs",
    "@odata.count": 2,
    "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
        },
        {
            "Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
            "StartTime": "2018-03-02T17:25:35.17Z",
            "EndTime": "2018-03-02T17:25:46.62Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
            "Info": "Job completed",
            "CreationTime": "2018-03-02T17:25:34.087Z",
            "StartingScheduleId": null,
            "Id": 127283
        }
    ]
}{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/$metadata#Jobs",
    "@odata.count": 2,
    "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
        },
        {
            "Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
            "StartTime": "2018-03-02T17:25:35.17Z",
            "EndTime": "2018-03-02T17:25:46.62Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
            "Info": "Job completed",
            "CreationTime": "2018-03-02T17:25:34.087Z",
            "StartingScheduleId": null,
            "Id": 127283
        }
    ]
}

De acordo com o ID do robô e a data final

O exemplo abaixo permite que você procure os 10 primeiros jobs que foram executados pelo Robot com o Id 759 e terminaram a execução após 22 de fevereiro de 2018, 10:00:00.837. Como apenas três trabalhos corresponderam a todos esses parâmetros, apenas eles foram retornados na seção Resposta .

Obter

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Jobs?$top=10&$filter=Robot/Id eq 759 and EndTime lt 2018-02-22T10:00:00.837Z

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Código de resposta

200 OK

Corpo da Resposta

{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Jobs",
    "@odata.count": 3,
    "value": [
        {
            "Key": "45383b6c-a547-49e1-be5c-f3bb6d78982c",
            "StartTime": "2018-01-15T18:17:14.693Z",
            "EndTime": "2018-01-15T18:17:14.693Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "9eda64eb-3ab8-46e8-833d-fe944a4eb25e",
            "Info": "Logon failure: unknown user name or bad password",
            "CreationTime": "2018-01-15T18:17:13.59Z",
            "StartingScheduleId": null,
            "Id": 125160
        },
        {
            "Key": "4b018719-36cb-43a1-8096-202641ccee62",
            "StartTime": "2018-01-15T18:19:03.177Z",
            "EndTime": "2018-01-15T18:19:03.177Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "7a60ce9d-a5a6-4e9f-b908-ab5819b016c2",
            "Info": "Logon failure: unknown user name or bad password",
            "CreationTime": "2018-01-15T18:19:02.37Z",
            "StartingScheduleId": null,
            "Id": 125162
        },
        {
            "Key": "4420820e-7b0a-49a3-a172-ddcc1d88ace9",
            "StartTime": "2018-01-15T18:20:07.93Z",
            "EndTime": "2018-01-15T18:20:22.68Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "843d9f41-ae7b-4a28-bd32-d57006f90a2f",
            "Info": "Job completed",
            "CreationTime": "2018-01-15T18:20:06.733Z",
            "StartingScheduleId": null,
            "Id": 125163
        }
    ]
}{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Jobs",
    "@odata.count": 3,
    "value": [
        {
            "Key": "45383b6c-a547-49e1-be5c-f3bb6d78982c",
            "StartTime": "2018-01-15T18:17:14.693Z",
            "EndTime": "2018-01-15T18:17:14.693Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "9eda64eb-3ab8-46e8-833d-fe944a4eb25e",
            "Info": "Logon failure: unknown user name or bad password",
            "CreationTime": "2018-01-15T18:17:13.59Z",
            "StartingScheduleId": null,
            "Id": 125160
        },
        {
            "Key": "4b018719-36cb-43a1-8096-202641ccee62",
            "StartTime": "2018-01-15T18:19:03.177Z",
            "EndTime": "2018-01-15T18:19:03.177Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "7a60ce9d-a5a6-4e9f-b908-ab5819b016c2",
            "Info": "Logon failure: unknown user name or bad password",
            "CreationTime": "2018-01-15T18:19:02.37Z",
            "StartingScheduleId": null,
            "Id": 125162
        },
        {
            "Key": "4420820e-7b0a-49a3-a172-ddcc1d88ace9",
            "StartTime": "2018-01-15T18:20:07.93Z",
            "EndTime": "2018-01-15T18:20:22.68Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "843d9f41-ae7b-4a28-bd32-d57006f90a2f",
            "Info": "Job completed",
            "CreationTime": "2018-01-15T18:20:06.733Z",
            "StartingScheduleId": null,
            "Id": 125163
        }
    ]
}

De acordo com a data de início e o ID do robô

A consulta a seguir procura os 10 principais trabalhos executados por um robô com o ID 749, começando em 22 de setembro de 2017, 09:59:22.837.

Obter

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Jobs?$top=10&$filter=Robot/Id eq 749 and State eq 'Successful'

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Código de resposta

200 OK

Corpo da Resposta

{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/$metadata#Jobs",
    "@odata.count": 2,
    "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
        },
        {
            "Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
            "StartTime": "2018-03-02T17:25:35.17Z",
            "EndTime": "2018-03-02T17:25:46.62Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
            "Info": "Job completed",
            "CreationTime": "2018-03-02T17:25:34.087Z",
            "StartingScheduleId": null,
            "Id": 127283
        }
    ]
}{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/$metadata#Jobs",
    "@odata.count": 2,
    "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
        },
        {
            "Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
            "StartTime": "2018-03-02T17:25:35.17Z",
            "EndTime": "2018-03-02T17:25:46.62Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
            "Info": "Job completed",
            "CreationTime": "2018-03-02T17:25:34.087Z",
            "StartingScheduleId": null,
            "Id": 127283
        }
    ]
}

Início de um trabalho

A seguinte requisição permite iniciar a execução do processo indicado (através do parâmetro ReleaseKey), em todos os Robots disponíveis que se encontrem no ambiente associado.

Nota: A estratégia All não é aplicável a pastas modernas.

Postar

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Corpo da Solicitação

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

Código de resposta

200 OK

Corpo da Resposta

{
  "@odata.context": "https://{yourDomain}/{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
    }
  ]
}{
  "@odata.context": "https://{yourDomain}/{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 um trabalho com valores personalizados para parâmetros de entrada

A solicitação POST a seguir para o terminal /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs permite que você adicione valores personalizados para parâmetros de entrada ao mesmo tempo em que inicia um trabalho em um robô específico.
Observação:

Observe que um máximo de 10.000 caracteres é aceito para toda a extensão da representação JSON de parâmetros de entrega, incluindo nomes de argumento, todos os caracteres escapados, espaços, parênteses, e valores de argumentos.

Se você fornecer valores para parâmetros de entrada inteiros ao fazer chamadas de API de trabalho inicial que também são valores ASCII válidos, observe que eles são alterados. Por exemplo, 0065 torna-se 53.

Postar

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Corpo da Solicitação

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

Código de resposta

200 OK

Corpo da Resposta

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

Recuperando trabalhos que foram executados por um ambiente indicado

O exemplo a seguir nos permite pegar as duas primeiras tarefas que foram executadas pelos Robôs que fazem parte do ambiente com o Id 312 e expandir as informações do processo.

Obter

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

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Código de resposta

200 OK

Corpo da Resposta

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

Recuperando trabalhos com falhas de acordo com erros

A chamada abaixo ajuda a exibir os 2 primeiros trabalhos que falharam com o erro "Falha de logon: nome de usuário desconhecido ou senha incorreta" e expande os detalhes do robô e do processo. Você pode usar essa consulta para qualquer tipo de erro exibido na janela Detalhes do Trabalho .

Obter

https://{yourDomain}/{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

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Código de resposta

200 OK

Corpo da Resposta

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

Interrompendo vários trabalhos

A solicitação abaixo nos permite interromper (matar) à força dois trabalhos.

Observação:
O parâmetro strategy pode ser preenchido com os seguintes valores:
  • SoftStop ou 1
  • Kill or 2.

Postar

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StopJobs

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Corpo da Solicitação

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

Código de resposta

200 OK

Exportação de trabalhos

Essa ação requer chamadas para vários pontos de extremidade.

  1. Inicie uma exportação chamando POST https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_//odata/Jobs/UiPath.Server.Configuration.OData.Export. Adicione quaisquer filtros conforme a necessidade.

    É assim que o corpo da solicitação se parece:

    POST https://{yourDomain}/{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: 770643POST https://{yourDomain}/{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

    A resposta inclui um ID que é necessário para as etapas subsequentes:

    {"@odata.context":"https://{yourDomain}/{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}{"@odata.context":"https://{yourDomain}/{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. Obtenha o status da solicitação chamando GET https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/orchestrator_/odata/Exports(8661), onde o texto entre parênteses é o ID retornado na etapa 1.

    É assim que o corpo da solicitação se parece:

    GET https://{yourDomain}/{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=GET https://{yourDomain}/{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=

    Aguarde até obter a resposta concluída:

    {"@odata.context":"https://{yourDomain}/{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}{"@odata.context":"https://{yourDomain}/{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. Obtenha o link para download chamando GET https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Exports(8661)/UiPath.Server.Configuration.OData.GetDownloadLink, onde o texto entre parênteses é o ID retornado na etapa 1.

    É assim que o corpo da solicitação se parece:

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

    A resposta inclui um URI que você pode usar para recuperar uma exportação do CSV de seus dados:

    {"@odata.context":"https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Server.Configuration.OData.BlobFileAccessDto","Uri":"<Download URI>","Verb":"GET","RequiresAuth":false,"Headers":{"Keys":[],"Values":[]}}{"@odata.context":"https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Server.Configuration.OData.BlobFileAccessDto","Uri":"<Download URI>","Verb":"GET","RequiresAuth":false,"Headers":{"Keys":[],"Values":[]}}
  4. Faça uma solicitação GET para o URI que foi retornado na etapa 3. Isso dispara o download da exportação do CSV. Consulte a seção O relatório exportado em nosso guia do usuário para obter detalhes sobre o formato e a convenção de nomenclatura.

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.