API di esportazione
Scopri come utilizzare e integrare efficacemente tramite la nostra Export API
Credenziali
L' API di esportazione è accessibile a un utente tecnico che si connette a un client di esportazione dedicato.
Per ottenere le credenziali per l'utente tecnico, contattare l'assistenza Yonder .
Ottieni l'elenco dei pacchetti di esportazione
OTTENERE
/api/v1/export-packages?exportProfileId={exportProfileId}&dateFrom={dateFrom}&dateTo={dateTo} |
Parametri di query
Parametro | Tipo | Descrizione | Obbligatorio |
---|---|---|---|
esportaProfileId | Lungo | ID del profilo di esportazione per il quale vengono recuperati i pacchetti di esportazione | SÌ |
dataDa | Data nel formato AAAA-MM-GG | Parametro di filtraggio per recuperare solo i pacchetti di esportazione creati dopo questa data (inclusi) | NO |
dataA | Data nel formato AAAA-MM-GG | Parametro di filtraggio per recuperare solo i pacchetti di esportazione creati prima di questa data (inclusi) | NO |
Risposta - Elenco delle entità ExportPackage
EsportazionePacchetto
Campo | Tipo | Descrizione |
id | Lungo | Identificatore univoco del pacchetto di esportazione |
Data di creazione | Data nel formato AAAA-MM-GGTHH:mm:ss.mmmZ | Data di creazione del pacchetto di esportazione |
NomeDocumento | corda | Nome del documento esportato |
revisioneEtichetta | corda | Etichetta di revisione del documento esportato |
ID documento | corda | identificatore univoco del documento |
IDVersioneDocumento | corda | identificatore univoco della revisione |
efficaceDa | Data nel formato AAAA-MM-GGTHH:mm:ss.mmmZ | Data in cui la revisione entra in vigore |
Errori
Codice | Errore |
---|---|
200 | Successo |
401 | Non autorizzato |
403 | Vietato |
404 | Non trovato |
500 | Errore interno del server |
Recupera il contenuto del pacchetto di esportazione
OTTENERE
/api/v1/export-packages/{exportPackageId} |
Parametri del percorso
Parametro | Tipo | Descrizione | Obbligatorio |
---|---|---|---|
IDPacchettoEsportazione | Lungo | ID del pacchetto di esportazione per il quale viene recuperato il contenuto | SÌ |
Risposta - Contenuto del pacchetto ExportPackage
content-disposition: allegato; filename="{exportPackage-fileName}"
tipo di contenuto: applicazione/octet-stream
Errori
Codice | Errore |
---|---|
200 | Successo |
401 | Non autorizzato |
403 | Vietato |
404 | Non trovato |
500 | Errore interno del server |