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

Fiches

Créer, lire, mettre à jour, supprimer et rechercher des fiches

Lister les fiches d'un formulaire

get

Retourne les fiches d'un formulaire avec pagination. Définissez reference=true pour retourner toutes les données de référence (omettez alors structure_id).

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
structure_idintegerOptionnel

Identifiant du formulaire (obligatoire sauf si reference=true)

per_pageintegerOptionnel

Nombre de fiches par page

pageintegerOptionnel

Numéro de la page demandée

updated_sinceinteger · int64Optionnel

Filtre les fiches mises à jour depuis ce timestamp UNIX

items_expandedbooleanOptionnel

Retourner les libellés des listes au lieu des identifiants

referencebooleanOptionnel

Définir à true pour retourner toutes les données de référence (listes de référence partagées par tous les formulaires, utilisées pour pré-remplir des champs). Omettez structure_id dans ce cas.

Réponses
200

Fiches paginées

application/json
total_countintegerOptionnel

Nombre total de fiches

total_pagesintegerOptionnel

Nombre total de pages

server_timeinteger · int64Optionnel

Date courante du serveur (timestamp UNIX)

get/{app_short}/submissions
Par formulaire
200

Fiches paginées

Créer une fiche

post

Crée une nouvelle fiche. Pour les champs de type image, signature ou file, envoyez d'abord le fichier via l'endpoint dédié et utilisez l'UUID retourné ici.

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
partialbooleanOptionnel

Si true, ignore les permissions de champs (requis / modifiable)

Corps
idstring · uuidOptionnel

Généré automatiquement par le serveur si omis

structure_idintegerRequis

Identifiant du formulaire

structure_versionintegerRequis

Version du formulaire

created_atinteger · int64Optionnel

Date de création (défaut : maintenant)

updated_atinteger · int64Optionnel

Date de dernière modification (défaut : maintenant)

trigger_idstring · uuidOptionnel

Transition de workflow à appliquer (PUT/PATCH uniquement)

substitute_user_idintegerOptionnel

Optionnel. Définit un autre utilisateur comme créateur/propriétaire. L'utilisateur authentifié est toujours tracé dans l'historique.

Réponses
200

Fiche créée

application/json
idstring · uuidOptionnel

Identifiant de la fiche

structure_idintegerOptionnel

Identifiant du formulaire

structure_versionintegerOptionnel

Version du formulaire

created_atinteger · int64Optionnel

Date de création (timestamp UNIX)

updated_atinteger · int64Optionnel

Date de mise à jour (timestamp UNIX)

data_created_atinteger · int64Optionnel

Date de création des données sur le serveur

data_updated_atinteger · int64Optionnel

Date de dernière mise à jour des données sur le serveur

user_idintegerOptionnel

Propriétaire de la fiche

channelsstring[]Optionnel

Conditions remplies par la fiche

submission_numberintegerOptionnel

Numéro séquentiel global

number_in_structureintegerOptionnel

Numéro séquentiel au sein du formulaire

latitudenumber · doubleOptionnel

Latitude de la fiche

longitudenumber · doubleOptionnel

Longitude de la fiche

last_updated_user_idintegerOptionnel

Identifiant du dernier utilisateur ayant modifié la fiche

current_statestring · uuid · nullableOptionnel

UUID de l'état de workflow courant (null si pas de workflow)

post/{app_short}/submissions
CLI
200

Fiche créée

