Exporter API
Découvrez comment utiliser et intégrer efficacement via notre API d'exportation
Informations d'identification
L' API d'exportation est accessible par un utilisateur technique qui se connecte à un client d'exportation dédié.
Pour obtenir les informations d'identification de l'utilisateur technique, veuillez contacter le support Yonder .
Récupérer la liste des packages d'exportation
OBTENIR
/api/v1/export-packages?exportProfileId={exportProfileId}&dateFrom={dateFrom}&dateTo={dateTo} |
Paramètres de requête
Paramètre | Taper | Description | Obligatoire |
---|---|---|---|
exportProfileId | Long | Identifiant du profil d'exportation pour lequel les packages d'exportation sont récupérés | Oui |
dateDe | Date au format AAAA-MM-JJ | Paramètre de filtrage permettant de récupérer uniquement les packages d'exportation créés après cette date (y compris) | Non |
dateÀ | Date au format AAAA-MM-JJ | Paramètre de filtrage permettant de récupérer uniquement les packages d'exportation créés avant cette date (y compris) | Non |
Réponse - Liste des entités ExportPackage
Paquet d'exportation
Champ | Taper | Description |
identifiant | Long | Identifiant unique du package d'exportation |
Date de création | Date au format AAAA-MM-JJTHH:mm:ss.mmmZ | Date de création du package d'exportation |
nom du document | chaîne | Nom du document exporté |
Étiquette de révision | chaîne | Étiquette de révision du document exporté |
ID du document | chaîne | identifiant unique du document |
ID de version du document | chaîne | identifiant unique de la révision |
efficaceÀ partir de | Date au format AAAA-MM-JJTHH:mm:ss.mmmZ | Date à laquelle la révision entre en vigueur |
Erreurs
Code | Erreur |
---|---|
200 | Succès |
401 | Non autorisé |
403 | Interdit |
404 | Non trouvé |
500 | Erreur interne du serveur |
Récupérer le contenu du package d'exportation
OBTENIR
/api/v1/export-packages/{exportPackageId} |
PathParams
Paramètre | Taper | Description | Obligatoire |
---|---|---|---|
exportPackageId | Long | Identifiant du package d'exportation pour lequel le contenu est récupéré | Oui |
Réponse - Contenu du package d'exportation
contenu-disposition : pièce jointe ; nom de fichier ="{exportPackage-fileName}"
type de contenu : application/octet-stream
Erreurs
Code | Erreur |
---|---|
200 | Succès |
401 | Non autorisé |
403 | Interdit |
404 | Non trouvé |
500 | Erreur interne du serveur |