TaskList

Récapitulatif de la méthode

GET/scr/api/TaskList

Description

Utilisez cette méthode pour obtenir la liste de tâches ouvertes affectées à l'utilisateur en cours et la liste de tâches terminées de l'utilisateur.

Informations sur les ressources

Conditions requises	Description
Format de réponse	JSON
Authentification requise	Oui
Prise en charge des données d'identification client OAuth 2	Oui avec un ID de service utilisateur contenant la catégorie de gestion des travaux
Taux limité	Pas encore

Paramètres

Nom	Emplacement	Description	Obligatoire	Type
X-On-Behalf-Of	En-tête	Le contexte utilisateur. La valeur doit être un nom d'utilisateur du compte. L'utilisateur doit être autorisé à effectuer l'action dans le compte et dans l'espace parent spécifié, si existant.	Requis si les informations d'identification de l'ID de service OAuth sont utilisées. Non requis lors de l'utilisation des informations d'identification du service utilisateur OAuth.	Chaîne
type	Requête	Type de liste à renvoyer. Les valeurs suivantes sont prises en charge : assigned ou completed. Si la valeur indiquée n'est pas prise en charge, le code de réponse 400 est renvoyé.	Oui	Chaîne
version	Requête	Version de l'API demandée. La seule valeur autorisée est 20110917.	Oui	Chaîne
limit	Requête	Nombre maximal de tâches à renvoyer. Si ce paramètre n'est pas indiqué, la valeur par défaut 100 est utilisée.	Non	Entier
startFrom	Requête	Si ce paramètre est indiqué, la liste renvoyée commence par la tâche définie au niveau de cet index (basé sur zéro). Utilisez ce paramètre si le nombre de tâches disponibles est supérieur au nombre maximal de tâches renvoyées lors d'un appel antérieur.	Non	Entier

Réponse

Exemple d'entrée

• Utilisation de l'ID de service utilisateur OAuth 2 informations d'identification client :

  curl -i -H "Authorization: Bearer access_token"
  "https://your_server_url/scr/api/TaskList?type=completed&version=20110917"

• Utilisation de l'ID de service OAuth 2 informations d'identification client avec contexte utilisateur :

  curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com"
      "https://your_server_url/scr/api/TaskList?type=completed&version=20110917"

Exemple de sortie

{
      "work":[
         {           
            "name":"ProcessApp 1 - Multiple process apps.",        
            "id":"5f501e1345eda"
         },
         {           
            "name":"ProcessApp 2 - Multiple process apps.",        
            "id":"5f500e134a57f"
         },
     ]
}

Propriétés de réponse

version

Version de l'API utilisée pour créer une réponse.

more

Contient l'une des valeurs possibles suivantes :

• true s'il existe plus de tâches sur le serveur
• false si l'entrée de tâche inclut toutes les tâches disponibles

type

Type des tâches de la liste. Les valeurs possibles sont assigned ou completed. Ces valeurs correspondent à celle qui peut être transmise pour le paramètre type.

tasks

Matrice de tâches. Les tâches sont répertoriées dans l'ordre chronologique inverse de dueDate. Les éléments ayant le même dueDate sont triés par ID d'instance et ID tâche.

task.name

Nom de la tâche.

task.id

ID de la tâche.

task.workId

ID du travail associé. Cette propriété correspond à la propriété ID de l'une des entrées de la matrice de travaux. Plusieurs tâches peuvent faire référence à la même entrée de travail.

task.dueDate

Paramètre facultatif. Date d'échéance de la tâche. Si la tâche n'a pas de date d'échéance, cette zone n'est pas visible. La date d'échéance est exprimée en millisecondes depuis l'époque, c'est-à-dire depuis le 1er janvier 1970 à minuit en temps universel coordonné (UTC).

work

Matrice d'éléments de travail. Les éléments de travail n'apparaissent pas d'un ordre spécifique. Il existe une entrée dans le tableau pour chaque valeur unique de workId dans le tableau des tâches.

work.name

Nom attribué à l'instance de travail lors de son démarrage.

work.id

ID de l'instance de travail.

Messages de réponse

Code HTTP	Motif
200	La demande a été exécutée avec succès.
400	Une erreur s'est produite lors du traitement de la demande. Les paramètres requis étaient absents ou contenaient des valeurs non valides.
401	L'utilisateur n'est pas autorisé à effectuer la demande.