orchestrator
2022.10
false
Importante :
A tradução automática foi aplicada parcialmente neste conteúdo.
UiPath logo, featuring letters U and I in white
Guia da API do Orchestrator
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated 22 de jun de 2024

Solicitações de tarefas

Recuperar Tarefas em uma Pasta

Esta solicitação permite recuperar todas as tarefas nas pastas clássicas às quais o usuário tem acesso.

Observação:

Este ponto de extremidade recupera apenas ações em pastas clássicas e será preterido no futuro.

Use os seguintes para recuperar ações independentemente do tipo de pasta:

  • odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFolders
  • odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFoldersForAdmin

Obter

https://{yourDomain}/odata/Tasks?$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}/odata/$metadata#Tasks",
  "@odata.count": 21,
  "value": [
    {
      "Title": "Performance Review",
      "Type": "FormTask",
      "Priority": "Medium",
      "Status": "Completed",
      "CreationTime": "2019-10-16T11:39:30.41Z",
      "TaskCatalogName": "Expecto Patronum",
      "OrganizationUnitId": 828,
      "IsCompleted": true,
      "Id": 63
    },
    {
      "Title": "Performance Review",
      "Type": "FormTask",
      "Priority": "Medium",
      "Status": "Completed",
      "CreationTime": "2019-10-16T11:40:24.88Z",
      "TaskCatalogName": "Expecto Patronum",
      "OrganizationUnitId": 828,
      "IsCompleted": true,
      "Id": 64
    }{
  "@odata.context": "https://{yourDomain}/odata/$metadata#Tasks",
  "@odata.count": 21,
  "value": [
    {
      "Title": "Performance Review",
      "Type": "FormTask",
      "Priority": "Medium",
      "Status": "Completed",
      "CreationTime": "2019-10-16T11:39:30.41Z",
      "TaskCatalogName": "Expecto Patronum",
      "OrganizationUnitId": 828,
      "IsCompleted": true,
      "Id": 63
    },
    {
      "Title": "Performance Review",
      "Type": "FormTask",
      "Priority": "Medium",
      "Status": "Completed",
      "CreationTime": "2019-10-16T11:40:24.88Z",
      "TaskCatalogName": "Expecto Patronum",
      "OrganizationUnitId": 828,
      "IsCompleted": true,
      "Id": 64
    }

Recuperar detalhes da tarefa

Essa solicitação permite que você recupere detalhes da tarefa de acordo com o TaskId. O TaskId deve ser incluído na solicitação. Por exemplo, https://{yourDomain}/odata/Tasks(194).

Obter

https://{yourDomain}/odata/Tasks(194)

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Código de resposta

200 OK

Corpo da Resposta

{
  "@odata.context": "https://{yourDomain}/odata/$metadata#Tasks/$entity",
  "Title": "Verify Credentials",
  "Type": "FormTask",
  "Priority": "Critical",
  "Status": "Unassigned",
  "CreationTime": "2019-12-12T17:25:03.02Z",
  "TaskCatalogName": "Auth",
  "OrganizationUnitId": 828,
  "IsCompleted": false,
  "Id": 194
}{
  "@odata.context": "https://{yourDomain}/odata/$metadata#Tasks/$entity",
  "Title": "Verify Credentials",
  "Type": "FormTask",
  "Priority": "Critical",
  "Status": "Unassigned",
  "CreationTime": "2019-12-12T17:25:03.02Z",
  "TaskCatalogName": "Auth",
  "OrganizationUnitId": 828,
  "IsCompleted": false,
  "Id": 194
}

Atribuir uma Tarefa para o Usuário

Essa solicitação permite que você atribua uma tarefa a um usuário, de acordo com TaskId e UserId. Uma única solicitação pode lidar com a atribuição de várias tarefas a diferentes usuários.

Postar

https://{yourDomain}/odata/Tasks/UiPath.Server.Configuration.OData.AssignTasks

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Corpo da Solicitação

{
"taskAssignments": 
[   
 {
      "TaskId": 194,
      "UserId": 52454
    }
]
}{
"taskAssignments": 
[   
 {
      "TaskId": 194,
      "UserId": 52454
    }
]
}

Código de resposta

200 OK

Corpo da Resposta

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
    "value": [
        {
            "TaskId": 195,
            "UserId": 52454,
            "ErrorCode": 2400,
            "ErrorMessage": "Task is already assigned"
        }
    ]
}{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
    "value": [
        {
            "TaskId": 195,
            "UserId": 52454,
            "ErrorCode": 2400,
            "ErrorMessage": "Task is already assigned"
        }
    ]
}

Desatribuir Tarefas

Essa solicitação permite que você limpe a atribuição de uma ou várias tarefas com base no taskIds fornecido.

Postar

https://{yourDomain}/odata/Tasks/UiPath.Server.Configuration.OData.UnassignTasks

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Corpo da Solicitação

{
  "taskIds": [
    194,177
  ]
}{
  "taskIds": [
    194,177
  ]
}

Código de resposta

200 OK

Corpo da Resposta

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
    "value": [
        {
            "TaskId": 177,
            "UserId": null,
            "ErrorCode": 2400,
            "ErrorMessage": "This task is in completed state"
        }
    ]
}{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
    "value": [
        {
            "TaskId": 177,
            "UserId": null,
            "ErrorCode": 2400,
            "ErrorMessage": "This task is in completed state"
        }
    ]
}

Retornar usuários com permissões de exibição e edição em tarefas

Essa solicitação permite que você recupere usuários com permissões de visualização e edição em tarefas. O ID da pasta deve ser incluído na solicitação.

Obter

https://{yourDomain}/odata/Tasks/UiPath.Server.Configuration.OData.GetTaskUsers(organizationUnitId=36886)

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Código de resposta

200 OK

Corpo da Resposta

{
  "@odata.context": "https://{yourDomain}/odata/$metadata#UserLoginInfo",
  "@odata.count": 13,
  "value": [
    {
      "Name": "Harry",
      "Surname": "Potter",
      "UserName": "harry.potter@uipath.com",
      "EmailAddress": "harry.potter@uipath.com",
      "Id": 52454
    },
    {
      "Name": "Severus",
      "Surname": "Snape",
      "UserName": "severus.snape@uipath",
      "EmailAddress": "severus.snape@uipath.com",
      "Id": 52917
    }{
  "@odata.context": "https://{yourDomain}/odata/$metadata#UserLoginInfo",
  "@odata.count": 13,
  "value": [
    {
      "Name": "Harry",
      "Surname": "Potter",
      "UserName": "harry.potter@uipath.com",
      "EmailAddress": "harry.potter@uipath.com",
      "Id": 52454
    },
    {
      "Name": "Severus",
      "Surname": "Snape",
      "UserName": "severus.snape@uipath",
      "EmailAddress": "severus.snape@uipath.com",
      "Id": 52917
    }

Excluir uma tarefa

Essa solicitação permite que você exclua uma ou mais tarefas por seus IDs.

Postar

https://{yourDomain}/odata/Tasks/UiPath.Server.Configuration.OData.DeleteTasks

Cabeçalhos de solicitação.

Chave

Valor

Autorização

O portador

Corpo da Solicitação

{
  "taskIds": [
     104177
  ]
}{
  "taskIds": [
     104177
  ]
}

Código de resposta

200 OK

Corpo da Resposta

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
    "value": [
        {
            "TaskId": 104177,
            "UserId": null,
            "ErrorCode": 2427,
            "ErrorMessage": "You do not have the required permissions to delete this action"
        }
    ]
}{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
    "value": [
        {
            "TaskId": 104177,
            "UserId": null,
            "ErrorCode": 2427,
            "ErrorMessage": "You do not have the required permissions to delete this action"
        }
    ]
}

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.