​
Vue d’ensemble de l’entité CustomProcess

L’entité CustomProcess possède plusieurs attributs utiles, notamment :

  • id : L’identifiant unique du flux, généré automatiquement avec le préfixe cproc_
  • name : Le nom du flux personnalisé.
  • status : Une énumération indiquant l’état du flux. Ses valeurs peuvent être pending, running, success, failed, aborted et timeout
  • start_at : La date et l’heure de début du flux.
  • end_at : La date et l’heure de fin du flux.
  • payload : Un objet JSON contenant des informations sur le résultat du flux, telles que le nombre d’éléments ajoutés, ignorés ou mis à jour.
  • url_file : L’URL du fichier associé au flux, le cas échéant.
  • bridge_metadata : Un objet JSON permettant de stocker des métadonnées spécifiques au bridge.
  • created_at : La date et l’heure de création de l’enregistrement.
  • updated_at : La date et l’heure de la dernière mise à jour de l’enregistrement.

​
Relations

L’entité CustomProcess a également des relations importantes :

  • parent : Une relation many-to-one vers un autre CustomProcess, représentant le flux parent.
  • children : Une relation one-to-many vers d’autres CustomProcess, représentant les flux enfants.

L’entité CustomProcess hérite de SoftDeletableEntity, ce qui signifie qu’elle supporte la suppression logique. Les enregistrements supprimés ne sont pas physiquement effacés de la base de données, mais marqués comme supprimés.

​
Playground

Essayer l'API

Découvrez comment utiliser l’API pour intéragir avec les flux.

​
Exemple de modèle JSON

Voici un exemple complet de ce à quoi pourrait ressembler une instance de CustomProcess en JSON :

{
  "id": "cproc_01H1G5V27GYX4QXFXYD9G63300",
  "name": "Flux de test",
  "status": "pending",
  "start_at": "2023-07-15T10:30:00.000Z",
  "end_at": "2023-07-15T14:45:00.000Z",
  "payload": {
    "added": 10,
    "ignored": 2,
    "updated": 1
  },
  "url_file": "https://example.com/files/test.csv",
  "parent_id":null,
  "children": [
    {
      "id": "cproc_01H1G5V27GYX4QXFXYD9G63301",
      "name": "Flux de test 2",
      "status": "pending",
      "start_at": "2023-07-15T10:30:00.000Z",
      "end_at": "2023-07-15T14:45:00.000Z",
      "payload": {
        "added": 10,
        "ignored": 2,
        "updated": 1
      },
      "url_file": null,
      "parent_id": "cproc_01H1G5V27GYX4QXFXYD9G63300",
      "created_at": "2023-07-15T10:30:00.000Z",
      "updated_at": "2023-07-15T14:45:00.000Z",
    }
  ],
  "created_at": "2023-07-15T10:30:00.000Z",
  "updated_at": "2023-07-15T14:45:00.000Z"
}
AttributsMarques