استيراد واجهات برمجة التطبيقات (API) وتصديرها

10 دقائق

يمكن للمطورين استيراد وتصدير واجهات برمجة التطبيقات بين تطبيقات التَمويل والعَمَليات وعمليات التوزيع المحلية. ضع فِي اعتبارك أن ثمَّة بعض الاختلافات الأساسية مع هذه العمليات لعمليات التوزيع المحلية وعمليات التوزيع عَلى السحابة:

بالنسبة لعمليات التوزيع المحلية، يُضاف الدعم إلى واجهة برمجة تطبيقات ‏REST الخَاصة بحزمة إدارة البيانات عَلى الرغم مِن عدم تغيير أسماء واجهة برمجة التطبيقات (API). بهذه الطريقة، يمكن لـ Microsoft الاحتفاظ بمجموعة برمجة تطبيقات (API) واحدة لكل مِن عمليات التوزيع السحابية وعمليات التوزيع المحلية.
تستخدم حزمة واجهة برمجة التطبيقات (API) لإطار عمل إدارة البيانات OAuth 2.0 (بروتوكول التفويض المفتوح) لتخويل الوصول.
لعمليات التوزيع المحلية، تتم إدارة التفويض مِن خلال خدمات الأمَان المشترك لـ Active Directory ‏(AD FS).
لا تُدعم واجهات برمجة التطبيقات (API) للتكامل المتكرر لعمليات التوزيع المحلية.

استيراد واجهات برمجة التطبيقات (API)

لبدء عملية استيراد حزمة البيانات، يتم استخدَام واجهة برمجة تطبيقات (API) ImportFromPackage لبدء الاستيراد مِن حزمة بيانات. تُحمَّل حزمة البيانات إلى وحدة تخزين Blob المرتبطة بتطبيق تطبيقات التَمويل والعَمَليات.

بالنسبة لعمليات التوزيع المحلية، يبدأ الاستيراد مِن ملف التخزين المحلي الذي تم تحميله مسبقًا.

الكود التالي هو مثال للكود المستخدم لبدء عملية الاستيراد.

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

تصف القائمة التالية عناصر الكود المختلفة:

يبدأ ImportFromPackage الاستيراد.
packageurl هو اسم ملف فريد يُستخدم لتعقب معرفات الكائنات الثنائية كبيرة الحجم. يمكنك تضمين معرف فريد عمومي (GUID) للمساعدة فِي ضمان اسم ملف فريد.
definitionGroupID عبارة عن سلسلة تمثل اسم مشروع البيانات للاستيراد.
executionId هو المعرف الذي يجب استخدَامه للوظيفة. إذا تم تعيين معرف فارغ، فِيتم إنشَاء معرف تطبيق جَديد تلقائيًا.
execute قيمة مِنطقية. إذا عُيِّنت المعلمة إلى صواب، فِيتم تشغيل الخطوة الهدف.
overwrite هي أيضًا قيمة مِنطقية يجب تعيينها إلى خطأ عند استخدَام كيان مركب فِي حزمة، إذا لم يكن الأمر كذلك، فِيجب تعيين هذا إلى صواب.
legalentityId هو الكيان القانوني للاستيراد.

إذا اكتمل الاستيراد بنجاح، فتتلقى استجابة نجاح JSON.

تصدير واجهات برمجة التطبيقات (API)

تصدير واجهات برمجة التطبيقات (API) مشابه للاستيراد. الفرق هو أن واجهة برمجة تطبيقات (API) ExportToPackage تُستخدم لبدء التصدير. ينطبق هذا عَلى عمليات التوزيع السحابية والمحلية.

فِيما يلي مثال عَلى الكود المستخدم لبدء عملية التصدير.

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

تصف القائمة التالية عناصر الكود المختلفة:

ExportToPackage - يبدأ التصدير.
definitionGroupId - معرف مشروع البيانات.
packageName - الاسم المراد استخدَامه للملف الذي تم تنزيله.
executionId - معرف التطبيق فِي حالة إعادة التشغيل.
reExecute - قيمة مِنطقية. إذا عُيِّنت المعلمة إلى صواب، فِيُعاد تشغيل الخطوة الهدف.
legalentityId - هو الكيان القانوني للتصدير.

إذا انتهى التصدير بنجاح، تتلقى استجابة نجاح JSON.

الملاحظات

هل كانت هذه الصفحة مفيدة؟