Importazione ed esportazione di API

  • 10 minuti

Gli sviluppatori possono importare ed esportare API tra le app per la finanza e le operazioni e le distribuzioni locali. Tenere presente che esistono alcune differenze chiave in questi processi per le distribuzioni locali e cloud:

  • Per le distribuzioni locali, è stato aggiunto il supporto per l'API REST del pacchetto di gestione dei dati anche se i nomi delle API non sono stati modificati. In questo modo, Microsoft può mantenere un singolo set di API sia per le distribuzioni cloud che per le distribuzioni locali.
  • Il pacchetto API del framework di gestione dati usa OAuth 2.0 per autorizzare l'accesso.
  • Per le distribuzioni locali, l'autorizzazione viene gestita con Active Directory Federation Services (AD FS).
  • Le API di integrazione ricorrenti non sono supportate per le distribuzioni locali.

Importazione di API

Per avviare il processo di importazione del pacchetto di dati, si usa l'API ImportFromPackage per iniziare un'importazione da un pacchetto di dati. Il pacchetto di dati viene caricato nell'archiviazione BLOB associata all'implementazione delle app per la finanza e le operazioni.

Per le distribuzioni locali, l'importazione verrà avviata dal file di archiviazione locale caricato in precedenza.

Di seguito è riportato un esempio di codice usato per avviare il processo di importazione.

POST /data/DataManagementDefinitionGroups/Microsoft.Dynamics.DataEntities.**ImportFromPackage**
BODY
{
	"packageUrl":"<string>",
	"definitionGroupId":"<string>",
	"executionId":"<string>",
	"execute":<bool>,
	"overwrite":<bool>,
	"legalEntityId":"<string>"
}

Il seguente elenco descrive i vari elementi del codice:

  • ImportFromPackage sta avviando l'importazione.
  • packageurl è un nome file univoco usato per tenere traccia degli ID BLOB. È possibile includere un identificatore univoco globale (GUID) per garantire un nome file univoco.
  • definitionGroupID è una stringa che rappresenta il nome del progetto dati per l'importazione.
  • executionId è l'ID da usare per il processo. Se viene assegnato un ID vuoto, verrà creato automaticamente un nuovo ID di esecuzione.
  • execute è un valore booleano. Se il parametro è impostato su True, verrà eseguito il passaggio di destinazione.
  • overwrite è anch'esso un valore booleano che deve essere impostato su False quando un'entità composita viene usata in un pacchetto. In caso contrario, il relativo valore dovrà essere impostato su True.
  • legalentityId è la persona giuridica per l'importazione.

Se l'importazione è stata completata correttamente, si riceverà una risposta di operazione riuscita JSON.

Esportazione di API

L'esportazione per le API è simile all'importazione. La differenza è che viene usata l'API ExportToPackage per avviare l'esportazione. Ciò è applicabile sia per le distribuzioni cloud che per le distribuzioni locali.

Di seguito è riportato un esempio di codice usato per avviare il processo di esportazione.

POST
/data/DataManagementDefinitionGroups/Microsoft.Dynamics.DataEntities.**ExportToPackage**
BODY
{
	"definitionGroupId":"<Data project Id>",
	"packageName":"<Name to use for downloaded file.>",
	"executionId":"<Execution Id if it is a rerun>",
	"reExecute":<bool>,
	"legalEntityId":"<Legal entity Id>"
}

Se l'esportazione è stata completata correttamente, si riceverà una risposta di operazione riuscita JSON.