Configuration de Dataset

Liste des requêtes disponibles pour intéragir avec les configuration de datasets .

Générer un dataset (IDs de config OU contenu inline)

post

Cette route lance une génération de dataset en mode dev.

Vous pouvez fournir soit des identifiants de configuration (dataset_config_id, rules_config_id), soit le contenu directement via yaml_content et/ou rules_content.

• dataset_config_id (optionnel) : si renseigné, le contenu YAML stocké côté serveur remplace yaml_content. • rules_config_id (optionnel) : si renseigné, le contenu des règles côté serveur remplace rules_content. • yaml_content (optionnel) : contenu YAML converti en JSON quand vous n'utilisez pas dataset_config_id. • rules_content (optionnel) : règles en JSON quand vous n'utilisez pas rules_config_id.

Priorité : en cas de doublon, les IDs priment sur les contenus inline. Crédit : le nombre de lignes (numberOfRecords) dans yaml_content détermine la consommation de crédits.

Query parameters

api_keystringRequired

Body

application/json

end_formatstringRequired

Format de sortie souhaité (ex: csv, json)

yaml_contentany ofOptional

Contenu YAML sous forme d'objet JSON

objectOptional

or

nullOptional

rules_contentany ofOptional

Règles optionnelles de génération

objectOptional

or

nullOptional

campaignidany ofOptional

Identifiant de campagne, ignoré en mode dev

stringOptional

or

nullOptional

faker_name_dictany ofOptional

Variables faker personnalisées

objectOptional

or

nullOptional

dataset_config_idany ofOptional

Identifiant d'une config dataset optionnel. Si fourni, il remplace yaml_content.

stringOptional

or

nullOptional

rules_config_idany ofOptional

Identifiant d'une config de règles optionnel. Si fourni, il remplace rules_content.

stringOptional

or

nullOptional

Responses

200

Requête réussie — la liste des types Faker est renvoyée.

application/json

400

API Key invalide

application/json

401

API Key invalide

application/json

422

Validation Error

application/json

post

/dev/generate_dataset

HTTPcURLJavaScriptPython

POST /dev/generate_dataset?api_key=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 151

{
  "end_format": "text",
  "yaml_content": {},
  "rules_content": {},
  "campaignid": "text",
  "faker_name_dict": {},
  "dataset_config_id": "text",
  "rules_config_id": "text"
}

{
  "message": "Dataset yannfurrer ajouté à la queue avec process_id 745abf24-5cf9-43de-b5ef-fb96551e441b",
  "process_id": "745abf24-5cf9-43de-b5ef-fb96",
  "nb_credit_used": 12130,
  "nb_credit_remaining": 1002118520
}

Vérifie le statut d'un processus de génération

get

Cette route permet de vérifier le statut d'un dataset en cours de génération. Le process_id est fourni en tant que paramètre de requête, il preivent de la requête de /dev/generate_dataset. Un token développeur valide est requis pour accéder à cette route.Le statut retourné peut être : waiting, running, success, error, ou None si le processus est inconnu.Lorsque le statut est success, un champs supplémentaire s3_url est retourné contenant le dataset généré. Attention, ce champs n'est disponible que 15 minutes avant expiration

Query parameters

process_idstringRequired

Identifiant unique du processus de génération

api_keystringRequired

Clé API

Responses

200

Requête réussie — le statut du processus de génération.

application/json

400

API Key invalide

application/json

401

API Key invalide

application/json

422

Validation Error

application/json

500

Erreur interne du serveur.

application/json

get

/dev/ping_generation_process

HTTPcURLJavaScriptPython

GET /dev/ping_generation_process?process_id=text&api_key=text HTTP/1.1
Accept: */*

{
  "status": {
    "status": "waiting",
    "pourcentage": 0,
    "nb_rows": 1000000,
    "current_rows": 0
  }
}

Vérifie si le dataset config est valide

post

Cette route permet de vérifier si le dataset config est valideLe api_key est requis pour accéder à cette route.Le paramètre yaml_content est requis et doit contenir un dictionnaire de données.Il représente le contenu YAML converti en JSON.

Query parameters

api_keystringRequired

Body

application/json

yaml_contentobject · YamlContentRequired

dataset configuration convertie en json

end_formatstringRequired

format du fichier yaml

Responses

200

Requête réussie — le dataset config est valide.

application/json

400

API Key invalide

application/json

422

Validation Error

application/json

500

Erreur interne du serveur.

application/json

post

/dev/check_dataset_config_is_valid

HTTPcURLJavaScriptPython

POST /dev/check_dataset_config_is_valid?api_key=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "yaml_content": {},
  "end_format": "text"
}

{
  "message": "Dataset config is valid",
  "is_valid": true
}