Importar y exportar API

  • 10 minutos

Los desarrolladores pueden importar y exportar API entre las aplicaciones de finanzas y operaciones y las implementaciones locales. Tenga en cuenta que existen algunas diferencias clave con estos procesos para implementaciones locales y en la nube:

  • Para las implementaciones locales, se ha agregado soporte técnico para la API de REST de paquete de administración de datos, aunque los nombres de la API no se hayan cambiado. De esta manera, Microsoft puede mantener un único conjunto de API, tanto para implementaciones en la nube como para implementaciones locales.
  • La API del paquete del marco de administración de datos usa OAuth 2.0 (Open Authorization Protocol) para autorizar el acceso.
  • Para implementaciones locales, la autorización se administra con los Servicios de federación de Active Directory (AD FS).
  • Las API de integración periódicas no son compatibles con las implementaciones locales.

Importación de API

Para iniciar el proceso de importación de paquete de datos, la API ImportFromPackage se usa para iniciar una importación desde un paquete de datos. El paquete de datos se carga en el Blob Storage que está asociado a la implementación de las aplicaciones de finanzas y operaciones.

Para las implementaciones locales, la importación se iniciará desde el archivo de almacenamiento local que se cargó anteriormente.

Lo que sigue es un ejemplo de código que se utiliza para iniciar el proceso de importación.

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

La siguiente lista describe los diversos elementos del código:

  • ImportFromPackage iniciará la importación.
  • packageurl es un nombre de archivo único que se utiliza para realizar un seguimiento de los Id. de Blob. Puede incluir un identificador único global (GUID) para ayudar a garantizar un nombre de archivo único.
  • definitionGroupID es una cadena que representa el nombre del proyecto de datos para la importación.
  • executionId es el Id. que debe usarse para el trabajo. Si se asigna un Id. vacío, se creará automáticamente un nuevo Id. de ejecución.
  • execute es un booleano. Si el parámetro está establecido en Verdadero, se ejecuta el paso de destino.
  • overwrite también es un booleano que debe establecerse en Falso cuando se usa una entidad compuesta en un paquete; de lo contrario, se debe establecer en Verdadero.
  • legalentityId es la entidad jurídica para la importación.

Si la importación finaliza correctamente, recibirá una respuesta de éxito JSON.

Exportación de API

La exportación de API es similar a la importación. La diferencia es que la API ExportToPackage se utiliza para iniciar la exportación. Esto es aplicable tanto a implementaciones en la nube como locales.

Lo que sigue es un ejemplo de código que se utiliza para iniciar el proceso de exportación.

POST
/data/DataManagementDefinitionGroups/Microsoft.Dynamics.DataEntities.**ExportToPackage**
BODY
{
	"definitionGroupId":"<string>",
	"packageName":"<string>",
	"executionId":"<string>",
	"reExecute":<bool>,
	"legalEntityId":"<string>"
}

La siguiente lista describe los diversos elementos del código:

  • ExportToPackage: inicia la exportación.
  • definitionGroupId: id. del proyecto de datos.
  • packageName: nombre que se utilizará para el archivo descargado.
  • executionId: id. de ejecución si se vuelve a ejecutar.
  • reExecute: un booleano. Si el parámetro está establecido en Verdadero, se ejecuta de nuevo el paso de destino.
  • legalentityId: la entidad jurídica para la exportación.

Si la exportación finaliza correctamente, recibirá una respuesta de éxito JSON.