> For the complete documentation index, see [llms.txt](https://www.center.daxium-air.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.center.daxium-air.com/api-reference/doc-api/publipostages.md).
# Publipostages
## Lister les modèles de publipostage
> Retourne les modèles de publipostage disponibles pour un formulaire (\`structure\`)\
> ou pour une fiche (\`submission\`). Fournissez l'un \*\*ou\*\* l'autre paramètre.
```json
{"openapi":"3.0.3","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"publipostages"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"AppShort":{"name":"app_short","in":"path","required":true,"description":"Nom court de l'instance (ex. `daxium-test`)","schema":{"type":"string"}}},"schemas":{"ReportTemplateListResponse":{"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/ReportTemplate"}},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"server_time":{"type":"integer","format":"int64"}}},"ReportTemplate":{"type":"object","description":"Modèle de publipostage","properties":{"id":{"type":"integer","description":"Identifiant du modèle"},"name":{"type":"string","description":"Nom du modèle"},"listingMode":{"type":"boolean","description":"Indique si le modèle est en mode listing"},"templateEngine":{"type":"string","description":"Moteur de génération du modèle (ex. docxopenxml, xlsxaspose)"}}}}},"paths":{"/{app_short}/report_templates":{"get":{"summary":"Lister les modèles de publipostage","description":"Retourne les modèles de publipostage disponibles pour un formulaire (`structure`)\nou pour une fiche (`submission`). Fournissez l'un **ou** l'autre paramètre.\n","tags":["publipostages"],"operationId":"listReportTemplates","parameters":[{"$ref":"#/components/parameters/AppShort"},{"name":"structure","in":"query","description":"Identifiant du formulaire dont récupérer les modèles","schema":{"type":"integer"}},{"name":"submission","in":"query","description":"Identifiant (UUID) de la fiche dont récupérer les modèles","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Modèles de publipostage disponibles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportTemplateListResponse"}}}}}}}}}
```
## Lister les publipostages d'une fiche
> Retourne tous les publipostages générés pour une fiche donnée.
```json
{"openapi":"3.0.3","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"publipostages"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"AppShort":{"name":"app_short","in":"path","required":true,"description":"Nom court de l'instance (ex. `daxium-test`)","schema":{"type":"string"}}},"schemas":{"ReportListResponse":{"type":"object","properties":{"reports":{"type":"array","items":{"$ref":"#/components/schemas/Report"}},"total_count":{"type":"integer"},"next_page":{"type":"integer"},"server_time":{"type":"integer","format":"int64"}}},"Report":{"type":"object","description":"Publipostage généré","properties":{"id":{"type":"integer","description":"Identifiant du publipostage"},"status":{"type":"string","description":"Statut du publipostage (ex. finished, error)"},"original_document":{"type":"object","description":"Fichier généré au format d'origine","properties":{"file_uuid":{"type":"string","description":"UUID du fichier généré"},"file_name":{"type":"string","description":"Nom du fichier généré"}}},"pdf_document":{"type":"object","description":"Fichier généré au format PDF","properties":{"file_uuid":{"type":"string"},"file_name":{"type":"string"}}},"errorMessage":{"type":"string","description":"Message d'erreur, le cas échéant"}}}}},"paths":{"/{app_short}/reports":{"get":{"summary":"Lister les publipostages d'une fiche","description":"Retourne tous les publipostages générés pour une fiche donnée.","tags":["publipostages"],"operationId":"listReportsBySubmission","parameters":[{"$ref":"#/components/parameters/AppShort"},{"name":"submission","in":"query","required":true,"description":"Identifiant (UUID) de la fiche","schema":{"type":"string","format":"uuid"}},{"name":"per_page","in":"query","description":"Nombre de publipostages par page (défaut 10, maximum 1000)","schema":{"type":"integer"}},{"name":"page","in":"query","description":"Numéro de la page demandée","schema":{"type":"integer"}},{"name":"updated_since","in":"query","description":"Filtre les publipostages mis à jour après cette date (timestamp)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Liste paginée des publipostages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportListResponse"}}}}}}}}}
```
## Lancer un publipostage
> 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éé.
```json
{"openapi":"3.0.3","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"publipostages"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"AppShort":{"name":"app_short","in":"path","required":true,"description":"Nom court de l'instance (ex. `daxium-test`)","schema":{"type":"string"}}},"schemas":{"ReportInput":{"type":"object","required":["template_id","submission_id","api_callback"],"description":"Corps de lancement d'un publipostage","properties":{"template_id":{"type":"integer","description":"Identifiant du modèle (obligatoire)"},"submission_id":{"type":"string","format":"uuid","description":"Identifiant de la fiche (obligatoire)"},"api_callback":{"type":"string","description":"URL appelée (PUT) à la fin de la génération ; `{publipostage_id}` y est substitué (obligatoire)"},"header_name":{"type":"string","description":"Nom d'en-tête HTTP à transmettre lors du callback (optionnel)"},"header_value":{"type":"string","description":"Valeur d'en-tête HTTP à transmettre lors du callback (optionnel)"},"join_format":{"type":"string","enum":["original","pdf","original,pdf"],"description":"Format de sortie : `original`, `pdf`, ou `original,pdf` (deux rapports générés)"}}}}},"paths":{"/{app_short}/reports":{"post":{"summary":"Lancer un publipostage","description":"Démarre la génération d'un publipostage pour une fiche à partir d'un modèle.\nL'URL `api_callback` est appelée (méthode PUT) une fois la génération terminée ;\n`{publipostage_id}` y est remplacé par l'identifiant du publipostage créé.\n","tags":["publipostages"],"operationId":"startReport","parameters":[{"$ref":"#/components/parameters/AppShort"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportInput"}}}},"responses":{"200":{"description":"Publipostage créé","content":{"application/json":{"schema":{"type":"object","properties":{"report_id":{"type":"integer","description":"Identifiant du publipostage créé"}}}}}}}}}}}
```
## Récupérer les informations d'un publipostage
> Retourne le statut et les fichiers générés d'un publipostage par son identifiant.
```json
{"openapi":"3.0.3","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"publipostages"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"AppShort":{"name":"app_short","in":"path","required":true,"description":"Nom court de l'instance (ex. `daxium-test`)","schema":{"type":"string"}}},"schemas":{"Report":{"type":"object","description":"Publipostage généré","properties":{"id":{"type":"integer","description":"Identifiant du publipostage"},"status":{"type":"string","description":"Statut du publipostage (ex. finished, error)"},"original_document":{"type":"object","description":"Fichier généré au format d'origine","properties":{"file_uuid":{"type":"string","description":"UUID du fichier généré"},"file_name":{"type":"string","description":"Nom du fichier généré"}}},"pdf_document":{"type":"object","description":"Fichier généré au format PDF","properties":{"file_uuid":{"type":"string"},"file_name":{"type":"string"}}},"errorMessage":{"type":"string","description":"Message d'erreur, le cas échéant"}}}}},"paths":{"/{app_short}/reports/{report_id}":{"get":{"summary":"Récupérer les informations d'un publipostage","description":"Retourne le statut et les fichiers générés d'un publipostage par son identifiant.","tags":["publipostages"],"operationId":"getReport","parameters":[{"$ref":"#/components/parameters/AppShort"},{"name":"report_id","in":"path","required":true,"description":"Identifiant du publipostage","schema":{"type":"integer"}}],"responses":{"200":{"description":"Informations du publipostage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Report"}}}}}}}}}
```
## Télécharger le fichier généré d'un publipostage
> Retourne le fichier (binaire) généré par un publipostage à partir de son UUID.
```json
{"openapi":"3.0.3","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"publipostages"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"AppShort":{"name":"app_short","in":"path","required":true,"description":"Nom court de l'instance (ex. `daxium-test`)","schema":{"type":"string"}}}},"paths":{"/{app_short}/reports/{report_id}/results/{file_uuid}":{"get":{"summary":"Télécharger le fichier généré d'un publipostage","description":"Retourne le fichier (binaire) généré par un publipostage à partir de son UUID.","tags":["publipostages"],"operationId":"getReportResultFile","parameters":[{"$ref":"#/components/parameters/AppShort"},{"name":"report_id","in":"path","required":true,"description":"Identifiant du publipostage","schema":{"type":"integer"}},{"name":"file_uuid","in":"path","required":true,"description":"UUID du fichier généré","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Contenu binaire du fichier généré","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://www.center.daxium-air.com/api-reference/doc-api/publipostages.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.