Supprimer un enregistrement

La syntaxe permettant de supprimer un enregistrement avec un identifiant unique est la suivante (méthode DELETE):

curl --insecure --silent \
     -H "Authorization: Bearer <bearer_token>" \
     -X DELETE
     'https://<host>/api/v1/<taskId>/<recordId>'

Si le code de retour HTTP est 200, la réponse sera structurée comme ceci:

{
  "metadata": {
    "apiVersion": "1.0",
    "taskId": "<taskId>",
    "taskType": "<type>",
    "domainId": "<domain>"
  },
  "data": { ... }
}

Selon le type de tâche (taskType), le contenu de la clé data prend différentes formes (voir ici). Les données retournées correspondent à l’enregistrement supprimé.

Attention:

La suppression est supportée dans les tâches simples, dossier et à double niveau (types B, R et F).

Note:

Pour une tâche à double niveau (taskType = F), la suppression porte sur l’en-tête de l’enregistrement et entraîne la suppression de toutes ses lignes.

Paramètres

Paramètres Type Description
autoAcknowledge Boolean Voir la description générale.
Note:

Ce paramètre s’applique également à la suppression d’une page.

Supprimer une page

La suppression d’une page s’effectue avec la commande suivante:

curl --insecure --silent \
     -H "Authorization: Bearer <bearer_token>" \
     -X DELETE
     'https://<host>/api/v1/<taskId>/<recordId>/pages/<pageId>/<occurrence>'

Si le code de retour HTTP est 200, la réponse sera structurée comme ceci:

{
  "metadata": {
    "apiVersion": "1.0",
    "taskId": "<taskId>",
    "taskType": "<type>",
    "domainId": "<domain>"
  },
  "data": { ... }
}