v1Ressources/Approvals/postCréer une tâche
Créer une tâche
Crée une tâche dans Tâches et validations. Une tâche est un travail que votre équipe suit pour un client, ou pour l'agence elle-même si vous omettez clientId. Dans le même appel, vous pouvez définir un responsable, un validateur et jusqu'à 25 sous-tâches ; les sous-tâches ajoutées ici reprennent le responsable, le validateur, la priorité et les dates de la tâche, sauf si vous leur en donnez d'autres. Pour créer une sous-tâche d'une tâche ouverte existante, transmettez plutôt parentTaskId. Si le responsable est un utilisateur client et que vous omettez clientId, la tâche est créée pour le client de cet utilisateur. Les nouvelles tentatives sont sans risque : renvoyer le même idempotencyKey avec le même corps renvoie le premier résultat avec replayed à true, et réutiliser une clé avec un autre corps renvoie 409. Si Tâches et validations n'est pas activé pour votre espace de travail, la réponse est 404.
post
approvals:write/api/v1/work-management/tasksCorps de la requête
idempotencyKeystringobligatoire
Une chaîne unique de votre choix, de 8 à 200 caractères. Réutilisez-la uniquement pour relancer la même requête.
clientIdstringfacultatif
Le client concerné par la tâche. Omettez-le ou envoyez null pour un travail interne à l'agence. Avec une clé qui a accès à tous les clients, accepte l'id, l'id public ou le slug du client. Avec une clé limitée à certains clients, passez l'id du client ; toute autre valeur, ou un client hors de l'accès de la clé, renvoie 403. Une sous-tâche partage toujours le client de sa tâche parente, et en indiquer un autre renvoie 400.
titlestringobligatoire
Le titre de la tâche, jusqu'à 500 caractères.
descriptionstringfacultatif
Ce qu'il faut faire, jusqu'à 20 000 caractères.
locationIdstringfacultatif
Un établissement du client de la tâche, concerné par la tâche. Un établissement d'un autre client renvoie 400.
projectIdstringfacultatif
Un projet du même client dans lequel regrouper la tâche.
parentTaskIdstringfacultatif
Crée cette tâche comme sous-tâche d'une tâche existante. La tâche parente doit être ouverte et ne peut pas être elle-même une sous-tâche. La nouvelle sous-tâche reprend le responsable, le validateur, le projet, l'établissement, la priorité, la date d'échéance et la date de début de la tâche parente, sauf si vous envoyez vos propres valeurs. Incompatible avec subtasks.
metaobjectfacultatif
Priorité et date d'échéance. Envoyez les deux champs ensemble. Par défaut, priorité medium et aucune date d'échéance.
prioritystring (urgent | high | medium | low)obligatoire
Le degré d'urgence de la tâche.
dueDatestringobligatoire
Date d'échéance au format YYYY-MM-DD dans le fuseau horaire de votre espace de travail, ou null.
detailsobjectfacultatif
Libellés, date de début et estimation du temps.
labelsarray of stringfacultatif
Jusqu'à 10 libellés de 40 caractères chacun. Les doublons qui ne diffèrent que par la casse sont fusionnés.
startDatestringfacultatif
Date de début au format YYYY-MM-DD, ou null. Elle ne peut pas être postérieure à la date d'échéance.
estimatedMinutesintegerfacultatif
Effort estimé en minutes, ou null.
subtasksarray of objectfacultatif
Jusqu'à 25 sous-tâches à créer avec la tâche. Chacune reprend le responsable, le validateur, la priorité, la date d'échéance et la date de début de la tâche, sauf si vous lui en donnez d'autres.
titlestringobligatoire
Le titre de la sous-tâche, jusqu'à 200 caractères.
descriptionstringfacultatif
Ce que couvre la sous-tâche, jusqu'à 20 000 caractères.
ownerIdstringfacultatif
Le responsable de la sous-tâche. Omettez-le pour reprendre celui de la tâche, ou envoyez null pour aucun responsable.
ownerTypestring (user | client_user)facultatif
Indique si le responsable est un membre de l'équipe de l'agence (user) ou un utilisateur client (client_user). Par défaut : user.
approverIdstringfacultatif
Le validateur de la sous-tâche. Omettez-le pour reprendre celui de la tâche, ou envoyez null pour aucun.
dueDatestringfacultatif
Date d'échéance de la sous-tâche au format YYYY-MM-DD, ou null.
startDatestringfacultatif
Date de début de la sous-tâche au format YYYY-MM-DD, ou null.
prioritystring (urgent | high | medium | low)facultatif
La priorité de la sous-tâche.
ownerIdstringfacultatif
L'id de la personne responsable de la tâche, issu de GET /api/v1/work-management/owners. Envoyez null pour aucun responsable. Pour une sous-tâche, l'omettre reprend le responsable de la tâche parente.
ownerTypestring (user | client_user)facultatif
Indique si le responsable est un membre de l'équipe de l'agence (user) ou un utilisateur client (client_user). Par défaut : user.
approverIdstringfacultatif
L'id d'un membre de l'équipe de l'agence qui valide le travail de la tâche lorsqu'une validation est demandée. Envoyez null pour aucun.
Réponse
okbooleanfacultatif
Toujours true pour une réponse réussie.
dataobjectfacultatif
keystringfacultatif
La clé de la tâche, au format task:<id>.
rowVersionintegerfacultatif
Le numéro de version de la tâche. Il augmente à chaque modification de la tâche.
replayedbooleanfacultatif
true lorsque cette réponse reprend une requête précédente avec le même idempotencyKey : rien de nouveau n'a été enregistré.
Erreurs
400Les 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.
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.
409Les 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é.
post/api/v1/work-management/tasks
Votre clé API
Corps de la requête*
{}