Orchestrator
2022.10
False
Image de fond de la bannière
Guide de l'API Orchestrator
Dernière mise à jour 10 nov. 2023

Requêtes de tâches

Récupérer des tâches dans un dossier

Cette requête permet de récupérer toutes les tâches des dossiers classiques auxquels l'utilisateur a accès.

Remarque :

Ce point de terminaison récupère uniquement les actions dans les dossiers classiques et sera obsolète à l'avenir.

Utilisez les éléments suivants pour récupérer les actions, quel que soit le type de dossier :

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

Obtenir

/odata/Tasks?$top=2

En-têtes de requête.

Clé (Key)

Valeur (Value)

Autorisation

Porteur

Codes de réponse

200 OK

Corps de la réponse

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

Récupérer les détails de la tâche

Cette requête vous permet de récupérer les détails de la tâche en fonction du TaskId. Le TaskId doit être inclus dans la requête. Par exemple, /odata/Tasks(194).

Obtenir

/odata/Tasks(194)

En-têtes de requête.

Clé (Key)

Valeur (Value)

Autorisation

Porteur

Codes de réponse

200 OK

Corps de la réponse

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

Affectation d'une tâche à un utilisateur

Cette requête permet d'affecter une tâche à un utilisateur, en fonction du TaskId et du UserId. Une seule requête peut gérer l'affectation de plusieurs tâches à différents utilisateurs.

Publier

/odata/Tasks/UiPath.Server.Configuration.OData.AssignTasks

En-têtes de requête.

Clé (Key)

Valeur (Value)

Autorisation

Porteur

Corps de la requête

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

Codes de réponse

200 OK

Corps de la réponse

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

Tâches non affectées

Cette demande vous permet d'effacer l'affectation d'une ou plusieurs tâches en fonction du taskIds fourni.

Publier

/odata/Tasks/UiPath.Server.Configuration.OData.UnassignTasks

En-têtes de requête.

Clé (Key)

Valeur (Value)

Autorisation

Porteur

Corps de la requête

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

Codes de réponse

200 OK

Corps de la réponse

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

Renvoyer les utilisateurs disposant des autorisations de consultation et de modification des tâches

Cette demande vous permet de récupérer les utilisateurs disposant des autorisations Consultation ( View ) et Modification ( Edit ) sur les tâches. L'ID de dossier doit être inclus dans la demande.

Obtenir

/odata/Tasks/UiPath.Server.Configuration.OData.GetTaskUsers(organizationUnitId=36886)

En-têtes de requête.

Clé (Key)

Valeur (Value)

Autorisation

Porteur

Codes de réponse

200 OK

Corps de la réponse

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

Delete a Task

Cette demande vous permet de supprimer une ou plusieurs tâches par leurs ID.

Publier

/odata/Tasks/UiPath.Server.Configuration.OData.DeleteTasks

En-têtes de requête.

Clé (Key)

Valeur (Value)

Autorisation

Porteur

Corps de la requête

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

Codes de réponse

200 OK

Corps de la réponse

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

Cette page vous a-t-elle été utile ?

Obtenez l'aide dont vous avez besoin
Formation RPA - Cours d'automatisation
Forum de la communauté UiPath
Logo Uipath blanc
Confiance et sécurité
© 2005-2024 UiPath. All rights reserved.