v1Ressources/Approvals/getObtenir une tâche
Obtenir une tâche
Renvoie une tâche ou une sous-tâche de Tâches et validations à partir de son id : statut, responsable, état de validation, dates et rowVersion. Une tâche inexistante, ou rattachée à un client hors de l'accès de la clé, renvoie 404. Si Tâches et validations n'est pas activé pour votre espace de travail, la réponse est 404.
get
approvals:read/api/v1/work-management/tasks/{id}Paramètres de requête
idstringobligatoire
L'id de la tâche, un UUID. Toute autre valeur renvoie 404.
Réponse
okbooleanfacultatif
Toujours true pour une réponse réussie.
deliveryAvailablebooleanfacultatif
Indique si cet espace de travail peut diffuser le contenu validé. Peut être absent.
itemobjectfacultatif
La tâche.
keystringfacultatif
La clé de la tâche, au format task:<id>.
itemIdstringfacultatif
L'id de la tâche.
kindstring (task | subtask)facultatif
task pour une tâche principale, subtask pour une sous-tâche.
titlestringfacultatif
Le titre de la tâche.
descriptionstringfacultatif
La description de la tâche, ou null.
statusstring (open | in_progress | awaiting_decision | approval_required | revision_requested | approved | rejected | done | dismissed)facultatif
L'état d'avancement de la tâche. approval_required signifie qu'elle attend son validateur.
clientIdstringfacultatif
Le client de la tâche, ou null pour un travail interne à l'agence.
locationIdstringfacultatif
L'établissement concerné par la tâche, ou null.
projectIdstringfacultatif
Le projet auquel appartient la tâche, ou null.
projectNamestringfacultatif
Le nom du projet, ou null.
parentKeystringfacultatif
Pour une sous-tâche, la clé de la tâche parente, sinon null.
ownersarray of objectfacultatif
Le responsable de la tâche, sous forme de liste. Les nouvelles tâches en ont au plus un ; les plus anciennes peuvent encore en afficher plusieurs.
idstringfacultatif
L'id de la personne. Transmettez-le comme ownerId lors de la création d'une tâche, ou comme userId pour définir un responsable.
namestringfacultatif
Le nom affiché de la personne.
typestring (user | client_user)facultatif
user pour un membre de l'équipe de l'agence, client_user pour une personne d'un client. Envoyez la même valeur comme ownerType.
avatarUrlstringfacultatif
L'URL de la photo de profil de la personne, le cas échéant.
creatorobjectfacultatif
Qui a créé la tâche : un membre de l'équipe ou un utilisateur client. null si inconnu.
idstringfacultatif
namestringfacultatif
typestring (user | client_user)facultatif
manualApprovalobjectfacultatif
Le validateur de la tâche et l'état de sa demande de validation.
approverobjectfacultatif
L'id, le nom et le type du validateur, ou null s'il n'y en a pas.
statestring (approval_required | approved)facultatif
approval_required tant qu'une demande attend le validateur, approved une fois validée, sinon null.
requestIdstringfacultatif
L'id de la demande de validation en attente, ou null.
feedbackstringfacultatif
La raison donnée par le validateur lorsqu'il a demandé des modifications, tant que la tâche est rouverte. Sinon null.
detailsobjectfacultatif
Libellés, date de début, estimation du temps et fichiers joints.
labelsarray of stringfacultatif
startDatestringfacultatif
estimatedMinutesintegerfacultatif
attachmentsarray of objectfacultatif
keystringfacultatif
namestringfacultatif
mimestringfacultatif
sizeintegerfacultatif
prioritystring (urgent | high | medium | low)facultatif
La priorité de la tâche, ou null.
dueAtstringfacultatif
L'échéance de la tâche, en UTC, ou null.
createdAtstringfacultatif
Date de création de la tâche, en UTC.
updatedAtstringfacultatif
Date de la dernière modification de la tâche, en UTC.
completedAtstringfacultatif
Date d'achèvement de la tâche, en UTC, ou null.
blockedByarray of stringfacultatif
Clés des éléments ouverts à terminer avant cette tâche.
openSubtaskCountintegerfacultatif
Nombre de ses sous-tâches encore ouvertes.
commentCountintegerfacultatif
Nombre de commentaires sur la tâche.
rowVersionintegerfacultatif
Le numéro de version de la tâche. Il augmente à chaque modification de la tâche.
Erreurs
401Clé API manquante, invalide, expirée ou révoquée.
403Les erreurs de Tâches et validations renvoient ok: false avec un objet error contenant code, message, retryable et details. Les erreurs de la vérification de la clé API elle-même (clé absente ou invalide, scope manquant, limite de débit) utilisent le format standard, où error est une chaîne.
404Les erreurs de Tâches et validations renvoient ok: false avec un objet error contenant code, message, retryable et details. Les erreurs de la vérification de la clé API elle-même (clé absente ou invalide, scope manquant, limite de débit) utilisent le format standard, où error est une chaîne.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
500La requête n'a pas pu aboutir à cause d'un problème de notre côté.
get/api/v1/work-management/tasks/{id}
Votre clé API
id *
{}