Récupérer des fiches par identifiants (jusqu'à 500)

post

Retourne les fiches correspondant aux UUIDs fournis. Maximum 500 identifiants par requête. Chaque identifiant peut optionnellement porter un filtre updated_since.

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
items_expandedbooleanOptionnel

Retourner les libellés des listes au lieu des identifiants

Corps
Réponses
200

Fiches correspondantes

application/json
post/{app_short}/submissions/byids

Rechercher des fiches

post

Retourne les fiches correspondant aux critères de recherche par champ. Chaque champ ne peut apparaître qu'une seule fois. La casse des opérateurs est significative.

Opérateur
Types de champs compatibles

equal / notequal

texte, nombre, booléen, date, email, téléphone

isNull / isNotNull

tous

less / greater / lesseq / greatereq

nombre

contains / notContains / startWith / endWith

texte, email, téléphone

in

liste, utilisateur, texte

range

nombre, date

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
structure_idintegerRequis

Identifiant du formulaire

per_pageintegerOptionnel

Nombre de fiches par page

pageintegerOptionnel

Numéro de la page demandée

last_updated_user_idintegerOptionnel

Filtre les fiches dont la dernière modification a été effectuée par l'utilisateur ayant cet identifiant. Critère optionnel passé directement dans l'URL.

Corps

Objet dont chaque clé est un nom système de champ valide. Respectez la casse des opérateurs.

Réponses
200

Fiches correspondantes

application/json
total_countintegerOptionnel

Nombre total de fiches

total_pagesintegerOptionnel

Nombre total de pages

server_timeinteger · int64Optionnel

Date courante du serveur (timestamp UNIX)

post/{app_short}/submissions/search
200

Fiches correspondantes

Créer plusieurs fiches (asynchrone)

post

Crée jusqu'à 100 fiches de manière asynchrone. Interrogez le callbackUrl pour suivre l'avancement.

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

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

Corpsobject · SubmissionInput[]
idstring · uuidOptionnel

Généré automatiquement par le serveur si omis

structure_idintegerRequis

Identifiant du formulaire

structure_versionintegerRequis

Version du formulaire

created_atinteger · int64Optionnel

Date de création (défaut : maintenant)

updated_atinteger · int64Optionnel

Date de dernière modification (défaut : maintenant)

trigger_idstring · uuidOptionnel

Transition de workflow à appliquer (PUT/PATCH uniquement)

substitute_user_idintegerOptionnel

Optionnel. Définit un autre utilisateur comme créateur/propriétaire. L'utilisateur authentifié est toujours tracé dans l'historique.

Réponses
200

Job asynchrone accepté

application/json
callbackUrlstringOptionnel

URL à interroger pour suivre l'avancement du job asynchrone

post/{app_short}/submissions/multiple

Mettre à jour plusieurs fiches (asynchrone)

put

Met à jour jusqu'à 100 fiches de manière asynchrone. Interrogez le callbackUrl pour suivre l'avancement.

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

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

Corpsobject · SubmissionInput[]
idstring · uuidOptionnel

Généré automatiquement par le serveur si omis

structure_idintegerRequis

Identifiant du formulaire

structure_versionintegerRequis

Version du formulaire

created_atinteger · int64Optionnel

Date de création (défaut : maintenant)

updated_atinteger · int64Optionnel

Date de dernière modification (défaut : maintenant)

trigger_idstring · uuidOptionnel

Transition de workflow à appliquer (PUT/PATCH uniquement)

substitute_user_idintegerOptionnel

Optionnel. Définit un autre utilisateur comme créateur/propriétaire. L'utilisateur authentifié est toujours tracé dans l'historique.

Réponses
200

Job asynchrone accepté

application/json
callbackUrlstringOptionnel

URL à interroger pour suivre l'avancement du job asynchrone

put/{app_short}/submissions/multiple

Consulter le statut d'un job asynchrone de fiches

get

Retourne le statut courant et les résultats par fiche d'un job de création ou de mise à jour multiple.

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

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

callback_idstring · uuidRequis

Identifiant de callback retourné par l'endpoint asynchrone

Réponses
200

Statut et détails du job

application/json
get/{app_short}/submissions/multiple/callback/{callback_id}
200

Statut et détails du job

Envoyer un fichier pour une fiche

post

Envoie un fichier à lier à un champ de fiche (image, signature ou fichier). Une fois lié, le fichier ne peut plus être réutilisé dans une autre fiche. Utilisez l'uuid retourné dans le champ correspondant.

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
string · binaryOptionnel
Réponses
200

Fichier envoyé — utilisez l'uuid retourné dans le champ de la fiche

application/json
uuidstring · uuidOptionnel

Référencez cet UUID dans les champs de fiche de type image/signature/fichier

mime-typestringOptionnel

Type MIME du fichier

sizeintegerOptionnel

Taille du fichier en octets

post/{app_short}/submissions/upload
200

Fichier envoyé — utilisez l'uuid retourné dans le champ de la fiche

Envoyer un fichier avec son identifiant et celui de la fiche

post

Alternative à l'envoi simple — précisez directement l'UUID de la fiche et l'UUID du fichier.

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

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

submissionIdstring · uuidRequis

Identifiant de la fiche (UUID)

fileIdstring · uuidRequis

Identifiant du fichier (UUID)

Corps
string · binaryOptionnel
Réponses
200

Fichier envoyé

application/json
uuidstring · uuidOptionnel

Référencez cet UUID dans les champs de fiche de type image/signature/fichier

mime-typestringOptionnel

Type MIME du fichier

sizeintegerOptionnel

Taille du fichier en octets

post/{app_short}/submissions/upload/{submissionId}/{fileId}
200

Fichier envoyé

Récupérer une fiche

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

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

idstring · uuidRequis

Identifiant de la fiche (UUID)

Réponses
200

Objet fiche

application/json
idstring · uuidOptionnel

Identifiant de la fiche

structure_idintegerOptionnel

Identifiant du formulaire

structure_versionintegerOptionnel

Version du formulaire

created_atinteger · int64Optionnel

Date de création (timestamp UNIX)

updated_atinteger · int64Optionnel

Date de mise à jour (timestamp UNIX)

data_created_atinteger · int64Optionnel

Date de création des données sur le serveur

data_updated_atinteger · int64Optionnel

Date de dernière mise à jour des données sur le serveur

user_idintegerOptionnel

Propriétaire de la fiche

channelsstring[]Optionnel

Conditions remplies par la fiche

submission_numberintegerOptionnel

Numéro séquentiel global

number_in_structureintegerOptionnel

Numéro séquentiel au sein du formulaire

latitudenumber · doubleOptionnel

Latitude de la fiche

longitudenumber · doubleOptionnel

Longitude de la fiche

last_updated_user_idintegerOptionnel

Identifiant du dernier utilisateur ayant modifié la fiche

current_statestring · uuid · nullableOptionnel

UUID de l'état de workflow courant (null si pas de workflow)

get/{app_short}/submissions/{id}
200

Objet fiche

Mettre à jour une fiche

put

Remplace les données d'une fiche. Pour les formulaires avec workflow, incluez trigger_id pour faire avancer l'état. Les fiches dans un état final ne peuvent plus être modifiées.

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

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

idstring · uuidRequis

Identifiant de la fiche (UUID)

Paramètres de requête
partialbooleanOptionnel

Si true, ignore les permissions de champs (requis / modifiable)

Corps
idstring · uuidOptionnel

Généré automatiquement par le serveur si omis

structure_idintegerRequis

Identifiant du formulaire

structure_versionintegerRequis

Version du formulaire

created_atinteger · int64Optionnel

Date de création (défaut : maintenant)

updated_atinteger · int64Optionnel

Date de dernière modification (défaut : maintenant)

trigger_idstring · uuidOptionnel

Transition de workflow à appliquer (PUT/PATCH uniquement)

substitute_user_idintegerOptionnel

Optionnel. Définit un autre utilisateur comme créateur/propriétaire. L'utilisateur authentifié est toujours tracé dans l'historique.

Réponses
200

Fiche mise à jour

application/json
idstring · uuidOptionnel

Identifiant de la fiche

structure_idintegerOptionnel

Identifiant du formulaire

structure_versionintegerOptionnel

Version du formulaire

created_atinteger · int64Optionnel

Date de création (timestamp UNIX)

updated_atinteger · int64Optionnel

Date de mise à jour (timestamp UNIX)

data_created_atinteger · int64Optionnel

Date de création des données sur le serveur

data_updated_atinteger · int64Optionnel

Date de dernière mise à jour des données sur le serveur

user_idintegerOptionnel

Propriétaire de la fiche

channelsstring[]Optionnel

Conditions remplies par la fiche

submission_numberintegerOptionnel

Numéro séquentiel global

number_in_structureintegerOptionnel

Numéro séquentiel au sein du formulaire

latitudenumber · doubleOptionnel

Latitude de la fiche

longitudenumber · doubleOptionnel

Longitude de la fiche

last_updated_user_idintegerOptionnel

Identifiant du dernier utilisateur ayant modifié la fiche

current_statestring · uuid · nullableOptionnel

UUID de l'état de workflow courant (null si pas de workflow)

put/{app_short}/submissions/{id}
200

Fiche mise à jour

Supprimer une fiche

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

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

idstring · uuidRequis

Identifiant de la fiche (UUID)

Réponses
204

Fiche supprimée

Aucun contenu

delete/{app_short}/submissions/{id}
204

Fiche supprimée

Aucun contenu

Mettre à jour une fiche partiellement

patch

Met à jour uniquement les items fournis. Tous les autres champs restent inchangés.

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

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

idstring · uuidRequis

Identifiant de la fiche (UUID)

Corps
idstring · uuidOptionnel

Généré automatiquement par le serveur si omis

structure_idintegerRequis

Identifiant du formulaire

structure_versionintegerRequis

Version du formulaire

created_atinteger · int64Optionnel

Date de création (défaut : maintenant)

updated_atinteger · int64Optionnel

Date de dernière modification (défaut : maintenant)

trigger_idstring · uuidOptionnel

Transition de workflow à appliquer (PUT/PATCH uniquement)

substitute_user_idintegerOptionnel

Optionnel. Définit un autre utilisateur comme créateur/propriétaire. L'utilisateur authentifié est toujours tracé dans l'historique.

Réponses
200

Fiche complète mise à jour retournée

application/json
idstring · uuidOptionnel

Identifiant de la fiche

structure_idintegerOptionnel

Identifiant du formulaire

structure_versionintegerOptionnel

Version du formulaire

created_atinteger · int64Optionnel

Date de création (timestamp UNIX)

updated_atinteger · int64Optionnel

Date de mise à jour (timestamp UNIX)

data_created_atinteger · int64Optionnel

Date de création des données sur le serveur

data_updated_atinteger · int64Optionnel

Date de dernière mise à jour des données sur le serveur

user_idintegerOptionnel

Propriétaire de la fiche

channelsstring[]Optionnel

Conditions remplies par la fiche

submission_numberintegerOptionnel

Numéro séquentiel global

number_in_structureintegerOptionnel

Numéro séquentiel au sein du formulaire

latitudenumber · doubleOptionnel

Latitude de la fiche

longitudenumber · doubleOptionnel

Longitude de la fiche

last_updated_user_idintegerOptionnel

Identifiant du dernier utilisateur ayant modifié la fiche

current_statestring · uuid · nullableOptionnel

UUID de l'état de workflow courant (null si pas de workflow)

patch/{app_short}/submissions/{id}
200

Fiche complète mise à jour retournée

Récupérer un fichier lié à une fiche

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

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

idstring · uuidRequis

Identifiant de la fiche (UUID)

file_idstring · uuidRequis

Identifiant du fichier (UUID)

Réponses
200

Contenu binaire du fichier

application/octet-stream
string · binaryOptionnel
get/{app_short}/submissions/{id}/file/{file_id}
200

Contenu binaire du fichier

Mis à jour

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