API exportieren
Entdecken Sie, wie Sie unsere Export API effektiv nutzen und integrieren können
Zweck
Auf die Export- API kann ein technischer Benutzer zugreifen, der eine Verbindung zu einem dedizierten Exportclient herstellt.
Um die Anmeldeinformationen für den technischen Benutzer zu erhalten, wenden Sie sich bitte an den Yonder -Support.
Liste der Exportpakete abrufen
ERHALTEN
/api/v1/export-packages?exportProfileId={exportProfileId}&dateFrom={dateFrom}&dateTo={dateTo} |
Abfrageparameter
Parameter | Typ | Beschreibung | Obligatorisch |
---|---|---|---|
exportProfileId | Lang | ID des Exportprofils, für das die Exportpakete abgerufen werden | Ja |
DatumVon | Datum im Format JJJJ-MM-TT | Filterparameter zum Abrufen nur der Exportpakete, die nach diesem Datum erstellt wurden (einschließlich) | NEIN |
DatumBis | Datum im Format JJJJ-MM-TT | Filterparameter zum Abrufen nur der Exportpakete, die vor diesem Datum erstellt wurden (einschließlich) | NEIN |
Antwort - Liste der ExportPackage-Entitäten
Exportpaket
Feld | Typ | Beschreibung |
Ausweis | Lang | Eindeutige Kennung des Exportpakets |
Erstellungsdatum | Datum im Format JJJJ-MM-TTTHH:mm:ss.mmmZ | Erstellungsdatum des Exportpaketes |
Dokumentname | Schnur | Name des exportierten Dokuments |
Revisionsbezeichnung | Schnur | Revisionsbezeichnung des exportierten Dokuments |
Dokument-ID | Schnur | eindeutige Kennung des Dokuments |
Dokumentversions-ID | Schnur | eindeutige Kennung der Revision |
effektivVon | Datum im Format JJJJ-MM-TTTHH:mm:ss.mmmZ | Datum, an dem die Änderung in Kraft tritt |
Fehler
Code | Fehler |
---|---|
200 | Erfolg |
401 | Nicht autorisiert |
403 | Verboten |
404 | Nicht gefunden |
500 | interner Serverfehler |
Inhalt des Exportpakets abrufen
ERHALTEN
/api/v1/export-packages/{exportPackageId} |
Pfadparameter
Parameter | Typ | Beschreibung | Obligatorisch |
---|---|---|---|
exportPackageId | Lang | ID des Exportpakets, für das der Inhalt abgerufen wird | Ja |
Antwort - ExportPackage-Inhalt
Inhaltsdisposition: Anhang; Dateiname="{exportPackage-fileName}"
Inhaltstyp: Anwendung/Oktett-Stream
Fehler
Code | Fehler |
---|---|
200 | Erfolg |
401 | Nicht autorisiert |
403 | Verboten |
404 | Nicht gefunden |
500 | interner Serverfehler |