- Introdução
- Definição do Swagger
- APIs do Orchestrator
- Solicitações de alertas
- Solicitações de ativos
- Solicitações de calendários
- Solicitações de ambientes
- Solicitações de pastas
- Solicitações de Tarefas Genéricas
- Solicitações de trabalhos
- Solicitações de bibliotecas
- Solicitações de licenças
- Solicitações de pacotes
- Solicitações de permissões
- Solicitações de espaços de trabalho pessoais
- Solicitações de processos
- Processar solicitações de política de retenção de dados
- Solicitações de itens de fila
- Solicitações da política de retenção de filas
- Solicitações de robôs
- Solicitações de funções
- Solicitações de agendamentos
- Solicitações de configurações
- Solicitações de bucket de armazenamento
- Solicitações de tarefas
- Solicitações de catálogos de tarefas
- Solicitações de formulários de tarefas
- Solicitações de tenants
- Solicitações de Transações
- Solicitações de usuários
- Solicitações de webhooks
Solicitações de Transações
/odata/Queues/UiPathODataSvc.StartTransaction
requer informações que estão disponíveis apenas para o robô.
A chamada a seguir permite visualizar todas as ações pelas quais um item de fila específico passou.
Obter
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/QueueItemEvents/UiPath.Server.Configuration.OData.GetQueueItemEventsHistory(queueItemId=1050203)?$orderby=Timestamp&$top=10
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#QueueItemEvents",
"@odata.count": 5,
"value": [
{
"QueueItemId": 1050203,
"Timestamp": "2018-03-07T16:02:59.09Z",
"Action": "Create",
"Data": null,
"UserId": 910,
"UserName": "DocBot",
"Status": "New",
"ReviewStatus": "None",
"ReviewerUserId": null,
"ReviewerUserName": null,
"Id": 18276
},
{
"QueueItemId": 1050203,
"Timestamp": "2018-03-07T18:15:04.46Z",
"Action": "Status",
"Data": null,
"UserId": 910,
"UserName": "DocBot",
"Status": "InProgress",
"ReviewStatus": "None",
"ReviewerUserId": null,
"ReviewerUserName": null,
"Id": 20333
},
{
"QueueItemId": 1050203,
"Timestamp": "2018-03-07T18:15:05.07Z",
"Action": "Edit",
"Data": null,
"UserId": 910,
"UserName": "DocBot",
"Status": "InProgress",
"ReviewStatus": "None",
"ReviewerUserId": null,
"ReviewerUserName": null,
"Id": 20334
},
{
"QueueItemId": 1050203,
"Timestamp": "2018-03-07T18:15:05.507Z",
"Action": "Edit",
"Data": null,
"UserId": 910,
"UserName": "DocBot",
"Status": "Failed",
"ReviewStatus": "None",
"ReviewerUserId": null,
"ReviewerUserName": null,
"Id": 20335
},
{
"QueueItemId": 1050203,
"Timestamp": "2018-03-08T10:47:40.463Z",
"Action": "Edit",
"Data": null,
"UserId": 583,
"UserName": "admin",
"Status": "Failed",
"ReviewStatus": "None",
"ReviewerUserId": 583,
"ReviewerUserName": "admin",
"Id": 21240
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#QueueItemEvents",
"@odata.count": 5,
"value": [
{
"QueueItemId": 1050203,
"Timestamp": "2018-03-07T16:02:59.09Z",
"Action": "Create",
"Data": null,
"UserId": 910,
"UserName": "DocBot",
"Status": "New",
"ReviewStatus": "None",
"ReviewerUserId": null,
"ReviewerUserName": null,
"Id": 18276
},
{
"QueueItemId": 1050203,
"Timestamp": "2018-03-07T18:15:04.46Z",
"Action": "Status",
"Data": null,
"UserId": 910,
"UserName": "DocBot",
"Status": "InProgress",
"ReviewStatus": "None",
"ReviewerUserId": null,
"ReviewerUserName": null,
"Id": 20333
},
{
"QueueItemId": 1050203,
"Timestamp": "2018-03-07T18:15:05.07Z",
"Action": "Edit",
"Data": null,
"UserId": 910,
"UserName": "DocBot",
"Status": "InProgress",
"ReviewStatus": "None",
"ReviewerUserId": null,
"ReviewerUserName": null,
"Id": 20334
},
{
"QueueItemId": 1050203,
"Timestamp": "2018-03-07T18:15:05.507Z",
"Action": "Edit",
"Data": null,
"UserId": 910,
"UserName": "DocBot",
"Status": "Failed",
"ReviewStatus": "None",
"ReviewerUserId": null,
"ReviewerUserName": null,
"Id": 20335
},
{
"QueueItemId": 1050203,
"Timestamp": "2018-03-08T10:47:40.463Z",
"Action": "Edit",
"Data": null,
"UserId": 583,
"UserName": "admin",
"Status": "Failed",
"ReviewStatus": "None",
"ReviewerUserId": 583,
"ReviewerUserName": "admin",
"Id": 21240
}
]
}
A solicitação a seguir permite ver o tempo médio de execução dos itens em uma fila indicada.
Obter
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveQueuesProcessingStatus?$filter=QueueDefinitionName eq 'DocQueue'
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Core.Model.Queues.QueueProcessingStatus)",
"@odata.count": 1,
"value": [
{
"ItemsToProcess": 682,
"ItemsInProgress": 0,
"QueueDefinitionId": 188,
"QueueDefinitionName": "DocQueue",
"QueueDefinitionDescription": null,
"QueueDefinitionAcceptAutomaticallyRetry": true,
"QueueDefinitionMaxNumberOfRetries": 5,
"QueueDefinitionEnforceUniqueReference": false,
"ProcessingMeanTime": 2.15,
"SuccessfulTransactionsNo": 0,
"ApplicationExceptionsNo": 0,
"BusinessExceptionsNo": 883,
"SuccessfulTransactionsProcessingTime": 0,
"ApplicationExceptionsProcessingTime": 0,
"BusinessExceptionsProcessingTime": 2.15,
"TotalNumberOfTransactions": 883,
"LastProcessed": "2018-03-07T18:20:29.3833333Z"
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Core.Model.Queues.QueueProcessingStatus)",
"@odata.count": 1,
"value": [
{
"ItemsToProcess": 682,
"ItemsInProgress": 0,
"QueueDefinitionId": 188,
"QueueDefinitionName": "DocQueue",
"QueueDefinitionDescription": null,
"QueueDefinitionAcceptAutomaticallyRetry": true,
"QueueDefinitionMaxNumberOfRetries": 5,
"QueueDefinitionEnforceUniqueReference": false,
"ProcessingMeanTime": 2.15,
"SuccessfulTransactionsNo": 0,
"ApplicationExceptionsNo": 0,
"BusinessExceptionsNo": 883,
"SuccessfulTransactionsProcessingTime": 0,
"ApplicationExceptionsProcessingTime": 0,
"BusinessExceptionsProcessingTime": 2.15,
"TotalNumberOfTransactions": 883,
"LastProcessed": "2018-03-07T18:20:29.3833333Z"
}
]
}
O exemplo a seguir permite alterar o revisor do item de transação com falha com o ID 1050200.
RowVersion
muda sempre que uma atualização é feita em um item da fila. Para recuperar essas informações, execute uma chamada GET no terminal /odata/QueueItems()
, como https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/QueueItems(1050200)
.
Postar
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/QueueItems/UiPathODataSvc.SetItemReviewer
{
"queueItems": [{
"Id": 1050200,
"RowVersion":"AAAAAABDIK8="
}],
"userId": 583
}
{
"queueItems": [{
"Id": 1050200,
"RowVersion":"AAAAAABDIK8="
}],
"userId": 583
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.BulkOperationResponseDto_1OfInt64",
"Success": true,
"Message": null,
"FailedItems": []
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.BulkOperationResponseDto_1OfInt64",
"Success": true,
"Message": null,
"FailedItems": []
}
Este exemplo permite extrair os dois primeiros itens da fila que têm um status de revisão definido como Em revisão.
Obter
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/QueueItems?$filter=ReviewStatus eq 'InReview'&$top=2
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#QueueItems",
"@odata.count": 3,
"value": [
{
"QueueDefinitionId": 188,
"OutputData": null,
"Status": "Failed",
"ReviewStatus": "InReview",
"ReviewerUserId": 583,
"Key": "e4760d27-a76d-4469-b7e6-fbda2f732b10",
"Reference": "ActivityDescription",
"ProcessingExceptionType": "BusinessException",
"DueDate": null,
"Priority": "High",
"DeferDate": null,
"StartProcessing": "2018-03-07T18:14:56.633Z",
"EndProcessing": "2018-03-07T18:14:58.723Z",
"SecondsInPreviousAttempts": 2,
"AncestorId": null,
"RetryNumber": 0,
"SpecificData": "{\"DynamicProperties\":{\"Description\":\"Gets a specified credential by using a provided AssetName, and returns a username and a secure password.\"}}",
"CreationTime": "2018-03-07T16:02:57.547Z",
"Progress": null,
"RowVersion": "AAAAAABDFiU=",
"Id": 1050199,
"ProcessingException": {
"Reason": "authentication",
"Details": null,
"Type": "BusinessException",
"AssociatedImageFilePath": null,
"CreationTime": "2018-03-07T18:14:58.723Z"
},
"SpecificContent": {
"Description": "Gets a specified credential by using a provided AssetName, and returns a username and a secure password."
},
"Output": null
},
{
"QueueDefinitionId": 188,
"OutputData": null,
"Status": "Failed",
"ReviewStatus": "InReview",
"ReviewerUserId": 583,
"Key": "e90e8067-50fc-407a-9678-eede311f815a",
"Reference": "ActivityDescription",
"ProcessingExceptionType": "BusinessException",
"DueDate": null,
"Priority": "High",
"DeferDate": null,
"StartProcessing": "2018-03-07T18:14:54.85Z",
"EndProcessing": "2018-03-07T18:14:57.103Z",
"SecondsInPreviousAttempts": 2,
"AncestorId": null,
"RetryNumber": 0,
"SpecificData": "{\"DynamicProperties\":{\"Description\":\"Gets a specified asset by using a provided AssetName. If the asset is not global, it must be assigned to the local robot in order to be retrieved.\"}}",
"CreationTime": "2018-03-07T16:02:57.287Z",
"Progress": null,
"RowVersion": "AAAAAABDFiY=",
"Id": 1050198,
"ProcessingException": {
"Reason": "authentication",
"Details": null,
"Type": "BusinessException",
"AssociatedImageFilePath": null,
"CreationTime": "2018-03-07T18:14:57.103Z"
},
"SpecificContent": {
"Description": "Gets a specified asset by using a provided AssetName. If the asset is not global, it must be assigned to the local robot in order to be retrieved."
},
"Output": null
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#QueueItems",
"@odata.count": 3,
"value": [
{
"QueueDefinitionId": 188,
"OutputData": null,
"Status": "Failed",
"ReviewStatus": "InReview",
"ReviewerUserId": 583,
"Key": "e4760d27-a76d-4469-b7e6-fbda2f732b10",
"Reference": "ActivityDescription",
"ProcessingExceptionType": "BusinessException",
"DueDate": null,
"Priority": "High",
"DeferDate": null,
"StartProcessing": "2018-03-07T18:14:56.633Z",
"EndProcessing": "2018-03-07T18:14:58.723Z",
"SecondsInPreviousAttempts": 2,
"AncestorId": null,
"RetryNumber": 0,
"SpecificData": "{\"DynamicProperties\":{\"Description\":\"Gets a specified credential by using a provided AssetName, and returns a username and a secure password.\"}}",
"CreationTime": "2018-03-07T16:02:57.547Z",
"Progress": null,
"RowVersion": "AAAAAABDFiU=",
"Id": 1050199,
"ProcessingException": {
"Reason": "authentication",
"Details": null,
"Type": "BusinessException",
"AssociatedImageFilePath": null,
"CreationTime": "2018-03-07T18:14:58.723Z"
},
"SpecificContent": {
"Description": "Gets a specified credential by using a provided AssetName, and returns a username and a secure password."
},
"Output": null
},
{
"QueueDefinitionId": 188,
"OutputData": null,
"Status": "Failed",
"ReviewStatus": "InReview",
"ReviewerUserId": 583,
"Key": "e90e8067-50fc-407a-9678-eede311f815a",
"Reference": "ActivityDescription",
"ProcessingExceptionType": "BusinessException",
"DueDate": null,
"Priority": "High",
"DeferDate": null,
"StartProcessing": "2018-03-07T18:14:54.85Z",
"EndProcessing": "2018-03-07T18:14:57.103Z",
"SecondsInPreviousAttempts": 2,
"AncestorId": null,
"RetryNumber": 0,
"SpecificData": "{\"DynamicProperties\":{\"Description\":\"Gets a specified asset by using a provided AssetName. If the asset is not global, it must be assigned to the local robot in order to be retrieved.\"}}",
"CreationTime": "2018-03-07T16:02:57.287Z",
"Progress": null,
"RowVersion": "AAAAAABDFiY=",
"Id": 1050198,
"ProcessingException": {
"Reason": "authentication",
"Details": null,
"Type": "BusinessException",
"AssociatedImageFilePath": null,
"CreationTime": "2018-03-07T18:14:57.103Z"
},
"SpecificContent": {
"Description": "Gets a specified asset by using a provided AssetName. If the asset is not global, it must be assigned to the local robot in order to be retrieved."
},
"Output": null
}
]
}
O exemplo abaixo nos permite adicionar um item à fila "DocQueue", com alta prioridade, datas de adiamento e vencimento e dois argumentos com valores. Todos os itens adicionados dessa forma têm o status Novo, assim como a atividade Adicionar item à fila.
SpecificContent
deve ser preenchido apenas com valores primitivos.
Postar
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Queues/UiPathODataSvc.AddQueueItem
{
"itemData": {
"Priority": "High",
"DeferDate": "2018-03-21T13:42:27.654Z",
"DueDate": "2018-03-25T13:42:27.654Z",
"Name": "DocQueue",
"SpecificContent": {
"Email": "obrian@uipath.com",
"Name": "O'Brian"
}
}
}
{
"itemData": {
"Priority": "High",
"DeferDate": "2018-03-21T13:42:27.654Z",
"DueDate": "2018-03-25T13:42:27.654Z",
"Name": "DocQueue",
"SpecificContent": {
"Email": "obrian@uipath.com",
"Name": "O'Brian"
}
}
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#queueItem/$entity",
"QueueDefinitionId": 188,
"OutputData": null,
"Status": "New",
"ReviewStatus": "None",
"ReviewerUserId": null,
"Key": "e9cb2205-0232-4b99-9556-52dc2e686663",
"Reference": null,
"ProcessingExceptionType": null,
"DueDate": "2018-03-25T13:42:27.654Z",
"Priority": "High",
"DeferDate": "2018-03-21T13:42:27.654Z",
"StartProcessing": null,
"EndProcessing": null,
"SecondsInPreviousAttempts": 0,
"AncestorId": null,
"RetryNumber": 0,
"SpecificData": "{\"DynamicProperties\":{\"Email\":\"obrian@uipath.com\",\"Name\":\"O'brian\"}}",
"CreationTime": "2018-03-21T15:31:27.2699068Z",
"Progress": null,
"RowVersion": "AAAAAABDGLk=",
"Id": 1050947,
"ProcessingException": null,
"SpecificContent": {
"Email": "obrian@uipath.com",
"Name": "O'Brian"
},
"Output": null
}}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#queueItem/$entity",
"QueueDefinitionId": 188,
"OutputData": null,
"Status": "New",
"ReviewStatus": "None",
"ReviewerUserId": null,
"Key": "e9cb2205-0232-4b99-9556-52dc2e686663",
"Reference": null,
"ProcessingExceptionType": null,
"DueDate": "2018-03-25T13:42:27.654Z",
"Priority": "High",
"DeferDate": "2018-03-21T13:42:27.654Z",
"StartProcessing": null,
"EndProcessing": null,
"SecondsInPreviousAttempts": 0,
"AncestorId": null,
"RetryNumber": 0,
"SpecificData": "{\"DynamicProperties\":{\"Email\":\"obrian@uipath.com\",\"Name\":\"O'brian\"}}",
"CreationTime": "2018-03-21T15:31:27.2699068Z",
"Progress": null,
"RowVersion": "AAAAAABDGLk=",
"Id": 1050947,
"ProcessingException": null,
"SpecificContent": {
"Email": "obrian@uipath.com",
"Name": "O'Brian"
},
"Output": null
}}
FolderId
ou o FolderPath
da fila desejada. Consulte aqui para mais detalhes.
An organization unit is required for this action.
Os exemplos abaixo nos permitem adicionar vários itens ao mesmo tempo à fila "DocTest" que foi configurada para permitir apenas referências únicas. Depois que os itens forem adicionados, todos eles terão o status Novo .
"Name@odata.type": "#string"
. Veja os exemplos abaixo.
O primeiro exemplo é bem-sucedido, enquanto o último falha porque os itens não possuem referências que são necessárias para filas de referência única.
Existem duas estratégias de upload que podem ser usadas ao adicionar vários itens de fila:
AllOrNothing
- Adiciona itens de fila somente se um erro não for encontrado. Caso contrário, não insere nada e retorna a linha onde ocorreu o erro.-
ProcessAllIndependently
- Adiciona todos os seus itens e retorna uma lista de todos aqueles que falharam.Observação:As solicitações com falha retornam 200 OK, pois os itens com falha são retornados no corpo da resposta, como você pode ver no segundo exemplo.
As únicas requisições que não retornam 200 OK são aquelas em que os parâmetros de entrada estão incorretos.
Postar
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Queues/UiPathODataSvc.BulkAddQueueItems
Cabeçalhos de solicitação.
Chave |
Valor |
---|---|
Autorização |
O portador |
Corpo da Solicitação
{
"queueName": "DocTest",
"commitType": "AllOrNothing",
"queueItems": [{
"Priority": "High",
"SpecificContent": {
"Name": "rêvé",
"Name@odata.type": "#String"
},
"DeferDate": "2019-03-14T12:20:13.290Z",
"DueDate": "2019-03-14T12:20:13.290Z",
"Reference": "ref4"
},
{
"Priority": "High",
"SpecificContent": {
"Name": "même",
"Name@odata.type": "#String"
},
"DeferDate": "2019-03-14T12:20:13.290Z",
"DueDate": "2019-03-14T12:20:13.290Z",
"Reference": "ref5"
},
{
"Priority": "High",
"SpecificContent": {
"Name": "Žao",
"Name@odata.type": "#String"
},
"DeferDate": "2019-03-14T12:20:13.290Z",
"DueDate": "2019-03-14T12:20:13.290Z",
"Reference": "ref6"
}
]
}
{
"queueName": "DocTest",
"commitType": "AllOrNothing",
"queueItems": [{
"Priority": "High",
"SpecificContent": {
"Name": "rêvé",
"Name@odata.type": "#String"
},
"DeferDate": "2019-03-14T12:20:13.290Z",
"DueDate": "2019-03-14T12:20:13.290Z",
"Reference": "ref4"
},
{
"Priority": "High",
"SpecificContent": {
"Name": "même",
"Name@odata.type": "#String"
},
"DeferDate": "2019-03-14T12:20:13.290Z",
"DueDate": "2019-03-14T12:20:13.290Z",
"Reference": "ref5"
},
{
"Priority": "High",
"SpecificContent": {
"Name": "Žao",
"Name@odata.type": "#String"
},
"DeferDate": "2019-03-14T12:20:13.290Z",
"DueDate": "2019-03-14T12:20:13.290Z",
"Reference": "ref6"
}
]
}
Código de resposta
200 OK
Corpo da Resposta
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.BulkOperationResponseDto_1OfFailedQueueItemDto",
"Success": true,
"Message": null,
"FailedItems": []
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.BulkOperationResponseDto_1OfFailedQueueItemDto",
"Success": true,
"Message": null,
"FailedItems": []
}
Postar
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Queues/UiPathODataSvc.BulkAddQueueItems
Cabeçalhos de solicitação.
Chave |
Valor |
---|---|
Autorização |
O portador |
Corpo da Solicitação
{
"queueName": "DocTest",
"commitType": "AllOrNothing",
"queueItems": [{
"Priority": "High",
"SpecificContent": {
"Name": "rêvé",
"Name@odata.type": "#String"
},
"DeferDate": "2019-03-14T12:20:13.290Z",
"DueDate": "2019-03-14T12:20:13.290Z",
},
{
"Priority": "High",
"SpecificContent": {
"Name": "même",
"Name@odata.type": "#String"
},
"DeferDate": "2019-03-14T12:20:13.290Z",
"DueDate": "2019-03-14T12:20:13.290Z",
},
{
"Priority": "High",
"SpecificContent": {
"Name": "Žao",
"Name@odata.type": "#String"
},
"DeferDate": "2019-03-14T12:20:13.290Z",
"DueDate": "2019-03-14T12:20:13.290Z",
}
]
}
{
"queueName": "DocTest",
"commitType": "AllOrNothing",
"queueItems": [{
"Priority": "High",
"SpecificContent": {
"Name": "rêvé",
"Name@odata.type": "#String"
},
"DeferDate": "2019-03-14T12:20:13.290Z",
"DueDate": "2019-03-14T12:20:13.290Z",
},
{
"Priority": "High",
"SpecificContent": {
"Name": "même",
"Name@odata.type": "#String"
},
"DeferDate": "2019-03-14T12:20:13.290Z",
"DueDate": "2019-03-14T12:20:13.290Z",
},
{
"Priority": "High",
"SpecificContent": {
"Name": "Žao",
"Name@odata.type": "#String"
},
"DeferDate": "2019-03-14T12:20:13.290Z",
"DueDate": "2019-03-14T12:20:13.290Z",
}
]
}
Código de resposta
200 OK
Corpo da Resposta
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.BulkOperationResponseDto_1OfFailedQueueItemDto",
"Success": false,
"Message": "Some items have not been inserted.",
"FailedItems": [{
"Ordinal": 1,
"ErrorCode": "TransactionReferenceRequired",
"ErrorMessage": "Error creating Transaction. Reference is required for Unique Reference Queues."
}]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.BulkOperationResponseDto_1OfFailedQueueItemDto",
"Success": false,
"Message": "Some items have not been inserted.",
"FailedItems": [{
"Ordinal": 1,
"ErrorCode": "TransactionReferenceRequired",
"ErrorMessage": "Error creating Transaction. Reference is required for Unique Reference Queues."
}]
}
O exemplo abaixo consulta o banco de dados do Orchestrator para os primeiros 10 itens da fila com o status Em progresso que foram processados pelo Robot com o 749 Id. Por fim, as informações do Robô são expandidas. Observe que a resposta estava truncada.
Obter
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/QueueItems?$top=10&$expand=Robot&$filter=Status eq 'InProgress' and Robot/Id eq 749
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#QueueItems",
"@odata.count": 1752,
"value": [
{
"QueueDefinitionId": 188,
"OutputData": null,
"Status": "InProgress",
"ReviewStatus": "None",
"ReviewerUserId": null,
"Key": "1c632cc1-44ab-4624-bace-6fbb5fd1c0cd",
"Reference": "ActivityDescription",
"ProcessingExceptionType": null,
"DueDate": null,
"Priority": "High",
"DeferDate": null,
"StartProcessing": "2018-03-07T15:05:05.113Z",
"EndProcessing": null,
"SecondsInPreviousAttempts": 0,
"AncestorId": null,
"RetryNumber": 0,
"SpecificData": "{\"DynamicProperties\":{\"Description\":\"Checks if Stop was triggered in UiPath Orchestrator.\"}}",
"CreationTime": "2018-03-05T18:39:16.06Z",
"Progress": null,
"RowVersion": "AAAAAABC3aA=",
"Id": 1048065,
"ProcessingException": null,
"SpecificContent": {
"Description": "Checks if Stop was triggered in UiPath Orchestrator."
},
"Output": null,
"Robot": {
"LicenseKey": null,
"MachineName": "MBOBOC",
"Name": "DocBot",
"Username": "UIPATH\\MADALINA.BOBOC",
"Description": null,
"Type": "NonProduction",
"Password": null,
"RobotEnvironments": "",
"Id": 749,
"ExecutionSettings": null
}
},
{
"QueueDefinitionId": 188,
"OutputData": null,
"Status": "InProgress",
"ReviewStatus": "None",
"ReviewerUserId": null,
"Key": "7dfa834b-8398-476e-bd18-b0fa51d4ddf6",
"Reference": "ActivityDescription",
"ProcessingExceptionType": null,
"DueDate": null,
"Priority": "High",
"DeferDate": null,
"StartProcessing": "2018-03-07T15:05:04.503Z",
"EndProcessing": null,
"SecondsInPreviousAttempts": 0,
"AncestorId": null,
"RetryNumber": 0,
"SpecificData": "{\"DynamicProperties\":{\"Description\":\"Sets the status of a transaction item to Failed or Successful.\"}}",
"CreationTime": "2018-03-05T18:39:15.627Z",
"Progress": null,
"RowVersion": "AAAAAABC3Z8=",
"Id": 1048064,
"ProcessingException": null,
"SpecificContent": {
"Description": "Sets the status of a transaction item to Failed or Successful."
},
"Output": null,
"Robot": {
"LicenseKey": null,
"MachineName": "MBOBOC",
"Name": "DocBot",
"Username": "UIPATH\\MADALINA.BOBOC",
"Description": null,
"Type": "NonProduction",
"Password": null,
"RobotEnvironments": "",
"Id": 749,
"ExecutionSettings": null
}
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#QueueItems",
"@odata.count": 1752,
"value": [
{
"QueueDefinitionId": 188,
"OutputData": null,
"Status": "InProgress",
"ReviewStatus": "None",
"ReviewerUserId": null,
"Key": "1c632cc1-44ab-4624-bace-6fbb5fd1c0cd",
"Reference": "ActivityDescription",
"ProcessingExceptionType": null,
"DueDate": null,
"Priority": "High",
"DeferDate": null,
"StartProcessing": "2018-03-07T15:05:05.113Z",
"EndProcessing": null,
"SecondsInPreviousAttempts": 0,
"AncestorId": null,
"RetryNumber": 0,
"SpecificData": "{\"DynamicProperties\":{\"Description\":\"Checks if Stop was triggered in UiPath Orchestrator.\"}}",
"CreationTime": "2018-03-05T18:39:16.06Z",
"Progress": null,
"RowVersion": "AAAAAABC3aA=",
"Id": 1048065,
"ProcessingException": null,
"SpecificContent": {
"Description": "Checks if Stop was triggered in UiPath Orchestrator."
},
"Output": null,
"Robot": {
"LicenseKey": null,
"MachineName": "MBOBOC",
"Name": "DocBot",
"Username": "UIPATH\\MADALINA.BOBOC",
"Description": null,
"Type": "NonProduction",
"Password": null,
"RobotEnvironments": "",
"Id": 749,
"ExecutionSettings": null
}
},
{
"QueueDefinitionId": 188,
"OutputData": null,
"Status": "InProgress",
"ReviewStatus": "None",
"ReviewerUserId": null,
"Key": "7dfa834b-8398-476e-bd18-b0fa51d4ddf6",
"Reference": "ActivityDescription",
"ProcessingExceptionType": null,
"DueDate": null,
"Priority": "High",
"DeferDate": null,
"StartProcessing": "2018-03-07T15:05:04.503Z",
"EndProcessing": null,
"SecondsInPreviousAttempts": 0,
"AncestorId": null,
"RetryNumber": 0,
"SpecificData": "{\"DynamicProperties\":{\"Description\":\"Sets the status of a transaction item to Failed or Successful.\"}}",
"CreationTime": "2018-03-05T18:39:15.627Z",
"Progress": null,
"RowVersion": "AAAAAABC3Z8=",
"Id": 1048064,
"ProcessingException": null,
"SpecificContent": {
"Description": "Sets the status of a transaction item to Failed or Successful."
},
"Output": null,
"Robot": {
"LicenseKey": null,
"MachineName": "MBOBOC",
"Name": "DocBot",
"Username": "UIPATH\\MADALINA.BOBOC",
"Description": null,
"Type": "NonProduction",
"Password": null,
"RobotEnvironments": "",
"Id": 749,
"ExecutionSettings": null
}
}
]
}
O exemplo abaixo exibe todos os comentários do item da fila com o Id 1050204, em ordem crescente de criação.
Obter
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/QueueItemComments/UiPath.Server.Configuration.OData.GetQueueItemCommentsHistory(queueItemId=1050204)?$orderby=CreationTime%20desc
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#QueueItemComments",
"@odata.count": 2,
"value": [
{
"Text": "needs review asap",
"QueueItemId": 1050204,
"CreationTime": "2018-03-08T13:41:49.167Z",
"UserId": 583,
"UserName": "admin",
"Id": 320
},
{
"Text": "fixed. excel hiccup.",
"QueueItemId": 1050204,
"CreationTime": "2018-03-08T13:46:48.613Z",
"UserId": 901,
"UserName": "dragomirmir",
"Id": 321
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#QueueItemComments",
"@odata.count": 2,
"value": [
{
"Text": "needs review asap",
"QueueItemId": 1050204,
"CreationTime": "2018-03-08T13:41:49.167Z",
"UserId": 583,
"UserName": "admin",
"Id": 320
},
{
"Text": "fixed. excel hiccup.",
"QueueItemId": 1050204,
"CreationTime": "2018-03-08T13:46:48.613Z",
"UserId": 901,
"UserName": "dragomirmir",
"Id": 321
}
]
}
- Visualizando o histórico de um item
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Recuperando o Tempo Médio de Execução de uma Fila Específica
- Código de resposta
- Corpo da Resposta
- Alterar o revisor de um item de fila
- Cabeçalhos de solicitação.
- Corpo da Solicitação
- Código de resposta
- Corpo da Resposta
- Recuperando itens da fila com um status de revisão indicado
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Adicionando um item de fila
- Cabeçalhos de solicitação.
- Corpo da Solicitação
- Código de resposta
- Corpo da Resposta
- Adicionando vários itens de fila
- Solicitação bem-sucedida
- Solicitação com falha
- Recuperando transações de acordo com seu status e ID do robô
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Recuperando comentários para um item específico
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta