For the complete documentation index, see llms.txt. This page is also available as Markdown.

Publipostages

Générer des documents (éditique) à partir de modèles et de fiches

Lister les modèles de publipostage

get

Retourne les modèles de publipostage disponibles pour un formulaire (structure) ou pour une fiche (submission). Fournissez l'un ou l'autre paramètre.

Autorisations
AuthorizationstringRequis
Bearer authentication header of the form Bearer <token>.
Paramètres de chemin
app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

Paramètres de requête
structureintegerOptionnel

Identifiant du formulaire dont récupérer les modèles

submissionstring · uuidOptionnel

Identifiant (UUID) de la fiche dont récupérer les modèles

Réponses
200

Modèles de publipostage disponibles

application/json
total_countintegerOptionnel
total_pagesintegerOptionnel
server_timeinteger · int64Optionnel
get/{app_short}/report_templates
200

Modèles de publipostage disponibles

Lister les publipostages d'une fiche

get

Retourne tous les publipostages générés pour une fiche donnée.

Autorisations
AuthorizationstringRequis
Bearer authentication header of the form Bearer <token>.
Paramètres de chemin
app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

Paramètres de requête
submissionstring · uuidRequis

Identifiant (UUID) de la fiche

per_pageintegerOptionnel

Nombre de publipostages par page (défaut 10, maximum 1000)

pageintegerOptionnel

Numéro de la page demandée

updated_sinceinteger · int64Optionnel

Filtre les publipostages mis à jour après cette date (timestamp)

Réponses
200

Liste paginée des publipostages

application/json
total_countintegerOptionnel
next_pageintegerOptionnel
server_timeinteger · int64Optionnel
get/{app_short}/reports
200

Liste paginée des publipostages

Lancer un publipostage

post

Démarre la génération d'un publipostage pour une fiche à partir d'un modèle. L'URL api_callback est appelée (méthode PUT) une fois la génération terminée ; {publipostage_id} y est remplacé par l'identifiant du publipostage créé.

Autorisations
AuthorizationstringRequis
Bearer authentication header of the form Bearer <token>.
Paramètres de chemin
app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

Corps

Corps de lancement d'un publipostage

template_idintegerRequis

Identifiant du modèle (obligatoire)

submission_idstring · uuidRequis

Identifiant de la fiche (obligatoire)

api_callbackstringRequis

URL appelée (PUT) à la fin de la génération ; {publipostage_id} y est substitué (obligatoire)

header_namestringOptionnel

Nom d'en-tête HTTP à transmettre lors du callback (optionnel)

header_valuestringOptionnel

Valeur d'en-tête HTTP à transmettre lors du callback (optionnel)

join_formatstring · enumOptionnel

Format de sortie : original, pdf, ou original,pdf (deux rapports générés)

Valeurs possibles:
Réponses
200

Publipostage créé

application/json
report_idintegerOptionnel

Identifiant du publipostage créé

post/{app_short}/reports
200

Publipostage créé

Récupérer les informations d'un publipostage

get

Retourne le statut et les fichiers générés d'un publipostage par son identifiant.

Autorisations
AuthorizationstringRequis
Bearer authentication header of the form Bearer <token>.
Paramètres de chemin
app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

report_idintegerRequis

Identifiant du publipostage

Réponses
200

Informations du publipostage

application/json

Publipostage généré

idintegerOptionnel

Identifiant du publipostage

statusstringOptionnel

Statut du publipostage (ex. finished, error)

errorMessagestringOptionnel

Message d'erreur, le cas échéant

get/{app_short}/reports/{report_id}
200

Informations du publipostage

Télécharger le fichier généré d'un publipostage

get

Retourne le fichier (binaire) généré par un publipostage à partir de son UUID.

Autorisations
AuthorizationstringRequis
Bearer authentication header of the form Bearer <token>.
Paramètres de chemin
app_shortstringRequis

Nom court de l'instance (ex. daxium-test)

report_idintegerRequis

Identifiant du publipostage

file_uuidstring · uuidRequis

UUID du fichier généré

Réponses
200

Contenu binaire du fichier généré

application/octet-stream
string · binaryOptionnel
get/{app_short}/reports/{report_id}/results/{file_uuid}
200

Contenu binaire du fichier généré

Mis à jour

Ce contenu vous a-t-il été utile ?