导入和导出 API
开发人员可以在财务和运营应用和本地部署之间导入和导出 API。 请注意,本地部署和云部署的这些流程存在一些重要差异:
- 对于本地部署,已为数据管理包 REST API 添加支持,但 API 名称尚未更改。 因此,Microsoft 可以为云部署和本地部署保留一个 API 集。
- 数据管理框架 API 包使用 OAuth 2.0(Open Authorization 协议)授权访问权限。
- 对于本地部署,授权由 Active Directory 联合身份验证服务 (AD FS) 管理。
- 本地部署不支持定期集成 API。
导入 API
若要启动数据包导入流程,请使用 ImportFromPackage API 开始从数据包中导入。 数据包上传到与财务和运营应用实现关联的 Blob 存储。
对于本地部署,将从之前上传的本地存储文件启动导入。
以下代码是用于启动导入流程的示例。
POST /data/DataManagementDefinitionGroups/Microsoft.Dynamics.DataEntities.**ImportFromPackage**
BODY
{
"packageUrl":"<string>",
"definitionGroupId":"<string>",
"executionId":"<string>",
"execute":<bool>,
"overwrite":<bool>,
"legalEntityId":"<string>"
}
以下列表描述了各种代码元素:
ImportFromPackage启动导入。packageurl是用于跟踪 Blob ID 的唯一文件名。 您可以包括全局唯一标识符 (GUID),以帮助保证文件名唯一。definitionGroupID是字符串,表示要导入的数据项目的名称。executionId是要用于该作业的 ID。 如果分配了空 ID,则将自动创建新的执行 ID。execute是布尔值。 如果参数设置为 True,将运行目标步骤。overwrite也是布尔值,在包中使用复合实体时,它必须设置为 False,否则应设置为 True。legalentityId是要导入的法人。
如果成功完成了导入,您将收到 JSON 成功响应。
导出 API
API 的导出与导入相似。 不同的是,启动导出时使用的是 ExportToPackage API。 这适用于云部署和本地部署。
下面是用于启动导出流程的代码示例。
POST
/data/DataManagementDefinitionGroups/Microsoft.Dynamics.DataEntities.**ExportToPackage**
BODY
{
"definitionGroupId":"<string>",
"packageName":"<string>",
"executionId":"<string>",
"reExecute":<bool>,
"legalEntityId":"<string>"
}
以下列表描述了各种代码元素:
- ExportToPackage - 启动导出。
- definitionGroupId - 数据项目 ID。
- packageName - 用于下载文件的名称。
- executionId - 执行 ID(如果是 rerun)。
- reExecute - 布尔值。 如果参数设置为 True,将重新运行目标步骤。
- legalentityId - 要导出的法人。
如果成功完成了导出,您将收到 JSON 成功响应。